THEOplayer Web SDK
    Preparing search index...

    Interface AdBreakInterstitial

    The THEOads interstitial that corresponds with ad playback.

    interface AdBreakInterstitial {
        ads: readonly Ad[];
        adTagParameters: Record<string, string>;
        backdropUri: undefined | string;
        duration: undefined | number;
        id: string;
        layout: TheoAdsLayout;
        startTime: number;
        type: "adbreak";
    }

    Hierarchy (View Summary)

    Index

    Properties

    ads adTagParameters backdropUri duration id layout startTime type

    Properties

    ads: readonly Ad[]

    The ads that are part of the interstitial.


    • - Only available during ad playback.
    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.

    backdropUri: undefined | string

    The background when playing an ad.


    • This is only available when playing in double or l-shape layout.
    duration: undefined | number

    The duration of the interstitial, in seconds.

    id: string

    The identifier of the interstitial.

    layout: TheoAdsLayout

    The layout which is used to play the ads of the interstitial.

    startTime: number

    The start time at which the interstitial will start.

    type: "adbreak"

    The type of the interstitial.

    Settings

    Member Visibility

    On This Page

    Properties