THEOplayer Web SDK

The API references for THEOplayer Web SDK version 7.12.0.

Index

API

The classes, constants, functions and namespaces listed in this category can be found on the global THEOplayer variable when loading with a <script> tag, or as exports of the theoplayer package when loading through npm.

ChromelessPlayer MultiViewPlayer Player cache cast features playerSuiteVersion players utils version registerContentProtectionIntegration videojs

ABR

ABRConfiguration ABRMetadata ABRStrategyConfiguration SourceAbrConfiguration ABRStrategy ABRStrategyType

Ads

Ad AdBreak AdBreakEvent AdBreakInit AdBufferingEvent AdDescription AdEvent AdInit AdMetadataEvent AdSkipEvent AdSource Ads AdsConfiguration AdsEventMap CompanionAd CsaiAdDescription FreeWheelAdDescription FreeWheelCue Geo GoogleDAI GoogleImaAd GoogleImaConfiguration IMAAdDescription LinearAd MediaFile NonLinearAd ServerSideAdIntegrationController ServerSideAdIntegrationHandler SpotXAdDescription SpotxData SpotxQueryParameter UniversalAdId AdIntegrationKind AdPreloadType AdReadyState AdSourceType AdType CustomAdIntegrationKind DeliveryType FreeWheelAdUnitType ServerSideAdIntegrationFactory THEOplayerAdDescription VPAIDMode

Analytics

AgamaConfiguration AgamaPlayerConfiguration AgamaSourceConfiguration Analytics BufferedSegments Conviva ConvivaConfiguration ConvivaContentMetadata MediaMelonConfiguration MediaTailorSource Metrics MoatConfiguration SmartSightConfiguration StreamOneConfiguration YouboraOptions AgamaAnalyticsIntegrationID AgamaLogLevelType AgamaServiceName AgamaStreamType ConvivaAnalyticsIntegrationID MoatAnalyticsIntegrationID SmartSightIntegrationID StreamOneAnalyticsIntegrationID YouboraAnalyticsIntegrationID

Caching

Allows caching sources for offline playback. Requires the cache feature to be enabled.

AddCachingTaskEvent Cache CacheEventMap CachingTask CachingTaskEventMap CachingTaskLicense CachingTaskList CachingTaskListEventMap CachingTaskParameters RemoveCachingTaskEvent CacheStatus CacheTaskStatus cache

Canvas

Allows drawing the video to a <canvas> element.

Canvas VideoFrameCallbackMetadata VideoFrameRequestCallback

Casting

Allows playing on a remote device or TV, using Chromecast or AirPlay.

AirPlay Cast CastConfiguration CastEventMap CastStateChangeEvent Chromecast ChromecastConfiguration ChromecastConnectionCallback ChromecastError ChromecastErrorEvent ChromecastEventMap ChromecastMetadataDescription ChromecastMetadataImage GlobalCast GlobalChromecast VendorCast VendorCastEventMap CastState ChromecastErrorCode ChromecastMetadataType JoinStrategy cast

Clipping

Allows clipping the playback window of a source.

Clip ClipEventMap

Content Protection

Allows playing content protected streams (DRM).

AES128KeySystemConfiguration AxinomDRMConfiguration AzureDRMConfiguration CertificateResponse ClearkeyDecryptionKey ClearkeyKeySystemConfiguration ComcastDRMConfiguration ConaxDRMConfiguration ContentProtectionError ContentProtectionErrorEvent ContentProtectionIntegration ContentProtectionIntegrationFactory ContentProtectionRequest ContentProtectionResponse DRMConfiguration DRMTodayDRMConfiguration DeviceBasedTitaniumDRMConfiguration ExpressPlayDRMConfiguration EzdrmDRMConfiguration FairPlayKeySystemConfiguration IrdetoDRMConfiguration KeyOSDRMConfiguration KeyOSFairplayKeySystemConfiguration KeyOSKeySystemConfiguration KeySystemConfiguration LicenseRequest LicenseResponse PlayReadyKeySystemConfiguration TitaniumDRMConfiguration TokenBasedTitaniumDRMConfiguration UplynkDRMConfiguration VerimatrixDRMConfiguration VimondDRMConfiguration VudrmDRMConfiguration XstreamDRMConfiguration AxinomIntegrationID AzureIntegrationID CertificateRequest ComcastIntegrationID ConaxIntegrationID ContentProtectionErrorCode DRMTodayIntegrationID ExpressPlayIntegrationID EzdrmIntegrationID IrdetoIntegrationID KeyOSIntegrationID KeySystemId LicenseType TitaniumIntegrationID UplynkIntegrationID VerimatrixIntegrationID VimondIntegrationID VudrmIntegrationID WidevineKeySystemConfiguration XstreamIntegrationID registerContentProtectionIntegration

Errors

ErrorCategory ErrorCode ChromecastError ContentProtectionError ContentProtectionErrorEvent ErrorEvent MediaError THEOplayerError TextTrackError TextTrackErrorEvent ContentProtectionErrorCode MediaErrorCode TextTrackErrorCode ErrorCategory

Events

AdBreakEvent AdBufferingEvent AdEvent AdMetadataEvent AdSkipEvent AddCachingTaskEvent AddTrackEvent AddViewEvent CanPlayEvent CanPlayThroughEvent CastStateChangeEvent ContentProtectionErrorEvent CurrentSourceChangeEvent DimensionChangeEvent DurationChangeEvent EmptiedEvent EncryptedEvent EndedEvent ErrorEvent Event EventDispatcher ImagineTrackingEvent LayoutChangeEvent LoadedDataEvent LoadedMetadataEvent PauseEvent PlayEvent PlayingEvent PresentationModeChangeEvent ProgressEvent QualityEvent RateChangeEvent ReadyStateChangeEvent RemoveCachingTaskEvent RemoveTrackEvent RemoveViewEvent RepresentationChangeEvent SeekedEvent SeekingEvent SourceChangeEvent TargetQualityChangedEvent TextTrackAddCueEvent TextTrackCueChangeEvent TextTrackCueEnterEvent TextTrackCueExitEvent TextTrackCueUpdateEvent TextTrackEnterCueEvent TextTrackErrorEvent TextTrackExitCueEvent TextTrackReadyStateChangeEvent TextTrackRemoveCueEvent TextTrackTypeChangeEvent TextTrackUpdateCueEvent TimeUpdateEvent TrackChangeEvent TrackUpdateEvent UpdateQualityEvent VerizonMediaAdBeginEvent VerizonMediaAdBreakBeginEvent VerizonMediaAdBreakEndEvent VerizonMediaAdBreakSkipEvent VerizonMediaAdCompleteEvent VerizonMediaAdEndEvent VerizonMediaAdFirstQuartileEvent VerizonMediaAdMidpointEvent VerizonMediaAdThirdQuartileEvent VerizonMediaAddAdBreakEvent VerizonMediaAddAssetEvent VerizonMediaAssetInfoResponseEvent VerizonMediaPingErrorEvent VerizonMediaPingResponseEvent VerizonMediaRemoveAdBreakEvent VerizonMediaRemoveAssetEvent VerizonMediaUpdateAdBreakEvent ViewChangeEvent ViewPositionChangeEvent VolumeChangeEvent WaitingEvent DirectionChangeEvent EventListener EventMap RelatedChangeEvent RelatedHideEvent RelatedShowEvent StateChangeEvent StereoChangeEvent

HESP

HespApi HespApiEventMap HespLatencyConfiguration HespSourceConfiguration HespTypedSource HespMediaType

Media and Text Tracks

AddTrackEvent AudioQuality DateRangeCue EmsgCue EventStreamCue ID3AttachedPicture ID3BaseFrame ID3Comments ID3CommercialFrame ID3Cue ID3GenericEncapsulatedObject ID3InvolvedPeopleList ID3PositionSynchronisationFrame ID3PrivateFrame ID3SynchronizedLyricsText ID3TermsOfUse ID3Text ID3UniqueFileIdentifier ID3Unknown ID3UnsynchronisedLyricsTextTranscription ID3UrlLink ID3UserDefinedText ID3UserDefinedUrlLink ID3Yospace MediaTrack MediaTrackEventMap MediaTrackList Quality QualityEvent QualityEventMap QualityList RemoveTrackEvent Representation TTMLCue TargetQualityChangedEvent TextTrack TextTrackAddCueEvent TextTrackCue TextTrackCueChangeEvent TextTrackCueEnterEvent TextTrackCueEventMap TextTrackCueExitEvent TextTrackCueList TextTrackCueUpdateEvent TextTrackEnterCueEvent TextTrackError TextTrackErrorEvent TextTrackEventMap TextTrackExitCueEvent TextTrackReadyStateChangeEvent TextTrackRemoveCueEvent TextTrackStyle TextTrackStyleEventMap TextTrackTypeChangeEvent TextTrackUpdateCueEvent TextTracksList Track TrackChangeEvent TrackEventMap TrackList TrackListEventMap TrackUpdateEvent UpdateQualityEvent VideoQuality WebVTTCue WebVTTRegion AccessibilityRole EdgeStyle ID3Frame StylePropertyRecord TextTrackErrorCode TextTrackReadyState TextTrackType VTTAlignSetting VTTDirectionSetting VTTLine VTTLineAlignSetting VTTPosition VTTPositionAlignSetting VTTScrollSetting YospaceId

Multi-view

Allows playing multiple synchronised sources in a single player. Requires the multiview feature to be enabled.

MultiViewPlayer AddViewEvent LayoutChangeEvent MultiViewPlayerEventMap RemoveViewEvent View ViewChangeEvent ViewPositionChangeEvent MultiViewPlayerLayout

Network

Allows inspecting and intercepting HTTP requests made by the player.

HTTPHeaders InterceptableRequest InterceptableResponse MeasurableNetworkEstimator Network NetworkEstimator NetworkEstimatorController NetworkEventMap NetworkInterceptorController Request RequestInit RequestMeasurer ResponseInit ContentProtectionRequestSubType MediaType NodeStyleVoidCallback RequestBody RequestInterceptor RequestLike RequestMethod RequestSubType RequestType ResponseBody ResponseInterceptor ResponseLike ResponseType VoidPromiseCallback WaitUntilCallback

Other

Base64Util CommonUtils EnterBadNetworkModeEvent EventedList ExitBadNetworkModeEvent IntentToFallbackEvent List PublicationLoadStartEvent PublicationLoadedEvent PublicationOfflineEvent TheoLiveApi TheoLiveApiEventMap TheoLiveConfiguration TheoLivePublication TimeRanges BufferSource MaybeAsync StringKeyOf

Player

ChromelessPlayer Player LatencyConfiguration LatencyManager PlayerConfiguration PlayerEventMap PlayerList Presentation PresentationEventMap PresentationModeChangeEvent RetryConfiguration Visibility VisibilityObserver WebAudio MutedAutoplayConfiguration PreloadType PresentationMode VisibilityObserverCallback

SSAI

Allows playing streams with server-side ad insertion (SSAI).

GoogleDAIConfiguration GoogleDAILiveConfiguration GoogleDAITypedSource GoogleDAIVodConfiguration ID3Yospace Imagine ImagineEventMap ImagineServerSideAdInsertionConfiguration ImagineTrackingEvent ImagineTypedSource ServerSideAdInsertionConfiguration Yospace YospaceCallbackObject YospaceEventMap YospaceServerSideAdInsertionConfiguration YospaceTypedSource DAIAvailabilityType GoogleDAISSAIIntegrationID ImagineSSAIIntegrationID SSAIIntegrationId YospaceId YospaceSSAIIntegrationID YospaceStreamType

Source

AES128KeySystemConfiguration AnalyticsDescription AxinomDRMConfiguration AzureDRMConfiguration BaseSource ChromecastMetadataDescription ChromecastMetadataImage ClearkeyDecryptionKey ClearkeyKeySystemConfiguration ComcastDRMConfiguration ConaxDRMConfiguration DRMConfiguration DRMTodayDRMConfiguration DashPlaybackConfiguration DeviceBasedTitaniumDRMConfiguration ExpressPlayDRMConfiguration EzdrmDRMConfiguration FairPlayKeySystemConfiguration GoogleDAIConfiguration GoogleDAILiveConfiguration GoogleDAITypedSource GoogleDAIVodConfiguration HespSourceConfiguration HespTypedSource HlsPlaybackConfiguration ImagineServerSideAdInsertionConfiguration ImagineTypedSource IrdetoDRMConfiguration KeyOSDRMConfiguration KeyOSFairplayKeySystemConfiguration KeyOSKeySystemConfiguration KeySystemConfiguration MediaTailorSource MetadataDescription PlayReadyKeySystemConfiguration ServerSideAdInsertionConfiguration SourceAbrConfiguration SourceConfiguration SourceDescription SourceLatencyConfiguration TextTrackDescription TheoLiveSource TitaniumDRMConfiguration TokenBasedTitaniumDRMConfiguration TypedSource UplynkDRMConfiguration VerimatrixDRMConfiguration VerizonMediaExternalId VerizonMediaPingConfiguration VerizonMediaSource VimondDRMConfiguration VudrmDRMConfiguration XstreamDRMConfiguration YospaceServerSideAdInsertionConfiguration YospaceTypedSource AnalyticsIntegrationID AxinomIntegrationID AzureIntegrationID ChromecastMetadataType ComcastIntegrationID ConaxIntegrationID CrossOriginSetting DAIAvailabilityType DRMTodayIntegrationID ExpressPlayIntegrationID EzdrmIntegrationID GoogleDAISSAIIntegrationID HlsDiscontinuityAlignment ImagineSSAIIntegrationID IrdetoIntegrationID KeyOSIntegrationID KeySystemId LicenseType SSAIIntegrationId SeamlessPeriodSwitchStrategy SeamlessSwitchStrategy Source SourceIntegrationId Sources StreamType TitaniumIntegrationID UplynkIntegrationID VerimatrixIntegrationID VerizonMediaAssetId VerizonMediaAssetType VimondIntegrationID VudrmIntegrationID WidevineKeySystemConfiguration XstreamIntegrationID YospaceSSAIIntegrationID YospaceStreamType

UI

FullscreenOptions PiPConfiguration RelatedContent RelatedContentEventMap RelatedContentSource SocialSharing SocialSharingItem UIConfiguration UIPlayerConfiguration UIRelatedContent UIRelatedContentEventMap UpNextBar UpNextManager UpNextPanel UpNextSource UserActions PiPPosition RelatedChangeEvent RelatedHideEvent RelatedShowEvent UILanguage videojs

VR

Allows playing virtual reality (VR) streams. Requires the vr or vr-webxr feature to be enabled.

VR VRConfiguration VRDirection VREventMap VRPlayerConfiguration DirectionChangeEvent StateChangeEvent StereoChangeEvent VRPanoramaMode VRState VRStereoMode

Verizon Media

Allows playing Uplynk (formerly Verizon Media) SSAI streams. Requires the verizonmedia feature to be enabled.

BoundaryC3 BoundaryC7 BoundaryHalftime BoundaryInfo ThumbnailResolution VerizonMedia VerizonMediaAd VerizonMediaAdBeginEvent VerizonMediaAdBreak VerizonMediaAdBreakBeginEvent VerizonMediaAdBreakEndEvent VerizonMediaAdBreakEventMap VerizonMediaAdBreakList VerizonMediaAdBreakListEventMap VerizonMediaAdBreakSkipEvent VerizonMediaAdCompleteEvent VerizonMediaAdEndEvent VerizonMediaAdEventMap VerizonMediaAdFirstQuartileEvent VerizonMediaAdList VerizonMediaAdListEventMap VerizonMediaAdMidpointEvent VerizonMediaAdThirdQuartileEvent VerizonMediaAddAdBreakEvent VerizonMediaAddAssetEvent VerizonMediaAds VerizonMediaAsset VerizonMediaAssetEventMap VerizonMediaAssetInfoResponse VerizonMediaAssetInfoResponseEvent VerizonMediaAssetList VerizonMediaConfiguration VerizonMediaEventMap VerizonMediaExternalId VerizonMediaPingConfiguration VerizonMediaPingErrorEvent VerizonMediaPingResponse VerizonMediaPingResponseEvent VerizonMediaPreplayBaseResponse VerizonMediaPreplayLiveResponse VerizonMediaPreplayResponseEvent VerizonMediaPreplayVodResponse VerizonMediaRemoveAdBreakEvent VerizonMediaRemoveAdEvent VerizonMediaRemoveAssetEvent VerizonMediaResponseDrm VerizonMediaResponseLiveAd VerizonMediaResponseLiveAdBreak VerizonMediaResponseLiveAds VerizonMediaResponseVodAd VerizonMediaResponseVodAdBreak VerizonMediaResponseVodAdBreakOffset VerizonMediaResponseVodAdPlaceholder VerizonMediaResponseVodAds VerizonMediaSource VerizonMediaUiConfiguration VerizonMediaUpdateAdBreakEvent Boundary SkippedAdStrategy VerizonMediaAssetId VerizonMediaAssetMovieRating VerizonMediaAssetTvRating VerizonMediaAssetType VerizonMediaPreplayResponse VerizonMediaPreplayResponseType

Settings

Member Visibility

Theme