Classes
Members
-
<static> MediaContentType :string
-
Indicates which content management system contains the video assets available for playback: Ooyala Backlot or an external content management system.
Type:
- string
Properties:
Name Type Default Description OOYALA_CONTENT
string ooyala Indicates that the media id is an Ooyala embed code EXTERNAL_CONTENT
string external Indicates that the media id is customer-specific and not an Ooyala embed code -
<static> OfflineContentDownloadType :string
-
Indicates which type of offline content has been downloaded: rental with a definite expiry or ownedcontent that never expires.
Type:
- string
Properties:
Name Type Default Description TO_OWN
string own Indicates that the content never expires FOR_RENT
string rental Indicates that the content has an expiration period
Type Definitions
-
DeviceInfo
-
Type:
- Object
Properties:
Name Type Description browser
string The web browser where the player is being viewed, for example 'chrome'. browserVersion
string Browser version, for example '33.0.1750.146'. os
string Name of the operating system, like 'windows', 'mac', 'ios'. osVersion
string Version of the operating system, for example '6.1'. deviceType
string 'desktop' | 'tablet' | 'mobile' | 'settop' | 'bot' | 'console' | 'smarttv' | 'tablet/mobile' deviceBrand
string Brand name of the device, for example 'apple' for iPhone. model
string Model name of the device, for example 'iPhone 6s'. -
geo
-
Type:
- Object
Properties:
Name Type Description countryCode
string ISO 2-alpha code of the country of the viewer, this is an optional field. E.g: IN, US. region
string Region of the viewer, this is an optional field. E.g: CA, TX. state
string State of the viewer, this is an optional field. E.g: Texas, Tamilnadu. city
string City of the viewer, this is an optional field. E.g: Santaclara. latitude
number Latitude of the viewer, this is an optional field. E.g: 37.399092. longitude
number Longitude of the viewer, this is an optional field. E.g: -121.985771 . geoVendor
string Name of the vendor which provided the above viewer details, this is an optional field. E.g: akamai. -
Plugin
-
Type:
- Object
Properties:
Name Type Description name
string The plugin name, for example 'bitmovin'. This property is required. version
string Plugin version, for example '33.0.1750.146'. This property is optional. active
boolean Boolean flag indicating if the plugin is being used at the moment. Thisproerty is required.