THEOplayer Web SDK
    Preparing search index...

    Interface ReadonlyLinearAdPlayerExperimental

    Read-only playback state of a linear ad player.

    ClientSideAdIntegrationController.linearAdPlayer

    interface ReadonlyLinearAdPlayer {
        currentTime: number;
        duration: number;
        ended: boolean;
        error: THEOplayerError | undefined;
        muted: boolean;
        paused: boolean;
        readyState: number;
        videoHeight: number;
        videoWidth: number;
        volume: number;
        addEventListener<TType extends keyof ReadonlyLinearAdPlayerEventMap>(
            type: TType | readonly TType[],
            listener: EventListener<ReadonlyLinearAdPlayerEventMap[TType]>,
        ): void;
        removeEventListener<TType extends keyof ReadonlyLinearAdPlayerEventMap>(
            type: TType | readonly TType[],
            listener: EventListener<ReadonlyLinearAdPlayerEventMap[TType]>,
        ): void;
    }

    Hierarchy (View Summary)

    Index
    currentTime duration ended error muted paused readyState videoHeight videoWidth volume
    addEventListener removeEventListener
    currentTime: number

    The current linear-ad playback position, in seconds.

    duration: number

    The duration of the loaded linear-ad source, in seconds.

    ended: boolean

    Whether the loaded linear-ad source has ended.

    error: THEOplayerError | undefined

    The current linear-ad playback error, or undefined if there is no error.

    muted: boolean

    Whether the linear ad is muted.

    paused: boolean

    Whether the linear ad player is paused.

    readyState: number

    The ready state of the linear ad, using the same values as ChromelessPlayer.readyState.

    videoHeight: number

    The height of the linear-ad video, or 0 if unknown.

    videoWidth: number

    The width of the linear-ad video, or 0 if unknown.

    volume: number

    The linear-ad volume, between 0 and 1.

    Settings
    Member Visibility

    On This Page
    Properties
    Methods