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: undefined | Ad[];
        customData: unknown;
        integration: undefined | CustomAdIntegrationKind | AdIntegrationKind;
        maxDuration: undefined | number;
        maxRemainingDuration: undefined | number;
        timeOffset: number;
    }
    Index

    Properties

    ads customData integration maxDuration maxRemainingDuration timeOffset

    Properties

    ads: undefined | Ad[]

    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.

    integration: undefined | CustomAdIntegrationKind | AdIntegrationKind

    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: undefined | number

    The duration of the ad break, in seconds.


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

    maxRemainingDuration: undefined | number

    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