Retrieve Player

This endpoint retrieves a single Player.

This is an authenticated request. It is not typically used by clients. You will need to request authentication credentials from Ooyala if you wish to use it.

HTTP Parameters:

Table 1.
   
HTTP Method GET
URI /players/{playerId}
Content-Type application/vnd.nativ.playout.v1+json
Normal Response 200 OK
Mode Synchronous
Authenticated Yes

Request Query Parameters:

Table 2.
Parameter Required Description
callback No Specifies the call back function for JSONP response.
token Yes Shared token used for authentication purposes.

Response:

  {
    "player": {
        "id": 1,
        "lastModified": "19 Aug 2013 12:57:02 +0100",
        "asset": {
            "referenceName": "FileAsset reference name",
            "transcodes": [
                {
                    "href": "http://testurl.com/playout/api/assets/235"
                },
                {
                    "href": "http://testurl.com/playout/api/assets/236"
                }
            ],
            "proxies": [
                {
                    "href": "http://testurl.com/playout/api/assets/1235"
                },
                {
                    "href": "http://testurl.com/playout/api/assets/1236"
                }
            ],
            "copies": [
                {
                    "href": "http://testurl.com/playout/api/assets/35"
                },
                {
                    "href": "http://testurl.com/playout/api/assets/36"
                }
            ],
            "parent": "http://testurl.com/playout/api/assets/1",
            "id": 2,
            "lastModified": "19 Aug 2013 12:57:03 +0100",
            "description": "FileAsset description",
            "href": "http://testurl.com/playout/api/assets/2",
            "creationContext": "INGEST",
            "assetMetadata": {
                "attachments": [
                    {
                        "size": 101012,
                        "fileName": "FileName - 1",
                        "description": "Description - 1",
                        "modified": "19 Aug 2013 12:57:03 +0100",
                        "url": "http://abc.com/",
                        "mimeType": "MimeType - 1"
                    },
                    {
                        "size": 101012,
                        "fileName": "FileName - 2",
                        "description": "Description - 2",
                        "modified": "19 Aug 2013 12:57:03 +0100",
                        "url": "http://abc.com/",
                        "mimeType": "MimeType - 2"
                    }
                ],
                "contentMetadata": {
                    "notes": "note value",
                    "boolean": true,
                    "keywords": "no key words",
                    "new-variable-1": "val -1",
                    "new-variable-3": "true",
                    "single-option": "yes",
                    "colour": "#9A1D1D",
                    "new-variable-2": 12
                },
                "images": [
                    {
                        "description": "Description",
                        "width": 200,
                        "height": 100,
                        "timecode": "00.00.00.00@25",
                        "mimeType": "image/jpg",
                        "master": false,
                        "href": "http://testurl.com/playout/api/images/10/raw",
                        "title": "Image Title"
                    },
                    {
                        "description": "Description",
                        "width": 200,
                        "height": 100,
                        "timecode": "00.00.00.00@25",
                        "mimeType": "image/jpg",
                        "master": true,
                        "href": "http://testurl.com/playout/api/images/10/raw",
                        "title": "Image Title"
                    }
                ],
                "assetContext": {
                    "formatContext": {
                        "format": "AVI",
                        "streamCount": 2,
                        "audioStreamCount": 1,
                        "videoStreamCount": 1,
                        "bitRate": 1313,
                        "duration": 12312312,
                        "fileSize": 21312
                    },
                    "videoStreamContexts": [
                        {
                            "pixelAspectRatio": 15.6,
                            "frameRate": 1,
                            "width": 796,
                            "height": 560,
                            "language": "English",
                            "bitRate": 1313,
                            "codec": "AAC"
                        }
                    ],
                    "audioStreamContexts": [
                        {
                            "sampleRate": 12,
                            "bitsPerSample": 6,
                            "channels": 1,
                            "language": "English",
                            "bitRate": 1313,
                            "codec": "AAC"
                        }
                    ]
                }
            },
            "title": "FileAsset title one",
            "assetType": "media",
            "players": [
                {
                    "id": 2,
                    "type": "Type 2",
                    "embedCode": "<iframe>2</iframe>",
                    "href": "http://testurl.com/playout/api/players/2"
                },
                {
                    "id": 1,
                    "type": "Type 1",
                    "embedCode": "<iframe>1</iframe>",
                    "href": "http://testurl.com/playout/api/players/1"
                }
            ]
        },
        "config": {
            "definition": [
                {
                    "name": "functionality",
                    "displayName": "Functionality",
                    "type": "complex",
                    "multiplicity": "1",
                    "children": [
                        {
                            "name": "autoplay",
                            "displayName": "Auto Play",
                            "type": "boolean",
                            "multiplicity": "1",
                            "options": [
                                {
                                    "name": "Yes",
                                    "displayName": "Yes",
                                    "default": true,
                                    "value": "true"
                                },
                                {
                                    "name": "No",
                                    "displayName": "No",
                                    "default": false,
                                    "value": "false"
                                }
                            ]
                        },
                        {
                            "name": "controls",
                            "displayName": "Controls",
                            "type": "boolean",
                            "multiplicity": "1",
                            "options": [
                                {
                                    "name": "Yes",
                                    "displayName": "Yes",
                                    "default": true,
                                    "value": "true"
                                },
                                {
                                    "name": "No",
                                    "displayName": "No",
                                    "default": false,
                                    "value": "false"
                                }
                            ]
                        },
                        {
                            "name": "preload",
                            "displayName": "Preload",
                            "type": "single-option",
                            "multiplicity": "1",
                            "options": [
                                {
                                    "name": "On",
                                    "displayName": "On",
                                    "default": true,
                                    "value": "auto"
                                },
                                {
                                    "name": "Metadata Only",
                                    "displayName": "Metadata Only",
                                    "default": false,
                                    "value": "metadata"
                                },
                                {
                                    "name": "Off",
                                    "displayName": "Off",
                                    "default": false,
                                    "value": "none"
                                },
                                {
                                    "name": "Auto",
                                    "displayName": "Auto",
                                    "default": false,
                                    "value": "preload"
                                }
                            ]
                        },
                        {
                            "name": "loop",
                            "displayName": "Loop",
                            "type": "boolean",
                            "multiplicity": "1",
                            "options": [
                                {
                                    "name": "Yes",
                                    "displayName": "Yes",
                                    "default": false,
                                    "value": "true"
                                },
                                {
                                    "name": "No",
                                    "displayName": "No",
                                    "default": true,
                                    "value": "false"
                                }
                            ]
                        }
                    ]
                },
                {
                    "name": "theme",
                    "displayName": "Theme",
                    "type": "complex",
                    "multiplicity": "1",
                    "children": [
                        {
                            "name": "progress-colour",
                            "displayName": "Progress Colour",
                            "description": "HTML5 player progress colour",
                            "type": "colour",
                            "defaultValue": "#c0c0c0"
                        },
                        {
                            "name": "icon-colour",
                            "displayName": "Icon Colour",
                            "description": "HTML5 player icon colour",
                            "type": "colour",
                            "defaultValue": "#66A8CC"
                        },
                        {
                            "name": "background-colour",
                            "displayName": "Background Colour",
                            "description": "HTML5 player background colour",
                            "type": "colour",
                            "defaultValue": "#000000"
                        },
                        {
                            "name": "default-width",
                            "displayName": "Preferred Width",
                            "description": "Preferred width of the iFrame",
                            "type": "string",
                            "defaultValue": "100%"
                        },
                        {
                            "name": "default-height",
                            "displayName": "Preferred Height",
                            "description": "Preferred width of the Height",
                            "type": "string",
                            "defaultValue": "100%"
                        }
                    ]
                }
            ],
            "instance": {
                "functionality": {
                    "id": 0,
                    "name": "functionality",
                    "autoplay": "true",
                    "controls": "true",
                    "preload": "auto",
                    "loop": "false"
                },
                "theme": {
                    "id": 0,
                    "name": "theme",
                    "progress-colour": "#34E95E",
                    "icon-colour": "#66A8CC",
                    "background-colour": "#C464CE",
                    "default-width": "100%",
                    "default-height": "100%"
                }
            }
        },
        "sources": [
            {
                "id": 1,
                "mimeType": "video/mp4",
                "assetId": 10104,
                "href": "http://testurl.com/playout/api/assets/10104"
            },
            {
                "id": 2,
                "mimeType": "video/webm",
                "assetId": 10506,
                "href": "http://testurl.com/playout/api/assets/10506"
            }
        ],
        "embedCode": "<iframe src='http://playouturl.com/players/1/embed'>",
        "href": "http://testurl.com/playout/api/players/1",
        "template": {
            "id": 1
        }
    }
}
      
    

Was this article helpful?