THEOplayer Web SDK

The API references for THEOplayer Web SDK version 8.1.2.

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.

ABR

Ads

Analytics

Caching

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

Canvas

Allows drawing the video to a <canvas> element.

Casting

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

Clipping

Allows clipping the playback window of a source.

Content Protection

Allows playing content protected streams (DRM).

Errors

Events

AdBreakEvent AdBufferingEvent AdEvent AdMetadataEvent AdSkipEvent AddCachingTaskEvent AddTrackEvent AddViewEvent AdsManagerLoadedEvent 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

Media and Text Tracks

Multi-view

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

Network

Allows inspecting and intercepting HTTP requests made by the player.

Other

Player

SSAI

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

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 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

UI

VR

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

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