THEOplayer Web SDK
    Preparing search index...

    Interface AdBreak

    Represents an ad break in the VMAP specification or an ad pod in the VAST specification.

    interface AdBreak {
        ads: Ad[] | undefined;
        customData: unknown;
        id: string | undefined;
        integration: CustomAdIntegrationKind | AdIntegrationKind | undefined;
        maxDuration: number | undefined;
        maxRemainingDuration: number | undefined;
        timeOffset: number;
    }
    Index

    Properties

    ads customData id integration maxDuration maxRemainingDuration timeOffset

    Properties

    ads: Ad[] | undefined

    List of ads which will be played sequentially at the ad break's time offset.

    customData: unknown

    Additional integration-specific data associated with this ad.

    id: string | undefined

    The identifier of the ad break.


    - For THEOads, this is the interstitial identifier.
    - For Google IMA & DAI, this is the pod index of the ad break.
    - For other integrations, this may be undefined.

    integration: CustomAdIntegrationKind | AdIntegrationKind | undefined

    The integration of the ad break, represented by a value from AdIntegrationKind or the identifier of a custom integration registered with Ads.registerServerSideIntegration.


    - The 'theo' integration naming is deprecated and has been replaced with 'csai'.

    maxDuration: number | undefined

    The duration of the ad break, in seconds.


    - Ads are lazily loaded. This property becomes available when all ads are loaded.

    maxRemainingDuration: number | undefined

    The remaining duration of the ad break, in seconds.


    - Ads are lazily loaded. This property becomes available when all ads are loaded.
    - This feature is not available in the Google IMA integration and will default to -1.

    timeOffset: number

    The time offset at which content will be paused to play the ad break, in seconds.

    Settings

    Member Visibility

    On This Page

    Properties