OptiView Ads SDK
    Preparing search index...

    Interface THEOplayerLike

    Minimum surface of a THEOplayer ChromelessPlayer that THEOplayerAdapter depends on. A real ChromelessPlayer from the theoplayer package satisfies this interface; the THEO*Like member types name the parts of its TextTrackList, MediaTrack and LatencyManager the adapter reads.

    interface THEOplayerLike {
        addEventListener(type: string, listener: (event: unknown) => void): void;
        currentProgramDateTime: Date | null;
        currentTime: number;
        destroy(): void;
        duration: number;
        latencyManager?: THEOLatencyManagerLike;
        muted: boolean;
        network?: THEONetworkLike;
        pause(): void;
        paused: boolean;
        play(): void;
        playbackRate?: number;
        removeEventListener(type: string, listener: (event: unknown) => void): void;
        seekable?: {
            end(index: number): number;
            length: number;
            start?(index: number): number;
        };
        seeking?: boolean;
        source: | {
            liveOffset?: number;
            sources?: readonly { liveOffset?: number; src?: string; type?: string }[];
        }
        | null
        | undefined;
        textTracks?: THEOTextTracksLike;
        videoTracks?: ArrayLike<THEOMediaTrackLike>;
        volume: number;
    }
    Index
    currentProgramDateTime currentTime duration latencyManager? muted network? paused playbackRate? seekable? seeking? source textTracks? videoTracks? volume
    addEventListener destroy pause play removeEventListener
    currentProgramDateTime: Date | null

    The program date time at the playback position, or null when the stream carries none.

    currentTime: number

    Playback position in seconds; assign to seek.

    duration: number

    Media duration in seconds; Infinity for a live stream.

    latencyManager?: THEOLatencyManagerLike

    Live-latency controller; absent on builds or sources without live playback.

    muted: boolean

    Whether audio is muted.

    network?: THEONetworkLike

    Network interceptors; the adapter reads DASH manifests to place emsg cues by PTS. Optional.

    paused: boolean

    Whether playback is paused.

    playbackRate?: number

    Playback rate, 1 being normal. THEOplayer's latency manager drives this itself.

    seekable?: {
        end(index: number): number;
        length: number;
        start?(index: number): number;
    }

    THEOplayer's OWN seekable range. Distinct from the <video> element's, which reports an unbounded sentinel on live — see the seekableEnd getter.

    Type Declaration

    • end: function
      • end(index: number): number

        The end of the seekable range at index, in seconds.

        Parameters

        • index: number

        Returns number

    • Readonlylength: number

      The number of seekable ranges.

    • start?: function
      • start?(index: number): number

        The start of the seekable range at index, in seconds, when supported.

        Parameters

        • index: number

        Returns number

    seeking?: boolean

    True while a seek is in flight (no seeked yet). Optional on older builds.

    source:
        | {
            liveOffset?: number;
            sources?: readonly { liveOffset?: number; src?: string; type?: string }[];
        }
        | null
        | undefined

    Set to load a new source.

    Type Declaration

    • {
          liveOffset?: number;
          sources?: readonly { liveOffset?: number; src?: string; type?: string }[];
      }
      • OptionalliveOffset?: number

        Description-wide live offset; a typed source's own value takes precedence.

      • Optionalsources?: readonly { liveOffset?: number; src?: string; type?: string }[]

        The source descriptions, first match wins.

    • null
    • undefined
    textTracks?: THEOTextTracksLike

    Text-track list; metadata tracks carry in-stream ID3/emsg cues. Optional.

    videoTracks?: ArrayLike<THEOMediaTrackLike>

    Video rendition ladder; absent on builds or sources without selectable qualities.

    volume: number

    Audio volume from 0 to 1.

    • Subscribe to a player event such as timeupdate or ended.

      Parameters

      • type: string
      • listener: (event: unknown) => void

      Returns void

    • Release the player and its <video> element.

      Returns void

    • Pause playback.

      Returns void

    • Start or resume playback.

      Returns void

    • Remove a listener added with addEventListener.

      Parameters

      • type: string
      • listener: (event: unknown) => void

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods