Query Parameters for Player v3

The following table describes the query string parameters for the GET call in the Player v3 Authorization API. The request can have several optional query string parameters following in suit. The only required parameter is domain.


Query Parameters

Name Description Required?  
domain   Domain of the player embed.   Yes  
timestamp   Timestamp in which the request was made (epoch time). Default: Time request received by server.   No  
supported_formats   List of comma-separated values indicating supported formats. The value of this parameter is normally tightly coupled with the device type, since support for formats is limited by device. Valid Values: Shown in the table below.   No  
device   List of comma-separated devices for playback. Valid Values: Shown in the table below.   No  
jsonp   Value of this parameter will be used as the wrapper in returning JSONP. Default: JSON.   No  
embed_token   Discussed in section "Ooyala Player Token" in the Player Developer Guide.   No  
auth_token   Authorization token, discussed in Limiting Concurrent Streams per Viewer.   No  
        

The supported_formats parameter can be a list of any of the following values, with elements of the list separated by commas. Note that to use the smooth (Microsoft Smooth Streaming) format, the device must be GENERIC. (See the table of devices.)

Supported Formats

Format Name Value  
DASH (Dynamic Adaptive Streaming over HTTP)   dash  
HDS (Adobe HTTP Dynamic Streaming)   hds  
RTMP (Real-Time Messaging Protocol)   RTMP  
HLS (HTTP Live Streaming)   m3u8  
MP4 (MPEG-4 Part 14 Moving Picture Experts Group)   mp4  
Akamai HD   akamai_hd  
Fairplay HLS   fps  
WideVine HLS   wv_hls  
WideVine MP4   wv_mp4  
WideVine WVM (WideVine Media)   wv_wvm  
Adobe Access HLS   faxs_hls  
Microsoft Smooth Streaming (GENERIC device only)   smooth  
     

The device parameter can be a list of any of the following values, with elements of the list separated by commas:

Device

IPHONE  
IPAD  
APPLE_TV  
ANDROID_SDK  
ANDROID_3PLUS_SDK  
ANDROID_HLS_SDK  
HTML5  
GENERIC_FLASH  
GENERIC  
  
Send Feedback