Version: 2.67.0

theoplayer

THEOplayer

theoplayer package

Classes

Class

Description

ChromelessPlayer

The player API.

Player

The player API extended with UI functionality.

Enumerations

Enumeration

Description

ABRStrategyType

The adaptive bitrate strategy of the first segment, represented by a value from the following list:
- 'performance': The player will optimize ABR behavior to focus on the performance of the player. This strategy initiates playback with the lowest quality suitable for the device which means faster start-up time.
- 'quality': The player will optimize ABR behavior to focus displaying the best visual quality to the end-user. This strategy initiates playback with the highest bit rate suitable for the device.
- 'bandwidth': The player will optimize the ABR behavior to focus on displaying the most optimal quality based on historic data of available bandwidth and knowledge of the network conditions.

AdIntegrationKind

The integration of an ad break, represented by a value from the following list:
- 'theo': Default ad playback.
- 'google-ima': Google IMA pre-integrated ad playback.
- 'spotx': SpotX pre-integrated ad playback.
- 'freewheel': FreeWheel pre-integrated ad playback.

AdPreloadType

The ad preloading strategy, represented by a value from the following list:
- 'none': Ads are not preloaded.
- 'midroll-and-postroll': Mid- and postrolls are preloaded.

AdReadyState

The ad readiness state, represented by a value from the following list:
- 'none': The ad not loaded state.
- 'ready': The ad loaded state.

AnalyticsIntegrationId

The integration identifier of an analytics description, represented by a value from the following list:
- 'agama': The description is an AgamaConfiguration
- 'conviva': The description is a ConvivaConfiguration
- 'youbora': The description is a YouboraOptions
- 'moat': The description is a MoatConfiguration
- 'streamone': The description is a StreamOneConfiguration
- 'smartsight': The description is a SmartSightConfiguration

ChromecastMetadataType

The Chromecast's metadata type, represented by a value from the following list:
- 'movie'
- 'audio'
- 'tv-show'
- 'generic'

DeliveryType

The delivery type of the ad content file, represented by a value from the following list:
- 'progressive': Delivered through progressive download protocols (e.g. HTTP).
- 'streaming': Delivered through streaming download protocols.

JoinStrategy

The join strategy, represented by a value from the following list:
- 'auto' : The player will automatically join a cast session if one exists when play is called. Otherwise it will prompt the user with all available devices.
- 'manual' : The player will take over an existing session if there is one and the cast button is clicked. Otherwise it will prompt the user with all available devices.
- 'disabled' : The player is not affected by cast sessions and is not castable.

MediaErrorCode

The media error code, represented by a value from the following list:
- 1 - ABORTED: The fetching of the associated resource was aborted by the user's request.
- 2 - NETWORK: Some kind of network error occurred which prevented the media from being successfully fetched, despite having previously been available.
- 3 - DECODE: Despite having previously been determined to be usable, an error occurred while trying to decode the media resource, resulting in an error.
- 4 - SRC_NOT_SUPPORTED: The associated resource or media provider object (such as a MediaStream) has been found to be unsuitable.
- 5 - ENCRYPTED: Some kind of digital rights management error occurred.
- 6 - LICENSE_INVALID: The player's license was determined to be invalid.
- 7 - ADVERTISEMENT_ERROR: Some kind of advertisement related error occurred.

MutedAutoplayConfiguration

The muted autoplay policy of a player.
- 'none': Disallow muted autoplay. If the player is requested to autoplay while unmuted, and the platform does not support unmuted autoplay, the player will not start playback.
- 'all': Allow muted autoplay. If the player is requested to autoplay while unmuted, and the platform supports muted autoplay, the player will start muted playback.
- 'content': Allow muted autoplay only for the main content. Disallow muted autoplay for e.g. advertisements. (Not yet supported.)

PresentationMode

The presentation mode of the player, represented by a value from the following list:
- 'inline': The player is shown in its original location on the page.
- 'fullscreen': The player fills the entire screen.
- 'picture-in-picture': The player is shown on top of the page (see PiPConfiguration for more options).

SourceIntegrationId

The integration identifier of a source specific to a pre-integration, represented by a value from the following list:
- 'verizon-media': The source is a VerizonMediaSource

TextTrackReadyState

The ready state of a text track, represented by a value from the following list:
- 0: Indicates that the text track's cues have not been obtained.
- 1: The text track is loading. Further cues might still be added to the track by the parser.
- 2: The text track has been loaded with no fatal errors.
- 3: An error occurred obtaining the cues for the track. Some or all of the cues are likely missing and will not be obtained.

TextTrackType

The content type of a text track, represented by a value from the following list:
- 'srt': The track contains SRT (SubRip Text) content.
- 'ttml': The track contains TTML (Timed Text Markup Language) content.
- 'webvtt': The track contains WebVTT (Web Video Text Tracks) content.
- 'emsg': The track contains emsg (Event Message) content.
- 'eventstream': The track contains Event Stream content.
- 'id3': The track contains ID3 content.
- 'cea608': The track contains CEA608 content.
- 'daterange': The track contains HLS EXT-X-DATERANGE content.
- '': The type of the track contents is unknown.

VerizonMediaAssetMovieRating

The movie rating of an asset, represented by a value from the following list:
- -1 (NOT_AVAILABLE)
- 0 (NOT_APPLICABLE)
- 1 (G)
- 2 (PG)
- 3 (PG_13)
- 4 (R)
- 5 (NC_17)
- 6 (X)
- 7 (NOT_RATED)

VerizonMediaAssetTvRating

The TV rating of an asset, represented by a value from the following list:
- -1 (NOT_AVAILABLE)
- 0 (NOT_APPLICABLE)
- 1 (TV_Y)
- 2 (TV_Y7)
- 3 (TV_G)
- 4 (TV_PG)
- 5 (TV_14)
- 6 (TV_MA)
- 7 (NOT_RATED)

VerizonMediaPreplayResponseType

The response type of the Verizon Media Preplay request, represented by a value from the following list:
- 'vod'
- 'live'

VPAIDMode

The iframe policies for VPAID ads, represented by a value from the following list:
- 'enabled': Ads will load in a cross domain iframe. This disables access to the site via JavaScript. Ads that require a friendly iframe will fail to play.
- 'insecure': Ads will load in a friendly iframe. This allows access to the site via JavaScript.
- 'disabled': Ads will error when requested.

Interfaces

Interface

Description

ABRConfiguration

Describes the adaptive bitrate configuration.

ABRMetadata

Describes the metadata of the adaptive bitrate strategy.

ABRStrategyConfiguration

Describes the configuration of the adaptive bitrate strategy.

Ad

Represents a VAST creative. It is either a linear or non-linear ad.

AdBreak

Represents an ad break in the VMAP specification or an ad pod in the VAST specification.

AdBufferingEvent

Fired when the ad has stalled playback to buffer.

AddCachingTaskEvent

Fired when a caching task is added.

AdDescription

Describes an ad break request.

AdMetadataEvent

Fired when an ads list is loaded.

Ads

The API for advertisements.

AdsConfiguration

Describes the configuration of advertisement.

AdsEventMap

The events fired by the ads API.

AdSource

Describes the source of the ad.

AES128KeySystemConfiguration

Describes the AES128 key system configuration.

AgamaConfiguration

Describes the configuration of Agama.

AgamaPlayerConfiguration

Describes the configuration of Agama.

AgamaSourceConfiguration

Describes the configuration of Agama for this source.

AirPlay

The AirPlay API.

Analytics

The analytics API.

AnalyticsDescription

Describes the configuration of an analytics integration.

AudioQuality

Represents a quality of an audio track.

AxinomDRMConfiguration

Describes the configuration of the Axinom DRM integration.

AzureDRMConfiguration

Describes the configuration of the Azure Media Services DRM integration.

BaseSource

Represents the common properties of a media resource.

BoundaryC3

Represents the boundary of an ad that is relevant for up to three days after the original airing.

BoundaryC7

Represents the boundary of an ad that is relevant for up to seven days after the original airing.

BoundaryHalftime

Represents the boundary that identifies special content.

BoundaryInfo

Represents the information of an ad boundary.

Cache

The media caching API.

CacheEventMap

The events fired by the cache API.

CachingTask

Represents a caching task.

CachingTaskEventMap

The events fired by the CachingTask.

CachingTaskLicense

The CachingTask's license API.

CachingTaskList

List of caching tasks.

CachingTaskListEventMap

The events fired by the CachingTaskList.

CachingTaskParameters

Describes the configuration of a caching task.

Canvas

The canvas API which allows drawing the player's current frame to a 2D or WebGL context.

Cast

The cast API.

CastConfiguration

Describes the configuration of the Cast integrations.

CastEventMap

The events fired by the cast API.

Chromecast

The Chromecast API.

ChromecastConfiguration

Describes the configuration of the Chromecast integration.

ChromecastMetadataDescription

Describes the metatadata used by Chromecast.

ChromecastMetadataImage

Describes the metadata of a Chromecast image.

ClearkeyDecryptionKey

Describes the ClearKey decryption key.

ClearkeyKeySystemConfiguration

Describes the ClearKey key system configuration.

Clip

The clip API which can be used to clip the playback window of a source.

ClipEventMap

The events fired by the clip API.

ComcastDRMConfiguration

Describes the configuration of the Comcast DRM integration.

CompanionAd

Represents a companion ad which is displayed near the video player.

ConaxDRMConfiguration

Describes the configuration of the Conax DRM integration.

Conviva

The Conviva API.

ConvivaConfiguration

Describes the configuration of the Conviva integration.

ConvivaContentMetadata

Describes the content's metadata.

DateRangeCue

Represents a cue of a HLS date range metadata text track.

DeviceBasedTitaniumDRMConfiguration

Describes the configuration of the Titanium DRM integration with device-based authentication.

DRMConfiguration

Describes the configuration of the DRM.

DRMTodayDRMConfiguration

Describes the configuration of the DRM Today DRM integration.

EmsgCue

Represents a cue of an emsg metadata text track.

ErrorEvent

Fired when an error occurs.

Event

Fired when an event occurs.

EventDispatcher

Dispatches events that are fired.

EventedList

List of generic items which can dispatch events.

EventStreamCue

Represents a cue of an Event Stream metadata text track.

ExpressPlayDRMConfiguration

Describes the configuration of the ExpressPlay DRM integration.

EzdrmDRMConfiguration

Describes the configuration of the Ezdrm DRM integration.

FairPlayKeySystemConfiguration

Describes the FairPlay key system configuration.

FreeWheelAdDescription

Describes a FreeWheel ad break request.

FreeWheelCue

Represents a FreeWheel cue.

Geo

Represents a geographical location.

GlobalCast

The global cast API.

GlobalChromecast

The global Chromecast API.

GoogleDAIConfiguration

Represents a configuration for server-side ad insertion with the Google DAI pre-integration.

GoogleDAILiveConfiguration

Represents a configuration for server-side ad insertion with the Google DAI pre-integration for a Live media stream.

GoogleDAITypedSource

Represents a media resource with a Google DAI server-side ad insertion request.

GoogleDAIVodConfiguration

Represents a configuration for server-side ad insertion with the Google DAI pre-integration for a VOD media stream.

GoogleImaAd

Represents a Google IMA creative compliant to the VAST specification.

HTTPHeaders

Record of HTTP headers. Each entry contains the header name and its associated value.

ID3AttachedPicture

Represents an attached picture ID3 frame.

ID3BaseFrame

Represents a generic ID3 frame.

ID3Comments

Represents a comments ID3 frame.

ID3CommercialFrame

Represents a commercial ID3 frame.

ID3Cue

Represents a cue of an ID3 metadata text track.

ID3GenericEncapsulatedObject

Represents a general encapsulated object ID3 frame.

ID3InvolvedPeopleList

Represents an involved people list ID3 frame.

ID3PositionSynchronisationFrame

Represents an position synchronisation ID3 frame.

ID3PrivateFrame

Represents a private ID3 frame.

ID3SynchronizedLyricsText

Represents a synchronised lyrics/text ID3 frame.

ID3TermsOfUse

Represents a terms of use ID3 frame.

ID3Text

Represents a text information ID3 frame.

ID3UniqueFileIdentifier

Represents a unique file identifier ID3 frame.

ID3Unknown

Represents an unknown ID3 frame.

ID3UnsynchronisedLyricsTextTranscription

Represents a unsynchronised lyrics/text transcription ID3 frame.

ID3UrlLink

Represents a URL link ID3 frame.

ID3UserDefinedText

Represents a used defined text ID3 frame.

ID3UserDefinedUrlLink

Represents a user defined URL link ID3 frame.

ID3Yospace

Represents a Yospace ID3 frame.

IMAAdDescription

Describes a Google IMA ad break request.

Imagine

The Imagine API.

ImagineEventMap

The events fired by the Imagine API.

ImagineServerSideAdInsertionConfiguration

Describes the SSAI configuration of the Imagine integration.

ImagineTrackingEvent

Fired when an event related to the Imagine integration occurs.

ImagineTypedSource

Describes a source of the Imagine integration.

InterceptableRequest

Represents an intercepted HTTP request which can be modified.

InterceptableResponse

Represents an intercepted HTTP response which can be modified.

IrdetoDRMConfiguration

Describes the configuration of the Irdeto DRM integration.

KeyOSDRMConfiguration

Describes the configuration of the KeyOS DRM integration

KeyOSFairplayKeySystemConfiguration

Describes the KeyOS FairPlay key system configuration.

KeyOSKeySystemConfiguration

Describes the KeyOS key system configuration.

KeySystemConfiguration

Describes the key system configuration.

LinearAd

Represents a linear ad in the VAST specification.

List

List of generic items.

MediaError

Thrown when a media error occurs.

MediaFile

Represents metadata of an media file with ad content.

MediaMelonConfiguration

Describes the configuration of the Media Melon integration.

MediaTrack

Represents a media track (audio or video) of a media resource.

MediaTrackList

List of media tracks.

MetadataDescription

Describes the metadata of a Chromecast source.

Metrics

The metrics API which can be used to gather information related to the quality-of-service and video playback experience.

MoatConfiguration

Describes configuration of the Moat integration.

Network

The network API.

NetworkEventMap

The events fired by the network API.

NetworkInterceptorController

Network interceptor API which can be used to intercept network requests and responses.

NonLinearAd

Represents a non-linear ad in the VAST specification.

PiPConfiguration

Describes the configuration of the picture-in-picture feature.

PlayerConfiguration

Describes a player's configuration.

PlayerEventMap

The events fired by the ChromelessPlayer.

PlayerList

List of players.

Presentation

The presentation API.

PresentationEventMap

The events fired by the presentation API.

PresentationModeChangeEvent

Fired when the presentation mode changes.

Quality

Represents a quality of a media track.

QualityEventMap

The events fired by a Quality.

QualityList

List of qualities.

RelatedContent

The related content API.

RelatedContentEventMap

The events fired by the related content API.

RelatedContentSource

Represents a related content source.

RemoveCachingTaskEvent

Fired when a caching task is removed.

Representation

Represents a DASH representation.

Request

Represents an HTTP request.

RequestInit

Contains network request properties used to modify an HTTP request.

ResponseInit

Contains network response properties used to modify an HTTP response.

ServerSideAdInsertionConfiguration

Represents a configuration for server-side ad insertion (SSAI).

SmartSightConfiguration

Describes the configuration of the Media Melon SmartSight integration.

SocialSharing

The social sharing API which can supplement the UI with a social sharing panel.

SocialSharingItem

Represents a social media to which the player can share content.

SourceConfiguration

Describes the configuration of a player's source.

SourceDescription

Describes the configuration of a player's source.

SpotXAdDescription

Describes a SpotX ad break request.

SpotxData

A record of SpotX query string parameters. Each entry contains the parameter name with associated value.

SpotxQueryParameter

A record of SpotX query string parameters which can be a nested structure. Each entry contains the parameter name with associated value.

StreamOneConfiguration

Describes the configuration of the Stream One integration.

TextTrack

Represents a text track of a media resource.

TextTrackCue

Represents a cue of a text track.

TextTrackCueEventMap

The events fired by the TextTrackCue.

TextTrackCueList

List of text track cues.

TextTrackDescription

Describes the configuration of a side-loaded text track.

TextTracksList

List of text tracks.

TextTrackStyle

The text track style API.

TextTrackStyleEventMap

Events fired by the TextTrackStyle API.

THEOplayerAdDescription

Describes an ad break request.

ThumbnailResolution

Represents the resolution of a Verizon Media thumbnail.

TitaniumDRMConfiguration

Describes the configuration of the Titanium DRM integration.

TokenBasedTitaniumDRMConfiguration

Describes the configuration of the Titanium DRM integration with token-based authentication.

Track

Represents a track of a media resource.

TrackEventMap

The events fired by a Track.

TrackList

List of tracks.

TrackListEventMap

The events fired by a TrackList.

TTMLCue

Represents a cue of a TTML text track.

TypedSource

Represents a media resource characterized by a URL to the resource and optionally information about the resource.

UIConfiguration

Describes the UI configuration of the player.

UIPlayerConfiguration

Describes the UI related configuration of the player.

UIRelatedContent

The related content UI API which can be used to toggle UI components.

UIRelatedContentEventMap

The events fired by the related content API (with ui).

UpdateQualityEvent

Fired when the quality updates.

UplynkDRMConfiguration

Describes the configuration of the Uplynk DRM integration.

UpNextBar

A bar which displays the up next source.

UpNextManager

The up next API.

UpNextPanel

A panel which displays the up next source.

UpNextSource

Describes an up next source.

VendorCast

Common API for all cast integrations.

VendorCastEventMap

The events fired by the common vendor APIs.

VerimatrixDRMConfiguration

Describes the configuration of the Veramatrix DRM integration.

VerizonMedia

The Verizon Media API.

VerizonMediaAd

Represents a Verizon Media ad.

VerizonMediaAdBeginEvent

Fired when an ad begins.

VerizonMediaAdBreak

Represents a Verizon Media ad.

VerizonMediaAdBreakBeginEvent

Fired when the ad break begins.

VerizonMediaAdBreakEndEvent

Fired when the ad break ends.

VerizonMediaAdBreakEventMap

The events fired by the VerizonMediaAdBreak.

VerizonMediaAdBreakList

List with Verizon Media ad breaks.

VerizonMediaAdBreakListEventMap

The events fired by the VerizonMediaAdBreakList.

VerizonMediaAdBreakSkipEvent

Fired when the ad break is skipped.

VerizonMediaAdCompleteEvent

Fired when the ad is completed.

VerizonMediaAddAdBreakEvent

Fired when the ad break is added.

VerizonMediaAddAssetEvent

Fired when an asset is added.

VerizonMediaAdEndEvent

Fired when the ad ends.

VerizonMediaAdEventMap

The events fired by the VerizonMediaAd.

VerizonMediaAdFirstQuartileEvent

Fired when the ad reaches the first quartile.

VerizonMediaAdList

List of Verizon Media ads.

VerizonMediaAdListEventMap

Events fired by the VerizonMediaAdList.

VerizonMediaAdMidpointEvent

Fired when the ad reaches the mid point.

VerizonMediaAds

The Verizon Media ads API.

VerizonMediaAdThirdQuartileEvent

Fired when the ad reaches the third quartile.

VerizonMediaAsset

Represents a Verizon Media asset.

VerizonMediaAssetEventMap

The events fired by the VerizonMediaAssetList.

VerizonMediaAssetInfoResponse

Represents a Verizon Media Asset Info Response.

VerizonMediaAssetInfoResponseEvent

Fired when an asset info response is received.

VerizonMediaAssetList

List of Verizon Media assets.

VerizonMediaConfiguration

Describes the configuration of the Verizon Media integration.

VerizonMediaEventMap

The events fired by the Verizon Media API.

VerizonMediaExternalId

Represents a combination of user identifier and one or more external identifiers for Verizon Media assets.

VerizonMediaPingConfiguration

Describes the configuration of Verizon Media Ping features.

VerizonMediaPingErrorEvent

Fired when an error or invalid response is received from the Ping API.

VerizonMediaPingResponse

Represents a Verizon Media Ping response.

VerizonMediaPingResponseEvent

Fired when a Ping response is received.

VerizonMediaPreplayBaseResponse

Represents a Verizon Media Preplay base response.

VerizonMediaPreplayLiveResponse

Represents a Verizon Media Preplay response for live assets.

VerizonMediaPreplayResponseEvent

Fired when a Preplay response is received.

VerizonMediaPreplayVodResponse

Represents a Verizon Media Preplay response for VOD assets.

VerizonMediaRemoveAdBreakEvent

Fired when the ad break is removed.

VerizonMediaRemoveAdEvent

Fired when the ad is removed.

VerizonMediaRemoveAssetEvent

Fired when an asset is removed.

VerizonMediaResponseDrm

Represents a Verizon Media DRM response.

VerizonMediaResponseLiveAd

Represents a Verizon Media response with live ads.

VerizonMediaResponseLiveAdBreak

Represents a Verizon Media response for live ad breaks.

VerizonMediaResponseLiveAds

Represents a Verizon Media response with advertisement information for live assets.

VerizonMediaResponseVodAd

The Verizon Media response with ad information for VOD assets.

VerizonMediaResponseVodAdBreak

Represents a Verizon Media response with ad break information for VOD assets.

VerizonMediaResponseVodAdBreakOffset

Represents the offset of a Verizon Media ad break.

VerizonMediaResponseVodAdPlaceholder

Represents a Verizon Media response with a placeholder for an ad for VOD assets.

VerizonMediaResponseVodAds

Represents a Verizon Media response with advertisement information for VOD assets.

VerizonMediaSource

Represents a media resource which is found on the Verizon Media Platform.

VerizonMediaUiConfiguration

Describes the UI configuration of the Verizon Media integration.

VerizonMediaUpdateAdBreakEvent

Fired when the ad break is updated.

VideoQuality

Represents a quality of a video track.

VimondDRMConfiguration

Describes the configuration of the Vimond DRM integration.

Visibility

The visibility API.

VisibilityObserver

Represents a visibility observer.

VR

The virtual reality API which allows you to control the display of 360° VR videos.

VRConfiguration

Describes the configuration of the virtual reality feature of a source.

VRDirection

Represents a direction in the VR feature.

VREventMap

The events fired by the VR API.

VudrmDRMConfiguration

Describes the configuration of the Vudrm DRM integration.

WebAudio

The Web Audio API.

WebVTTCue

Represents a cue of a WebVTT text track.

WebVTTRegion

Represents a WebVTT region.

WidevineKeySystemConfiguration

Describes the Widevine key system configuration.

XstreamDRMConfiguration

Describes the configuration of the Xstream DRM integration.

Yospace

The Yospace API.

YospaceCallbackObject

Represents the collection of standard callback functions for a Yospace SessionManager.

YospaceEventMap

The events fired by the Yospace API.

YospaceServerSideAdInsertionConfiguration

Represents a configuration for server-side ad insertion with the Yospace pre-integration.

YospaceTypedSource

Represents a media resource with a Yospace server-side ad insertion request.

YouboraOptions

Describes the options of the Youbora integration.

Variables

Variable

Type

Description

cache

Cache

The global cache API.

cast

GlobalCast

The global cast API.

features

string

The features included in the THEOplayer SDK.

players

PlayerList

List of players.

version

string

The version of the THEOplayer SDK.

Type Aliases

Type Alias

Description

ABRStrategy

The adaptive bitrate stratey.

AdSourceType

The type of ad source:
- 'vast': The source is a VAST resource.
- 'vmap': The source is a VMAP resource.
- 'adrule': The source is a Ad Rule resource.

AgamaAnalyticsIntegrationID

The identifier of the Agama integration.

AgamaLogLevelType

The type of log level for the Agama integration, represented by a value from the following list:
- 'info'
- 'debug'
- 'warning'
- 'error'
- 'fatal'

AgamaServiceName

The service name, represented by a value from the following list:
- 'live'
- 'svod'
- 'nvod'
- 'tvod'
- 'avod'
- 'catchuptv'

AgamaStreamType

The stream type, represented by a value from the following list:
- 'live'
- 'vod'

AnalyticsIntegrationID

The possible identifiers for an analytics integration.

AxinomIntegrationID

The identifier of the Axinom integration.

AzureIntegrationID

The identifier of the Azure Media Services integration.

Boundary

A boundary can be one of 3 possible types:
- c3: An ad that is relevant for up to 3 days after the original airing.
- c7: An ad that is relevant for up to 7 days after the original airing.
- halftime: Identifies special content.

CacheStatus

The cache status, represented by a value from the following list:
- 'uninitialised': Previously stored caching tasks are unavailable.
- 'initialised': Previously stored caching tasks are now available.

CacheTaskStatus

The cache task status, represented by a value from the following list:
- 'idle': The task has been created, but has not started downloading content.
- 'loading': The task is currently downloading the content.
- 'done': The task has finished downloading all content.
- 'error': The task has encountered an error while downloading or evicting content.
- 'evicted': All data associated with the task has been removed because the task expired or the user invoked the remove method.

CastState

The state of a casting process, represented by a value from the following list:
- 'unavailable': No available cast devices.
- 'available': Cast device available, but the player is not connected.
- 'connecting': Cast device available and the player is connecting.
- 'connected': Cast device available and the player is connected.

ComcastIntegrationID

The identifier of the Comcast integration.

ConaxIntegrationID

The identifier of the Conax integration.

ContentProtectionRequestSubType

The content protection's subtype, represented by a value from the following list:
- 'fairplay-license'
- 'fairplay-certificate'
- 'widevine-license'
- 'widevine-certificate'
- 'playready-license'
- 'clearkey-license'
- 'aes128-key'

ConvivaAnalyticsIntegrationID

The identifier of the Conviva integration.

CrossOriginSetting

The cross-origin setting of a source, represented by a value from the following list:
- 'anonymous': CORS requests will have the credentials flag set to 'same-origin'.
- 'use-credentials': CORS requests will have the credentials flag set to 'include'.
- '': Setting the empty string is the same as 'anonymous'

DAIAvailabilityType

The type of the stream requested from Google DAI, represented by a value from the following list:
- 'live': The requested stream is a live stream.
- 'vod': The requested stream is a video-on-demand stream.

DirectionChangeEvent

Fired when the VR.direction changes.

DRMIntegrationId

The identifier of a DRM integration, represented by a value from the following list:
- 'titanium'
- 'vudrm'
- 'ezdrm'
- 'keyos'
- 'irdeto'
- 'conax'
- 'drmtoday'
- 'expressplay'
- 'azure'
- 'xstream'
- 'vimond'
- 'axinom'
- 'verimatrix'
- 'uplynk'

DRMProcessor

A function which processes DRM data.

DRMTodayIntegrationID

The identifier of the DRM Today integration.

EdgeStyle

The style of the edge, represented by a value from the following list:
- 'none'
- 'dropshadow'
- 'raised'
- 'depressed'
- 'uniform'

EventListener

The function to be executed when an event occurred.

EventMap

A record used to map events. Each entry contains an event name with associated event interface.

ExpressPlayIntegrationID

The identifier of the ExpressPlay integration.

EzdrmIntegrationID

The identifier of the Ezdrm integration.

FreeWheelAdUnitType

The possible ad unit types, represented by a value from the following list:
- 'preroll': The linear ad will play before the content started.
- 'midroll': The linear ad will play at a time offset during the content.
- 'postroll': The linear ad will play after the content ended.
- 'overlay': The non-linear ad.

GoogleDAISSAIIntegrationID

The identifier of the Google DAI integration.

ID3Frame

The possible types of an ID3 frame.

ImagineSSAIIntegrationID

The identifier of the Imagine integration.

IrdetoIntegrationID

The identifier of the Irdeto integration.

KeyOSIntegrationID

The identifier of the KeyOS integration.

LicenseType

The type of the licence, represented by a value from the following list :
- 'temporary'
- 'persistent'

MediaType

The media's type, represented by a value from the following list:
- 'audio'
- 'video'
- 'text'
- 'image'
- Empty string ('') when the media type is unknown

MoatAnalyticsIntegrationID

The identifier of the Moat integration.

NodeStyleVoidCallback

A Node-style asynchronous callback.

After all asynchronous work is done, the callback *must* call done, optionally passing an error argument.

PiPPosition

The picture-in-picture position, represented by a value from the following list:
- 'top-left'
- 'top-right'
- 'bottom-left'
- 'bottom-right'

PreloadType

The preload type of the player, represented by a value from the following list:
- 'none': The player will not load anything on source change.
- 'metadata': The player will immediately load metadata on source change.
- 'auto': The player will immediately load metadata and media on source change.

RelatedChangeEvent

Fired when RelatedContent.sources changes.

RelatedHideEvent

Fired when the related content panel is hidden.

RelatedShowEvent

Fired when the related content panel is shown.

RequestBody

The possible types of an HTTP request body.

RequestInterceptor

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.

RequestLike

The possible types representing an HTTP request.

RequestMethod

The request's type, represented by a value from the following list:
- 'GET'
- 'HEAD'
- 'POST'
- 'PUT'
- 'DELETE'
- 'OPTIONS'

RequestSubType

The request's subtype, represented by a value from the following list:
- 'initialization-segment'
- Any value of ContentProtectionRequestSubType

RequestType

The request's type, represented by a value from the following list:
- 'manifest'
- 'segment'
- 'content-protection'

ResponseBody

The possible types of an HTTP response body.

ResponseInterceptor

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.

ResponseLike

The possible types representing an HTTP response.

ResponseType

The response's type, represented by a value from the following list:
- 'arraybuffer'
- 'blob'
- 'document'
- 'json'
- 'stream'
- 'text'

SkippedAdStrategy

The strategy of the action after skipping ads, represented by a value from the following list:
- 'play-all': Plays all the ad breaks skipped due to a seek.
- 'play-none': Plays none of the ad breaks skipped due to a seek.
- 'play-last': Plays the last ad break skipped due to a seek.

SmartSightIntegrationID

The identifier of the Media Melon SmartSight integration.

Source

Represents a media resource.

Sources

A media resource or list of media resources.

SSAIIntegrationId

The identifier of a server-side ad insertion pre-integration, represented by a value from the following list:
- 'yospace': The configuration with this identifier is a YospaceServerSideAdInsertionConfiguration
- 'google-dai': The configuration with this identifier is a GoogleDAIConfiguration
- 'imagine': The configuration with this identifier is a ImagineServerSideAdInsertionConfiguration

StateChangeEvent

Fired when the VR.state changes.

StereoChangeEvent

Fired when the VR.stereo changes.

StreamOneAnalyticsIntegrationID

The identifier of the Stream One integration.

StringKeyOf

Helper type to extract string keys from type objects.

StylePropertyRecord

Record of style properties. Each entry contains the style property name with associated value.

TitaniumIntegrationID

The identifier of the Titanium integration.

UILanguage

A record used to map localization. Each entry contains a translation of an English string.

UplynkIntegrationID

The identifier of the Uplynk integration.

VerimatrixIntegrationID

The identifier of the Verimatrix integration.

VerizonMediaAssetId

Represents a unique asset identifier for a Verizon Media asset.

VerizonMediaAssetType

The type of an asset on the Verizon Media Platform, represented by a value from the following list:
- 'asset': A Video-on-demand content asset.
- 'channel': A Live content channel.
- 'event': A Live event.

VerizonMediaPreplayResponse

Type of a Verizon Media Preplay response.

VimondIntegrationID

The identifier of the Vimond integration.

VisibilityObserverCallback

A callback for a visibility observer.

VoidPromiseCallback

An promise-returning asynchronous callback.

The callback *must* return a promise that resolves (or rejects) after all asynchronous work is done.

VRState

The state of the VR feature, represented by a value from the following list:
- 'unavailable'
- 'available'
- 'presenting'

VRStereoMode

The stereo mode of the VR integration, represented by a value from the following list:
- '': No stereo mode
- 'horizontal': The two viewpoints are in a side-by-side layout. The view for the left eye is in the left half of the video frame, the view for the right eye is in the right half of the video frame.
- 'vertical': The two viewpoints are in a top-bottom layout. The view for the left eye is in the upper half of the video frame, the view for the right eye is in the lower half of the video frame.

VTTAlignSetting

A WebVTT-defined text alignment, represented by a value from the following list:
- 'start': The text of each line is aligned towards the start side of the box.
- 'center': The text of each line is aligned at the center of the box.
- 'end': The text of each line is aligned towards the end side of the box.
- 'left': The text of each line is aligned to the box’s left side for horizontal cues, or top side otherwise.
- 'right': The text of each line is aligned to the box’s right side for horizontal cues, or bottom side otherwise.

VTTDirectionSetting

A WebVTT-defined writing direction, represented by a value from the following list:
- '': Horizontal. A line extends horizontally and is offset vertically from the video viewport’s top edge, with consecutive lines displayed below each other.
- 'rl': Vertical right-to-left. A line extends vertically and is offset horizontally from the video viewport’s right edge, with consecutive lines displayed to the left of each other.
- 'lr': vertical left-to-right. A line extends vertically and is offset horizontally from the video viewport’s left edge, with consecutive lines displayed to the right of each other.

VTTLine

A WebVTT-defined line offset, represented by a value from the following list:
- a number: The line offset is expressed in a number of text lines or a percentage of the video viewport height or width.
- 'auto': The line offset depends on the other showing tracks.

VTTLineAlignSetting

A WebVTT-defined line alignment, represented by a value from the following list:
- 'start': The cue box's start is aligned at a specified line.
- 'center': The cue box's center is aligned at a specified line.
- 'end': The cue box's end is aligned at a specified line.

VTTPosition

A WebVTT-defined position, represented by a value from the following list:
- a number: The position is expressed as a percentage value.
- 'auto': The position depends on the text alignment of the cue.

VTTPositionAlignSetting

A WebVTT-defined position alignment, represented by a value from the following list:
- 'line-left': The cue box's start is aligned at a specified position.
- 'center': The cue box's center is aligned at a specified position.
- 'line-right': The cue box's end is aligned at a specified position.
- 'auto': The cue box's alignment is dependent on its text alignment setting.

VTTScrollSetting

A WebVTT-defined region scroll setting, represented by a value from the following list:
- '': None. Cues in the region stay fixed at the location they were first painted in.
- 'up': Up. Cues in the region will be added at the bottom of the region and push any already displayed cues in the region up until all lines of the new cue are visible in the region.

VudrmIntegrationID

The identifier of the Vudrm integration.

WaitUntilCallback

An asynchronous callback to delay a request or response.

XstreamIntegrationID

The identifier of the Xstream integration.

YospaceId

The identifier of a Yospace's ID3 frame, represented by a value from the following list:
- 'YMID': This frame contains the media ID of the ad.
- 'YTYP': This frame contains the type of metadata.
- 'YSEQ': This frame contains the sequence number of the segment.
- 'YDUR': This frame contains the offset/duration from the beginning of the segment that contains the metadata.
- 'YSCP': This frame contains the customer-specific identifier.

YospaceSSAIIntegrationID

The identifier of the Yospace integration.

YospaceStreamType

The type of the Yospace stream, represented by a value from the following list:
- 'live': The stream is a live stream.
- 'livepause': The stream is a live stream with a large DVR window.
- 'nonlinear': The stream is a Non-Linear Start-Over stream.
- 'vod': The stream is a video-on-demand stream.

YouboraAnalyticsIntegrationID

The identifier of the Youbora integration.