THEOplayer Web SDK
    Preparing search index...

    Interface OverlayInterstitial

    The THEOads interstitial that corresponds with overlay playback.

    interface OverlayInterstitial {
        adTagParameters: Record<string, string>;
        clickThrough: undefined | string;
        duration: undefined | number;
        id: string;
        imageUrl: undefined | string;
        position: OverlayPosition;
        size: OverlaySize;
        startTime: number;
        type: "overlay";
    }

    Hierarchy (View Summary)

    Index

    Properties

    adTagParameters clickThrough duration id imageUrl position size startTime type

    Properties

    adTagParameters: Record<string, string>

    The ad tag parameters that are used for this specific ad break.


    - The set values are combined and potentially override parameters set on the TheoAdDescription.adTagParameters or through TheoAds.replaceAdTagParameters.

    clickThrough: undefined | string

    The clickThrough url of the overlay.

    duration: undefined | number

    The duration of the interstitial, in seconds.

    id: string

    The identifier of the interstitial.

    imageUrl: undefined | string

    The url of the image of the overlay.

    position: OverlayPosition

    The position of the overlay.

    size: OverlaySize

    The size of the overlay.

    startTime: number

    The start time at which the interstitial will start.

    type: "overlay"

    The type of the interstitial.

    Settings

    Member Visibility

    On This Page

    Properties