THEOplayer
Class |
Description |
---|---|
The player API. |
|
The player API extended with UI functionality. |
Enumeration |
Description |
---|---|
The category of an error. |
|
A code that indicates the type of error that has occurred. |
|
The response type of the Verizon Media Preplay request, represented by a value from the following list: |
Function |
Description |
---|---|
Register a content protection integration |
Interface |
Description |
---|---|
Describes the adaptive bitrate configuration. |
|
Describes the metadata of the adaptive bitrate strategy. |
|
Describes the configuration of the adaptive bitrate strategy. |
|
Represents a VAST creative. It is either a linear or non-linear ad. |
|
Represents an ad break in the VMAP specification or an ad pod in the VAST specification. |
|
Fired when the ad has stalled playback to buffer. |
|
Fired when a caching task is added. |
|
Describes an ad break request. |
|
Fired when an ads list is loaded. |
|
The API for advertisements. |
|
Describes the configuration of advertisement. |
|
The events fired by the ads API. |
|
Describes the source of the ad. |
|
Describes the AES128 key system configuration. |
|
Describes the configuration of Agama. |
|
Describes the configuration of Agama. |
|
Describes the configuration of Agama for this source. |
|
The AirPlay API. |
|
The analytics API. |
|
Describes the configuration of an analytics integration. |
|
Represents a quality of an audio track. |
|
Describes the configuration of the Axinom DRM integration. |
|
Describes the configuration of the Azure Media Services DRM integration. |
|
Util for encoding binary data as base64 string and vice versa. |
|
Represents the common properties of a media resource. |
|
Represents the boundary of an ad that is relevant for up to three days after the original airing. |
|
Represents the boundary of an ad that is relevant for up to seven days after the original airing. |
|
Represents the boundary that identifies special content. |
|
Represents the information of an ad boundary. |
|
The number of audio and video segments in the buffer. |
|
The media caching API. |
|
The events fired by the cache API. |
|
Represents a caching task. |
|
The events fired by the CachingTask. |
|
The CachingTask's license API. |
|
List of caching tasks. |
|
The events fired by the CachingTaskList. |
|
Describes the configuration of a caching task. |
|
The canvas API which allows drawing the player's current frame to a 2D or WebGL context. |
|
The cast API. |
|
Describes the configuration of the Cast integrations. |
|
The events fired by the cast API. |
|
Fires when the cast state changes. |
|
The response of a certificate request. |
|
The Chromecast API. |
|
Describes the configuration of the Chromecast integration. |
|
An error that occurred while casting or attempting to cast to Chromecast. |
|
Fired when an error occurs while casting or trying to cast. |
|
The events fired by the Chromecast API. |
|
Describes the metatadata used by Chromecast. |
|
Describes the metadata of a Chromecast image. |
|
Describes the ClearKey decryption key. |
|
Describes the ClearKey key system configuration. |
|
The clip API which can be used to clip the playback window of a source. |
|
The events fired by the clip API. |
|
Describes the configuration of the Comcast DRM integration. |
|
Utils that serve common use cases. For example encoding and decoding a base64 string to Uint8Array and vice versa. |
|
Represents a companion ad which is displayed near the video player. |
|
Describes the configuration of the Conax DRM integration. |
|
An error related to content protection. |
|
Fired when an error related to content protection occurs. |
|
This ContentProtectionIntegration defines some methods to alter license and certificate requests and responses. |
|
Factory pattern to create ContentProtectionIntegrations. |
|
A request, either for a certificate or a license. |
|
The response, either of a license or for a certificate request. |
|
The Conviva API. |
|
Describes the configuration of the Conviva integration. |
|
Describes the content's metadata. |
|
Represents a configuration for controlling playback of an MPEG-DASH stream. |
|
Represents a cue of a HLS date range metadata text track. |
|
Describes the configuration of the Titanium DRM integration with device-based authentication. |
|
Describes the configuration of the DRM. |
|
Describes the configuration of the DRM Today DRM integration. |
|
Represents a cue of an emsg metadata text track. |
|
Fired when an error occurs. |
|
Fired when an event occurs. |
|
Dispatches events that are fired. |
|
List of generic items which can dispatch events. |
|
Represents a cue of an Event Stream metadata text track. |
|
Describes the configuration of the ExpressPlay DRM integration. |
|
Describes the configuration of the Ezdrm DRM integration. |
|
Describes the FairPlay key system configuration. |
|
Describes a FreeWheel ad break request. |
|
Represents a FreeWheel cue. |
|
Represents a geographical location. |
|
The global cast API. |
|
The global Chromecast API. |
|
Represents a configuration for server-side ad insertion with the Google DAI pre-integration. |
|
Represents a configuration for server-side ad insertion with the Google DAI pre-integration for a Live media stream. |
|
Represents a media resource with a Google DAI server-side ad insertion request. |
|
Represents a configuration for server-side ad insertion with the Google DAI pre-integration for a VOD media stream. |
|
Represents a Google IMA creative compliant to the VAST specification. |
|
Record of HTTP headers. Each entry contains the header name and its associated value. |
|
Represents an attached picture ID3 frame. |
|
Represents a generic ID3 frame. |
|
Represents a comments ID3 frame. |
|
Represents a commercial ID3 frame. |
|
Represents a cue of an ID3 metadata text track. |
|
Represents a general encapsulated object ID3 frame. |
|
Represents an involved people list ID3 frame. |
|
Represents an position synchronisation ID3 frame. |
|
Represents a private ID3 frame. |
|
Represents a synchronised lyrics/text ID3 frame. |
|
Represents a terms of use ID3 frame. |
|
Represents a text information ID3 frame. |
|
Represents a unique file identifier ID3 frame. |
|
Represents an unknown ID3 frame. |
|
Represents a unsynchronised lyrics/text transcription ID3 frame. |
|
Represents a URL link ID3 frame. |
|
Represents a used defined text ID3 frame. |
|
Represents a user defined URL link ID3 frame. |
|
Represents a Yospace ID3 frame. |
|
Describes a Google IMA ad break request. |
|
The Imagine API. |
|
The events fired by the Imagine API. |
|
Describes the SSAI configuration of the Imagine integration. |
|
Fired when an event related to the Imagine integration occurs. |
|
Describes a source of the Imagine integration. |
|
Represents an intercepted HTTP request which can be modified. |
|
Represents an intercepted HTTP response which can be modified. |
|
Describes the configuration of the Irdeto DRM integration. |
|
Describes the configuration of the KeyOS DRM integration |
|
Describes the KeyOS FairPlay key system configuration. |
|
Describes the KeyOS key system configuration. |
|
Describes the key system configuration. |
|
A request for a license. |
|
The response of a license request. |
|
Represents a linear ad in the VAST specification. |
|
List of generic items. |
|
A NetworkEstimator that allows measuring the current network state. |
|
Thrown when a media error occurs. |
|
Represents metadata of an media file with ad content. |
|
Describes the configuration of the Media Melon integration. |
|
Represents a media track (audio or video) of a media resource. |
|
The events fired by a MediaTrack. |
|
List of media tracks. |
|
Describes the metadata of a Chromecast source. |
|
The metrics API which can be used to gather information related to the quality-of-service and video playback experience. |
|
Describes configuration of the Moat integration. |
|
The network API. |
|
Provides estimates on the current network state. |
|
Network estimator API which can be used to get or set the active |
|
The events fired by the network API. |
|
Network interceptor API which can be used to intercept network requests and responses. |
|
Represents a non-linear ad in the VAST specification. |
|
Describes the configuration of the picture-in-picture feature. |
|
Describes a player's configuration. |
|
The events fired by the ChromelessPlayer. |
|
List of players. |
|
Describes the PlayReady key system configuration. |
|
The presentation API. |
|
The events fired by the presentation API. |
|
Fired when the presentation mode changes. |
|
Represents a quality of a media track. |
|
An quality-related event fired by a MediaTrack. |
|
The events fired by a Quality. |
|
List of qualities. |
|
The related content API. |
|
The events fired by the related content API. |
|
Represents a related content source. |
|
Fired when a caching task is removed. |
|
Represents a DASH representation. |
|
Represents an HTTP request. |
|
Contains network request properties used to modify an HTTP request. |
|
Measures network metrics of an HTTP request and the associated HTTP response. |
|
Contains network response properties used to modify an HTTP response. |
|
Represents a configuration for server-side ad insertion (SSAI). |
|
Describes the configuration of the Media Melon SmartSight integration. |
|
The social sharing API which can supplement the UI with a social sharing panel. |
|
Represents a social media to which the player can share content. |
|
Describes the configuration of a player's source. |
|
Describes the configuration of a player's source. |
|
Describes a SpotX ad break request. |
|
A record of SpotX query string parameters. Each entry contains the parameter name with associated value. |
|
A record of SpotX query string parameters which can be a nested structure. Each entry contains the parameter name with associated value. |
|
Describes the configuration of the Stream One integration. |
|
Fired when the media track's target quality changes. |
|
Represents a text track of a media resource. |
|
Represents a cue of a text track. |
|
The events fired by the TextTrackCue. |
|
List of text track cues. |
|
Describes the configuration of a side-loaded text track. |
|
An error thrown by a text track. |
|
An error event fired by a TextTrack. |
|
The events fired by a TextTrack. |
|
List of text tracks. |
|
The text track style API. |
|
Events fired by the TextTrackStyle API. |
|
Describes an ad break request. |
|
An error that is thrown by THEOplayer. |
|
Represents the resolution of a Verizon Media thumbnail. |
|
Describes the configuration of the Titanium DRM integration. |
|
Describes the configuration of the Titanium DRM integration with token-based authentication. |
|
Represents a track of a media resource. |
|
The events fired by a Track. |
|
List of tracks. |
|
The events fired by a TrackList. |
|
Represents a cue of a TTML text track. |
|
Represents a media resource characterized by a URL to the resource and optionally information about the resource. |
|
Describes the UI configuration of the player. |
|
Describes the UI related configuration of the player. |
|
The related content UI API which can be used to toggle UI components. |
|
The events fired by the related content API (with ui). |
|
Fired when the quality updates. |
|
Describes the configuration of the Uplynk DRM integration. |
|
A bar which displays the up next source. |
|
The up next API. |
|
A panel which displays the up next source. |
|
Describes an up next source. |
|
Common API for all cast integrations. |
|
The events fired by the common vendor APIs. |
|
Describes the configuration of the Veramatrix DRM integration. |
|
The Verizon Media API. |
|
Represents a Verizon Media ad. |
|
Fired when an ad begins. |
|
Represents a Verizon Media ad. |
|
Fired when the ad break begins. |
|
Fired when the ad break ends. |
|
The events fired by the VerizonMediaAdBreak. |
|
List with Verizon Media ad breaks. |
|
The events fired by the VerizonMediaAdBreakList. |
|
Fired when the ad break is skipped. |
|
Fired when the ad is completed. |
|
Fired when the ad break is added. |
|
Fired when an asset is added. |
|
Fired when the ad ends. |
|
The events fired by the VerizonMediaAd. |
|
Fired when the ad reaches the first quartile. |
|
List of Verizon Media ads. |
|
Events fired by the VerizonMediaAdList. |
|
Fired when the ad reaches the mid point. |
|
The Verizon Media ads API. |
|
Fired when the ad reaches the third quartile. |
|
Represents a Verizon Media asset. |
|
The events fired by the VerizonMediaAssetList. |
|
Represents a Verizon Media Asset Info Response. |
|
Fired when an asset info response is received. |
|
List of Verizon Media assets. |
|
Describes the configuration of the Verizon Media integration. |
|
The events fired by the Verizon Media API. |
|
Represents a combination of user identifier and one or more external identifiers for Verizon Media assets. |
|
Describes the configuration of Verizon Media Ping features. |
|
Fired when an error or invalid response is received from the Ping API. |
|
Represents a Verizon Media Ping response. |
|
Fired when a Ping response is received. |
|
Represents a Verizon Media Preplay base response. |
|
Represents a Verizon Media Preplay response for live assets. |
|
Fired when a Preplay response is received. |
|
Represents a Verizon Media Preplay response for VOD assets. |
|
Fired when the ad break is removed. |
|
Fired when the ad is removed. |
|
Fired when an asset is removed. |
|
Represents a Verizon Media DRM response. |
|
Represents a Verizon Media response with live ads. |
|
Represents a Verizon Media response for live ad breaks. |
|
Represents a Verizon Media response with advertisement information for live assets. |
|
The Verizon Media response with ad information for VOD assets. |
|
Represents a Verizon Media response with ad break information for VOD assets. |
|
Represents the offset of a Verizon Media ad break. |
|
Represents a Verizon Media response with a placeholder for an ad for VOD assets. |
|
Represents a Verizon Media response with advertisement information for VOD assets. |
|
Represents a media resource which is found on the Verizon Media Platform. |
|
Describes the UI configuration of the Verizon Media integration. |
|
Fired when the ad break is updated. |
|
Represents a quality of a video track. |
|
Describes the configuration of the Vimond DRM integration. |
|
The visibility API. |
|
Represents a visibility observer. |
|
The virtual reality API which allows you to control the display of 360° VR videos. |
|
Describes the configuration of the virtual reality feature of a source. |
|
Represents a direction in the VR feature. |
|
The events fired by the VR API. |
|
Describes the configuration of the Vudrm DRM integration. |
|
The Web Audio API. |
|
Represents a cue of a WebVTT text track. |
|
Represents a WebVTT region. |
|
Describes the configuration of the Xstream DRM integration. |
|
The Yospace API. |
|
Represents the collection of standard callback functions for a Yospace SessionManager. |
|
The events fired by the Yospace API. |
|
Represents a configuration for server-side ad insertion with the Yospace pre-integration. |
|
Represents a media resource with a Yospace server-side ad insertion request. |
|
Describes the options of the Youbora integration. |
Namespace |
Description |
---|---|
The bundled Video.js library, based on version 5.x. |
Variable |
Type |
Description |
---|---|---|
The global cache API. |
||
The global cast API. |
||
|
The features included in the THEOplayer SDK. |
|
List of players. |
||
|
The player suite version of the THEOplayer SDK. |
|
Utils that serve common use cases. For example encoding and decoding a base64 string to Uint8Array and vice versa. |
||
|
The version of the THEOplayer SDK. |
Type Alias |
Description |
---|---|
The adaptive bitrate stratey. |
|
The adaptive bitrate strategy of the first segment, represented by a value from the following list: |
|
The integration of an ad break, represented by a value from the following list: |
|
The ad preloading strategy, represented by a value from the following list: |
|
The ad readiness state, represented by a value from the following list: |
|
The type of ad source: |
|
The identifier of the Agama integration. |
|
The type of log level for the Agama integration, represented by a value from the following list: |
|
The service name, represented by a value from the following list: |
|
The stream type, represented by a value from the following list: |
|
The integration identifier of an analytics description, represented by a value from the following list: |
|
The identifier of the Axinom integration. |
|
The identifier of the Azure Media Services integration. |
|
A boundary can be one of 3 possible types: |
|
Helper type that represents either an ArrayBuffer or an ArrayBufferView. Inspired by https://developer.mozilla.org/en-US/docs/Web/API/BufferSource. |
|
The cache status, represented by a value from the following list: |
|
The cache task status, represented by a value from the following list: |
|
The state of a casting process, represented by a value from the following list: |
|
A request for a certificate. |
|
The chromecast error code, represented by a value from the following list: |
|
The Chromecast's metadata type, represented by a value from the following list: |
|
The identifier of the Comcast integration. |
|
The identifier of the Conax integration. |
|
An error code whose category is |
|
The content protection's subtype, represented by a value from the following list: |
|
The identifier of the Conviva integration. |
|
The cross-origin setting of a source, represented by a value from the following list: |
|
The type of the stream requested from Google DAI, represented by a value from the following list: |
|
The delivery type of the ad content file, represented by a value from the following list: |
|
Fired when the VR.direction changes. |
|
A function which processes DRM data. |
|
The identifier of the DRM Today integration. |
|
The style of the edge, represented by a value from the following list: |
|
The function to be executed when an event occurred. |
|
A record used to map events. Each entry contains an event name with associated event interface. |
|
The identifier of the ExpressPlay integration. |
|
The identifier of the Ezdrm integration. |
|
The possible ad unit types, represented by a value from the following list: |
|
The identifier of the Google DAI integration. |
|
The possible types of an ID3 frame. |
|
The identifier of the Imagine integration. |
|
The identifier of the Irdeto integration. |
|
The join strategy, represented by a value from the following list: |
|
The identifier of the KeyOS integration. |
|
The id of a key system. Possible values are 'widevine', 'fairplay' and 'playready'. |
|
The type of the licence, represented by a value from the following list: |
|
A synchronous or asynchronous return type |
|
The media error code, represented by a value from the following list: |
|
The media's type, represented by a value from the following list: |
|
The identifier of the Moat integration. |
|
The muted autoplay policy of a player. |
|
A Node-style asynchronous callback. After all asynchronous work is done, the callback *must* call |
|
The picture-in-picture position, represented by a value from the following list: |
|
The preload type of the player, represented by a value from the following list: |
|
The presentation mode of the player, represented by a value from the following list: |
|
Fired when RelatedContent.sources changes. |
|
Fired when the related content panel is hidden. |
|
Fired when the related content panel is shown. |
|
The possible types of an HTTP request body. |
|
The RequestInterceptor is a function that accepts a Request object as its argument and can return a promise. If it returns a promise then the request waits until the promise is resolved. |
|
The possible types representing an HTTP request. |
|
The request's type, represented by a value from the following list: |
|
The request's subtype, represented by a value from the following list: |
|
The request's type, represented by a value from the following list: |
|
The possible types of an HTTP response body. |
|
The ResponseInterceptor is a function that accepts a Response object as its argument and can return a promise. If it returns a promise then the response waits until the promise is resolved. |
|
The possible types representing an HTTP response. |
|
The response's type, represented by a value from the following list: |
|
The strategy for period switches (see DashPlaybackConfiguration.useSeamlessPeriodSwitch), represented by a value from the following list: |
|
The strategy of the action after skipping ads, represented by a value from the following list: |
|
The identifier of the Media Melon SmartSight integration. |
|
Represents a media resource. |
|
The integration identifier of a source specific to a pre-integration, represented by a value from the following list: |
|
A media resource or list of media resources. |
|
The identifier of a server-side ad insertion pre-integration, represented by a value from the following list: |
|
Fired when the VR.state changes. |
|
Fired when the VR.stereo changes. |
|
The identifier of the Stream One integration. |
|
Helper type to extract string keys from type objects. |
|
Record of style properties. Each entry contains the style property name with associated value. |
|
An error code whose category is |
|
The ready state of a text track, represented by a value from the following list: |
|
The content type of a text track, represented by a value from the following list: |
|
The identifier of the Titanium integration. |
|
A record used to map localization. Each entry contains a translation of an English string. |
|
The identifier of the Uplynk integration. |
|
The identifier of the Verimatrix integration. |
|
Represents a unique asset identifier for a Verizon Media asset. |
|
The movie rating of an asset, represented by a value from the following list: |
|
The TV rating of an asset, represented by a value from the following list: |
|
The type of an asset on the Verizon Media Platform, represented by a value from the following list: |
|
Type of a Verizon Media Preplay response. |
|
The identifier of the Vimond integration. |
|
A callback for a visibility observer. |
|
An promise-returning asynchronous callback. The callback *must* return a promise that resolves (or rejects) after all asynchronous work is done. |
|
The iframe policies for VPAID ads, represented by a value from the following list: |
|
The state of the VR feature, represented by a value from the following list: |
|
The stereo mode of the VR integration, represented by a value from the following list: |
|
A WebVTT-defined text alignment, represented by a value from the following list: |
|
A WebVTT-defined writing direction, represented by a value from the following list: |
|
A WebVTT-defined line offset, represented by a value from the following list: |
|
A WebVTT-defined line alignment, represented by a value from the following list: |
|
A WebVTT-defined position, represented by a value from the following list: |
|
A WebVTT-defined position alignment, represented by a value from the following list: |
|
A WebVTT-defined region scroll setting, represented by a value from the following list: |
|
The identifier of the Vudrm integration. |
|
An asynchronous callback to delay a request or response. |
|
Describes the Widevine key system configuration. |
|
The identifier of the Xstream integration. |
|
The identifier of a Yospace's ID3 frame, represented by a value from the following list: |
|
The identifier of the Yospace integration. |
|
The type of the Yospace stream, represented by a value from the following list: |
|
The identifier of the Youbora integration. |