THEOplayer Web SDK
    Preparing search index...

    THEOplayer Web SDK

    The API references for THEOplayer Web SDK version 9.5.1.

    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
    players
    utils
    version
    registerContentProtectionIntegration
    videojs

    ABR

    ABRConfiguration
    ABRMetadata
    ABRStrategyConfiguration
    SourceAbrConfiguration
    ABRStrategy
    ABRStrategyType

    Ads

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

    Analytics

    AgamaConfiguration
    AgamaPlayerConfiguration
    AgamaSourceConfiguration
    BufferedSegments
    MediaMelonConfiguration
    MediaTailorSource
    Metrics
    MoatConfiguration
    SmartSightConfiguration
    StreamOneConfiguration
    YouboraOptions
    AgamaAnalyticsIntegrationID
    AgamaLogLevelType
    AgamaServiceName
    AgamaStreamType
    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
    DeviceBasedTitaniumDRMConfiguration
    DRMConfiguration
    DRMTodayDRMConfiguration
    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
    TextTrackError
    TextTrackErrorEvent
    THEOplayerError
    ContentProtectionErrorCode
    MediaErrorCode
    TextTrackErrorCode
    ErrorCategory

    Events

    AdBreakEvent
    AdBufferingEvent
    AddCachingTaskEvent
    AddTrackEvent
    AddViewEvent
    AdEvent
    AdMetadataEvent
    AdSkipEvent
    AdsManagerLoadedEvent
    CanPlayEvent
    CanPlayThroughEvent
    CastStateChangeEvent
    ContentProtectionErrorEvent
    CurrentSourceChangeEvent
    DimensionChangeEvent
    DurationChangeEvent
    EmptiedEvent
    EncryptedEvent
    EndedEvent
    ErrorEvent
    Event
    EventDispatcher
    InterstitialEvent
    LayoutChangeEvent
    LoadedDataEvent
    LoadedMetadataEvent
    Millicast
    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
    UplynkAdBeginEvent
    UplynkAdBreakBeginEvent
    UplynkAdBreakEndEvent
    UplynkAdBreakSkipEvent
    UplynkAdCompleteEvent
    UplynkAddAdBreakEvent
    UplynkAddAssetEvent
    UplynkAdEndEvent
    UplynkAdFirstQuartileEvent
    UplynkAdMidpointEvent
    UplynkAdThirdQuartileEvent
    UplynkAssetInfoResponseEvent
    UplynkPingErrorEvent
    UplynkPingResponseEvent
    UplynkRemoveAdBreakEvent
    UplynkRemoveAdEvent
    UplynkRemoveAssetEvent
    UplynkUpdateAdBreakEvent
    ViewChangeEvent
    ViewPositionChangeEvent
    VolumeChangeEvent
    WaitingEvent
    DirectionChangeEvent
    EventListener
    EventMap
    RelatedChangeEvent
    RelatedHideEvent
    RelatedShowEvent
    StateChangeEvent
    StereoChangeEvent

    HESP

    HespApi
    HespApiEventMap
    HespSourceConfiguration
    HespTypedSource
    HespMediaType

    Media and Text Tracks

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

    Millicast

    Allows playing Millicast live streams. Requires the millicast feature to be enabled.

    MillicastMetadataCue
    MillicastSource

    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
    MillicastEventMap
    MillicastStatsEvent
    PublicationLoadedEvent
    PublicationLoadStartEvent
    PublicationOfflineEvent
    TheoLiveApi
    TheoLiveApiEventMap
    TheoLiveConfiguration
    TheoLivePublication
    TimeRanges
    BufferSource
    MaybeAsync
    StringKeyOf
    TheoAdsLayout

    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
    ServerSideAdInsertionConfiguration
    DAIAvailabilityType
    GoogleDAISSAIIntegrationID
    SSAIIntegrationId
    YospaceId

    Source

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

    THEOads

    Allows playing THEOads streams. Requires the theoads feature to be enabled.

    AdBreakInterstitial
    Interstitial
    InterstitialEvent
    OverlayInterstitial
    OverlayPosition
    OverlaySize
    TheoAds
    TheoAdsEventsMap
    InterstitialType

    UI

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

    Uplynk

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

    BoundaryC3
    BoundaryC7
    BoundaryHalftime
    BoundaryInfo
    ThumbnailResolution
    Uplynk
    UplynkAd
    UplynkAdBeginEvent
    UplynkAdBreak
    UplynkAdBreakBeginEvent
    UplynkAdBreakEndEvent
    UplynkAdBreakEventMap
    UplynkAdBreakList
    UplynkAdBreakListEventMap
    UplynkAdBreakSkipEvent
    UplynkAdCompleteEvent
    UplynkAddAdBreakEvent
    UplynkAddAssetEvent
    UplynkAdEndEvent
    UplynkAdEventMap
    UplynkAdFirstQuartileEvent
    UplynkAdList
    UplynkAdListEventMap
    UplynkAdMidpointEvent
    UplynkAds
    UplynkAdThirdQuartileEvent
    UplynkAsset
    UplynkAssetEventMap
    UplynkAssetInfoResponse
    UplynkAssetInfoResponseEvent
    UplynkAssetList
    UplynkConfiguration
    UplynkEventMap
    UplynkExternalId
    UplynkPingConfiguration
    UplynkPingErrorEvent
    UplynkPingResponse
    UplynkPingResponseEvent
    UplynkPreplayBaseResponse
    UplynkPreplayLiveResponse
    UplynkPreplayResponseEvent
    UplynkPreplayVodResponse
    UplynkRemoveAdBreakEvent
    UplynkRemoveAdEvent
    UplynkRemoveAssetEvent
    UplynkResponseDrm
    UplynkResponseLiveAd
    UplynkResponseLiveAdBreak
    UplynkResponseLiveAds
    UplynkResponseVodAd
    UplynkResponseVodAdBreak
    UplynkResponseVodAdBreakOffset
    UplynkResponseVodAdPlaceholder
    UplynkResponseVodAds
    UplynkSource
    UplynkUiConfiguration
    UplynkUpdateAdBreakEvent
    Boundary
    SkippedAdStrategy
    UplynkAssetId
    UplynkAssetMovieRating
    UplynkAssetTvRating
    UplynkAssetType
    UplynkPreplayResponse
    UplynkPreplayResponseType

    VR

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

    VR
    VRConfiguration
    VRDirection
    VREventMap
    VRPlayerConfiguration
    DirectionChangeEvent
    StateChangeEvent
    StereoChangeEvent
    VRPanoramaMode
    VRState
    VRStereoMode