Version: 2.69.0

theoplayer

THEOplayer

theoplayer package

Classes

ClassDescription
ChromelessPlayerThe player API.
PlayerThe player API extended with UI functionality.

Enumerations

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

Interfaces

InterfaceDescription
ABRConfigurationDescribes the adaptive bitrate configuration.
ABRMetadataDescribes the metadata of the adaptive bitrate strategy.
ABRStrategyConfigurationDescribes the configuration of the adaptive bitrate strategy.
AdRepresents a VAST creative. It is either a linear or non-linear ad.
AdBreakRepresents an ad break in the VMAP specification or an ad pod in the VAST specification.
AdBufferingEventFired when the ad has stalled playback to buffer.
AddCachingTaskEventFired when a caching task is added.
AdDescriptionDescribes an ad break request.
AdMetadataEventFired when an ads list is loaded.
AdsThe API for advertisements.
AdsConfigurationDescribes the configuration of advertisement.
AdsEventMapThe events fired by the ads API.
AdSourceDescribes the source of the ad.
AES128KeySystemConfigurationDescribes the AES128 key system configuration.
AgamaConfigurationDescribes the configuration of Agama.
AgamaPlayerConfigurationDescribes the configuration of Agama.
AgamaSourceConfigurationDescribes the configuration of Agama for this source.
AirPlayThe AirPlay API.
AnalyticsThe analytics API.
AnalyticsDescriptionDescribes the configuration of an analytics integration.
AudioQualityRepresents a quality of an audio track.
AxinomDRMConfigurationDescribes the configuration of the Axinom DRM integration.
AzureDRMConfigurationDescribes the configuration of the Azure Media Services DRM integration.
BaseSourceRepresents the common properties of a media resource.
BoundaryC3Represents the boundary of an ad that is relevant for up to three days after the original airing.
BoundaryC7Represents the boundary of an ad that is relevant for up to seven days after the original airing.
BoundaryHalftimeRepresents the boundary that identifies special content.
BoundaryInfoRepresents the information of an ad boundary.
CacheThe media caching API.
CacheEventMapThe events fired by the cache API.
CachingTaskRepresents a caching task.
CachingTaskEventMapThe events fired by the CachingTask.
CachingTaskLicenseThe CachingTask's license API.
CachingTaskListList of caching tasks.
CachingTaskListEventMapThe events fired by the CachingTaskList.
CachingTaskParametersDescribes the configuration of a caching task.
CanvasThe canvas API which allows drawing the player's current frame to a 2D or WebGL context.
CastThe cast API.
CastConfigurationDescribes the configuration of the Cast integrations.
CastErrorAn error that occurred while casting or attempting to cast to Chromecast.
CastErrorEventFired when an error occurs while casting or trying to cast.
CastEventMapThe events fired by the cast API.
ChromecastThe Chromecast API.
ChromecastConfigurationDescribes the configuration of the Chromecast integration.
ChromecastEventMapThe events fired by the Chromecast API.
ChromecastMetadataDescriptionDescribes the metatadata used by Chromecast.
ChromecastMetadataImageDescribes the metadata of a Chromecast image.
ClearkeyDecryptionKeyDescribes the ClearKey decryption key.
ClearkeyKeySystemConfigurationDescribes the ClearKey key system configuration.
ClipThe clip API which can be used to clip the playback window of a source.
ClipEventMapThe events fired by the clip API.
ComcastDRMConfigurationDescribes the configuration of the Comcast DRM integration.
CompanionAdRepresents a companion ad which is displayed near the video player.
ConaxDRMConfigurationDescribes the configuration of the Conax DRM integration.
ConvivaThe Conviva API.
ConvivaConfigurationDescribes the configuration of the Conviva integration.
ConvivaContentMetadataDescribes the content's metadata.
DateRangeCueRepresents a cue of a HLS date range metadata text track.
DeviceBasedTitaniumDRMConfigurationDescribes the configuration of the Titanium DRM integration with device-based authentication.
DRMConfigurationDescribes the configuration of the DRM.
DRMTodayDRMConfigurationDescribes the configuration of the DRM Today DRM integration.
EmsgCueRepresents a cue of an emsg metadata text track.
ErrorEventFired when an error occurs.
EventFired when an event occurs.
EventDispatcherDispatches events that are fired.
EventedListList of generic items which can dispatch events.
EventStreamCueRepresents a cue of an Event Stream metadata text track.
ExpressPlayDRMConfigurationDescribes the configuration of the ExpressPlay DRM integration.
EzdrmDRMConfigurationDescribes the configuration of the Ezdrm DRM integration.
FairPlayKeySystemConfigurationDescribes the FairPlay key system configuration.
FreeWheelAdDescriptionDescribes a FreeWheel ad break request.
FreeWheelCueRepresents a FreeWheel cue.
GeoRepresents a geographical location.
GlobalCastThe global cast API.
GlobalChromecastThe global Chromecast API.
GoogleDAIConfigurationRepresents a configuration for server-side ad insertion with the Google DAI pre-integration.
GoogleDAILiveConfigurationRepresents a configuration for server-side ad insertion with the Google DAI pre-integration for a Live media stream.
GoogleDAITypedSourceRepresents a media resource with a Google DAI server-side ad insertion request.
GoogleDAIVodConfigurationRepresents a configuration for server-side ad insertion with the Google DAI pre-integration for a VOD media stream.
GoogleImaAdRepresents a Google IMA creative compliant to the VAST specification.
HTTPHeadersRecord of HTTP headers. Each entry contains the header name and its associated value.
ID3AttachedPictureRepresents an attached picture ID3 frame.
ID3BaseFrameRepresents a generic ID3 frame.
ID3CommentsRepresents a comments ID3 frame.
ID3CommercialFrameRepresents a commercial ID3 frame.
ID3CueRepresents a cue of an ID3 metadata text track.
ID3GenericEncapsulatedObjectRepresents a general encapsulated object ID3 frame.
ID3InvolvedPeopleListRepresents an involved people list ID3 frame.
ID3PositionSynchronisationFrameRepresents an position synchronisation ID3 frame.
ID3PrivateFrameRepresents a private ID3 frame.
ID3SynchronizedLyricsTextRepresents a synchronised lyrics/text ID3 frame.
ID3TermsOfUseRepresents a terms of use ID3 frame.
ID3TextRepresents a text information ID3 frame.
ID3UniqueFileIdentifierRepresents a unique file identifier ID3 frame.
ID3UnknownRepresents an unknown ID3 frame.
ID3UnsynchronisedLyricsTextTranscriptionRepresents a unsynchronised lyrics/text transcription ID3 frame.
ID3UrlLinkRepresents a URL link ID3 frame.
ID3UserDefinedTextRepresents a used defined text ID3 frame.
ID3UserDefinedUrlLinkRepresents a user defined URL link ID3 frame.
ID3YospaceRepresents a Yospace ID3 frame.
IMAAdDescriptionDescribes a Google IMA ad break request.
ImagineThe Imagine API.
ImagineEventMapThe events fired by the Imagine API.
ImagineServerSideAdInsertionConfigurationDescribes the SSAI configuration of the Imagine integration.
ImagineTrackingEventFired when an event related to the Imagine integration occurs.
ImagineTypedSourceDescribes a source of the Imagine integration.
InterceptableRequestRepresents an intercepted HTTP request which can be modified.
InterceptableResponseRepresents an intercepted HTTP response which can be modified.
IrdetoDRMConfigurationDescribes the configuration of the Irdeto DRM integration.
KeyOSDRMConfigurationDescribes the configuration of the KeyOS DRM integration
KeyOSFairplayKeySystemConfigurationDescribes the KeyOS FairPlay key system configuration.
KeyOSKeySystemConfigurationDescribes the KeyOS key system configuration.
KeySystemConfigurationDescribes the key system configuration.
LinearAdRepresents a linear ad in the VAST specification.
ListList of generic items.
MediaErrorThrown when a media error occurs.
MediaFileRepresents metadata of an media file with ad content.
MediaMelonConfigurationDescribes the configuration of the Media Melon integration.
MediaTrackRepresents a media track (audio or video) of a media resource.
MediaTrackListList of media tracks.
MetadataDescriptionDescribes the metadata of a Chromecast source.
MetricsThe metrics API which can be used to gather information related to the quality-of-service and video playback experience.
MoatConfigurationDescribes configuration of the Moat integration.
NetworkThe network API.
NetworkEventMapThe events fired by the network API.
NetworkInterceptorControllerNetwork interceptor API which can be used to intercept network requests and responses.
NonLinearAdRepresents a non-linear ad in the VAST specification.
PiPConfigurationDescribes the configuration of the picture-in-picture feature.
PlayerConfigurationDescribes a player's configuration.
PlayerEventMapThe events fired by the ChromelessPlayer.
PlayerListList of players.
PresentationThe presentation API.
PresentationEventMapThe events fired by the presentation API.
PresentationModeChangeEventFired when the presentation mode changes.
QualityRepresents a quality of a media track.
QualityEventMapThe events fired by a Quality.
QualityListList of qualities.
RelatedContentThe related content API.
RelatedContentEventMapThe events fired by the related content API.
RelatedContentSourceRepresents a related content source.
RemoveCachingTaskEventFired when a caching task is removed.
RepresentationRepresents a DASH representation.
RequestRepresents an HTTP request.
RequestInitContains network request properties used to modify an HTTP request.
ResponseInitContains network response properties used to modify an HTTP response.
ServerSideAdInsertionConfigurationRepresents a configuration for server-side ad insertion (SSAI).
SmartSightConfigurationDescribes the configuration of the Media Melon SmartSight integration.
SocialSharingThe social sharing API which can supplement the UI with a social sharing panel.
SocialSharingItemRepresents a social media to which the player can share content.
SourceConfigurationDescribes the configuration of a player's source.
SourceDescriptionDescribes the configuration of a player's source.
SpotXAdDescriptionDescribes a SpotX ad break request.
SpotxDataA record of SpotX query string parameters. Each entry contains the parameter name with associated value.
SpotxQueryParameterA record of SpotX query string parameters which can be a nested structure. Each entry contains the parameter name with associated value.
StreamOneConfigurationDescribes the configuration of the Stream One integration.
TextTrackRepresents a text track of a media resource.
TextTrackCueRepresents a cue of a text track.
TextTrackCueEventMapThe events fired by the TextTrackCue.
TextTrackCueListList of text track cues.
TextTrackDescriptionDescribes the configuration of a side-loaded text track.
TextTracksListList of text tracks.
TextTrackStyleThe text track style API.
TextTrackStyleEventMapEvents fired by the TextTrackStyle API.
THEOplayerAdDescriptionDescribes an ad break request.
ThumbnailResolutionRepresents the resolution of a Verizon Media thumbnail.
TitaniumDRMConfigurationDescribes the configuration of the Titanium DRM integration.
TokenBasedTitaniumDRMConfigurationDescribes the configuration of the Titanium DRM integration with token-based authentication.
TrackRepresents a track of a media resource.
TrackEventMapThe events fired by a Track.
TrackListList of tracks.
TrackListEventMapThe events fired by a TrackList.
TTMLCueRepresents a cue of a TTML text track.
TypedSourceRepresents a media resource characterized by a URL to the resource and optionally information about the resource.
UIConfigurationDescribes the UI configuration of the player.
UIPlayerConfigurationDescribes the UI related configuration of the player.
UIRelatedContentThe related content UI API which can be used to toggle UI components.
UIRelatedContentEventMapThe events fired by the related content API (with ui).
UpdateQualityEventFired when the quality updates.
UplynkDRMConfigurationDescribes the configuration of the Uplynk DRM integration.
UpNextBarA bar which displays the up next source.
UpNextManagerThe up next API.
UpNextPanelA panel which displays the up next source.
UpNextSourceDescribes an up next source.
VendorCastCommon API for all cast integrations.
VendorCastEventMapThe events fired by the common vendor APIs.
VerimatrixDRMConfigurationDescribes the configuration of the Veramatrix DRM integration.
VerizonMediaThe Verizon Media API.
VerizonMediaAdRepresents a Verizon Media ad.
VerizonMediaAdBeginEventFired when an ad begins.
VerizonMediaAdBreakRepresents a Verizon Media ad.
VerizonMediaAdBreakBeginEventFired when the ad break begins.
VerizonMediaAdBreakEndEventFired when the ad break ends.
VerizonMediaAdBreakEventMapThe events fired by the VerizonMediaAdBreak.
VerizonMediaAdBreakListList with Verizon Media ad breaks.
VerizonMediaAdBreakListEventMapThe events fired by the VerizonMediaAdBreakList.
VerizonMediaAdBreakSkipEventFired when the ad break is skipped.
VerizonMediaAdCompleteEventFired when the ad is completed.
VerizonMediaAddAdBreakEventFired when the ad break is added.
VerizonMediaAddAssetEventFired when an asset is added.
VerizonMediaAdEndEventFired when the ad ends.
VerizonMediaAdEventMapThe events fired by the VerizonMediaAd.
VerizonMediaAdFirstQuartileEventFired when the ad reaches the first quartile.
VerizonMediaAdListList of Verizon Media ads.
VerizonMediaAdListEventMapEvents fired by the VerizonMediaAdList.
VerizonMediaAdMidpointEventFired when the ad reaches the mid point.
VerizonMediaAdsThe Verizon Media ads API.
VerizonMediaAdThirdQuartileEventFired when the ad reaches the third quartile.
VerizonMediaAssetRepresents a Verizon Media asset.
VerizonMediaAssetEventMapThe events fired by the VerizonMediaAssetList.
VerizonMediaAssetInfoResponseRepresents a Verizon Media Asset Info Response.
VerizonMediaAssetInfoResponseEventFired when an asset info response is received.
VerizonMediaAssetListList of Verizon Media assets.
VerizonMediaConfigurationDescribes the configuration of the Verizon Media integration.
VerizonMediaEventMapThe events fired by the Verizon Media API.
VerizonMediaExternalIdRepresents a combination of user identifier and one or more external identifiers for Verizon Media assets.
VerizonMediaPingConfigurationDescribes the configuration of Verizon Media Ping features.
VerizonMediaPingErrorEventFired when an error or invalid response is received from the Ping API.
VerizonMediaPingResponseRepresents a Verizon Media Ping response.
VerizonMediaPingResponseEventFired when a Ping response is received.
VerizonMediaPreplayBaseResponseRepresents a Verizon Media Preplay base response.
VerizonMediaPreplayLiveResponseRepresents a Verizon Media Preplay response for live assets.
VerizonMediaPreplayResponseEventFired when a Preplay response is received.
VerizonMediaPreplayVodResponseRepresents a Verizon Media Preplay response for VOD assets.
VerizonMediaRemoveAdBreakEventFired when the ad break is removed.
VerizonMediaRemoveAdEventFired when the ad is removed.
VerizonMediaRemoveAssetEventFired when an asset is removed.
VerizonMediaResponseDrmRepresents a Verizon Media DRM response.
VerizonMediaResponseLiveAdRepresents a Verizon Media response with live ads.
VerizonMediaResponseLiveAdBreakRepresents a Verizon Media response for live ad breaks.
VerizonMediaResponseLiveAdsRepresents a Verizon Media response with advertisement information for live assets.
VerizonMediaResponseVodAdThe Verizon Media response with ad information for VOD assets.
VerizonMediaResponseVodAdBreakRepresents a Verizon Media response with ad break information for VOD assets.
VerizonMediaResponseVodAdBreakOffsetRepresents the offset of a Verizon Media ad break.
VerizonMediaResponseVodAdPlaceholderRepresents a Verizon Media response with a placeholder for an ad for VOD assets.
VerizonMediaResponseVodAdsRepresents a Verizon Media response with advertisement information for VOD assets.
VerizonMediaSourceRepresents a media resource which is found on the Verizon Media Platform.
VerizonMediaUiConfigurationDescribes the UI configuration of the Verizon Media integration.
VerizonMediaUpdateAdBreakEventFired when the ad break is updated.
VideoQualityRepresents a quality of a video track.
VimondDRMConfigurationDescribes the configuration of the Vimond DRM integration.
VisibilityThe visibility API.
VisibilityObserverRepresents a visibility observer.
VRThe virtual reality API which allows you to control the display of 360° VR videos.
VRConfigurationDescribes the configuration of the virtual reality feature of a source.
VRDirectionRepresents a direction in the VR feature.
VREventMapThe events fired by the VR API.
VudrmDRMConfigurationDescribes the configuration of the Vudrm DRM integration.
WebAudioThe Web Audio API.
WebVTTCueRepresents a cue of a WebVTT text track.
WebVTTRegionRepresents a WebVTT region.
WidevineKeySystemConfigurationDescribes the Widevine key system configuration.
XstreamDRMConfigurationDescribes the configuration of the Xstream DRM integration.
YospaceThe Yospace API.
YospaceCallbackObjectRepresents the collection of standard callback functions for a Yospace SessionManager.
YospaceEventMapThe events fired by the Yospace API.
YospaceServerSideAdInsertionConfigurationRepresents a configuration for server-side ad insertion with the Yospace pre-integration.
YospaceTypedSourceRepresents a media resource with a Yospace server-side ad insertion request.
YouboraOptionsDescribes the options of the Youbora integration.

Variables

VariableDescription
cacheThe global cache API.
castThe global cast API.
featuresThe features included in the THEOplayer SDK.
playersList of players.
versionThe version of the THEOplayer SDK.

Type Aliases

Type AliasDescription
ABRStrategyThe adaptive bitrate stratey.
ABRStrategyTypeThe 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.
AdIntegrationKindThe 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.
AdPreloadTypeThe ad preloading strategy, represented by a value from the following list:
- 'none': Ads are not preloaded.
- 'midroll-and-postroll': Mid- and postrolls are preloaded.
AdReadyStateThe ad readiness state, represented by a value from the following list:
- 'none': The ad not loaded state.
- 'ready': The ad loaded state.
AdSourceTypeThe 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.
AgamaAnalyticsIntegrationIDThe identifier of the Agama integration.
AgamaLogLevelTypeThe type of log level for the Agama integration, represented by a value from the following list:
- 'info'
- 'debug'
- 'warning'
- 'error'
- 'fatal'
AgamaServiceNameThe service name, represented by a value from the following list:
- 'live'
- 'svod'
- 'nvod'
- 'tvod'
- 'avod'
- 'catchuptv'
AgamaStreamTypeThe stream type, represented by a value from the following list:
- 'live'
- 'vod'
AnalyticsIntegrationIDThe 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
AxinomIntegrationIDThe identifier of the Axinom integration.
AzureIntegrationIDThe identifier of the Azure Media Services integration.
BoundaryA 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.
CacheStatusThe 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.
CacheTaskStatusThe 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.
CastStateThe 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.
ChromecastMetadataTypeThe Chromecast's metadata type, represented by a value from the following list:
- 'movie'
- 'audio'
- 'tv-show'
- 'generic'
ComcastIntegrationIDThe identifier of the Comcast integration.
ConaxIntegrationIDThe identifier of the Conax integration.
ContentProtectionRequestSubTypeThe 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'
ConvivaAnalyticsIntegrationIDThe identifier of the Conviva integration.
CrossOriginSettingThe 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'
DAIAvailabilityTypeThe 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.
DeliveryTypeThe 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.
DirectionChangeEventFired when the VR.direction changes.
DRMIntegrationIdThe 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'
DRMProcessorA function which processes DRM data.
DRMTodayIntegrationIDThe identifier of the DRM Today integration.
EdgeStyleThe style of the edge, represented by a value from the following list:
- 'none'
- 'dropshadow'
- 'raised'
- 'depressed'
- 'uniform'
ErrorCodeThe chromecast error code, represented by a value from the following list:
- 'CANCEL': The operation was canceled by the user.
- 'TIMEOUT': The operation timed out.
- 'API_NOT_INITIALIZED': The API is not initialized.
- 'INVALID_PARAMETER': The parameters to the operation were not valid.
- 'EXTENSION_NOT_COMPATIBLE': The API script is not compatible with the installed Cast extension.
- 'EXTENSION_MISSING': The Cast extension is not available.
- 'RECEIVER_UNAVAILABLE': No receiver was compatible with the session request.
- 'SESSION_ERROR': A session could not be created, or a session was invalid.
- 'CHANNEL_ERROR': A channel to the receiver is not available.
- 'LOAD_MEDIA_FAILED': Load media failed.
EventListenerThe function to be executed when an event occurred.
EventMapA record used to map events. Each entry contains an event name with associated event interface.
ExpressPlayIntegrationIDThe identifier of the ExpressPlay integration.
EzdrmIntegrationIDThe identifier of the Ezdrm integration.
FreeWheelAdUnitTypeThe 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.
GoogleDAISSAIIntegrationIDThe identifier of the Google DAI integration.
ID3FrameThe possible types of an ID3 frame.
ImagineSSAIIntegrationIDThe identifier of the Imagine integration.
IrdetoIntegrationIDThe identifier of the Irdeto integration.
JoinStrategyThe 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.
KeyOSIntegrationIDThe identifier of the KeyOS integration.
LicenseTypeThe type of the licence, represented by a value from the following list :
- 'temporary'
- 'persistent'
MediaErrorCodeThe 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.
MediaTypeThe media's type, represented by a value from the following list:
- 'audio'
- 'video'
- 'text'
- 'image'
- Empty string ('') when the media type is unknown
MoatAnalyticsIntegrationIDThe identifier of the Moat integration.
MutedAutoplayConfigurationThe 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.)
NodeStyleVoidCallbackA Node-style asynchronous callback.After all asynchronous work is done, the callback *must* call done, optionally passing an error argument.
PiPPositionThe picture-in-picture position, represented by a value from the following list:
- 'top-left'
- 'top-right'
- 'bottom-left'
- 'bottom-right'
PreloadTypeThe 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.
PresentationModeThe 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).
RelatedChangeEventFired when RelatedContent.sources changes.
RelatedHideEventFired when the related content panel is hidden.
RelatedShowEventFired when the related content panel is shown.
RequestBodyThe possible types of an HTTP request body.
RequestInterceptorThe 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.
RequestLikeThe possible types representing an HTTP request.
RequestMethodThe request's type, represented by a value from the following list:
- 'GET'
- 'HEAD'
- 'POST'
- 'PUT'
- 'DELETE'
- 'OPTIONS'
RequestSubTypeThe request's subtype, represented by a value from the following list:
- 'initialization-segment'
- Any value of ContentProtectionRequestSubType
RequestTypeThe request's type, represented by a value from the following list:
- 'manifest'
- 'segment'
- 'content-protection'
ResponseBodyThe possible types of an HTTP response body.
ResponseInterceptorThe 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.
ResponseLikeThe possible types representing an HTTP response.
ResponseTypeThe response's type, represented by a value from the following list:
- 'arraybuffer'
- 'blob'
- 'document'
- 'json'
- 'stream'
- 'text'
SkippedAdStrategyThe 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.
SmartSightIntegrationIDThe identifier of the Media Melon SmartSight integration.
SourceRepresents a media resource.
SourceIntegrationIdThe 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
SourcesA media resource or list of media resources.
SSAIIntegrationIdThe 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
StateChangeEventFired when the VR.state changes.
StereoChangeEventFired when the VR.stereo changes.
StreamOneAnalyticsIntegrationIDThe identifier of the Stream One integration.
StringKeyOfHelper type to extract string keys from type objects.
StylePropertyRecordRecord of style properties. Each entry contains the style property name with associated value.
TextTrackReadyStateThe 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.
TextTrackTypeThe 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.
TitaniumIntegrationIDThe identifier of the Titanium integration.
UILanguageA record used to map localization. Each entry contains a translation of an English string.
UplynkIntegrationIDThe identifier of the Uplynk integration.
VerimatrixIntegrationIDThe identifier of the Verimatrix integration.
VerizonMediaAssetIdRepresents a unique asset identifier for a Verizon Media asset.
VerizonMediaAssetMovieRatingThe 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)
VerizonMediaAssetTvRatingThe 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)
VerizonMediaAssetTypeThe 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.
VerizonMediaPreplayResponseType of a Verizon Media Preplay response.
VimondIntegrationIDThe identifier of the Vimond integration.
VisibilityObserverCallbackA callback for a visibility observer.
VoidPromiseCallbackAn promise-returning asynchronous callback.The callback *must* return a promise that resolves (or rejects) after all asynchronous work is done.
VPAIDModeThe 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.
VRStateThe state of the VR feature, represented by a value from the following list:
- 'unavailable'
- 'available'
- 'presenting'
VRStereoModeThe 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.
VTTAlignSettingA 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.
VTTDirectionSettingA 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.
VTTLineA 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.
VTTLineAlignSettingA 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.
VTTPositionA 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.
VTTPositionAlignSettingA 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.
VTTScrollSettingA 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.
VudrmIntegrationIDThe identifier of the Vudrm integration.
WaitUntilCallbackAn asynchronous callback to delay a request or response.
XstreamIntegrationIDThe identifier of the Xstream integration.
YospaceIdThe 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.
YospaceSSAIIntegrationIDThe identifier of the Yospace integration.
YospaceStreamTypeThe 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.
YouboraAnalyticsIntegrationIDThe identifier of the Youbora integration.