Bitmovin Player API 8.268.0
    Preparing search index...

    Interface SgaiAdBreak

    interface SgaiAdBreak {
        adCreativeSignaling?: SgaiAdTrackerData;
        ads?: SgaiLinearAd[];
        customAdTrackingInfo?: any;
        id: string;
        replaceContentDuration?: number;
        restrictions?: PlaybackRestrictions;
        scheduleTime: number;
        totalPlannedDuration?: number;
    }

    Hierarchy (View Summary)

    Index
    adCreativeSignaling? ads? customAdTrackingInfo? id replaceContentDuration? restrictions? scheduleTime totalPlannedDuration?
    adCreativeSignaling?: SgaiAdTrackerData

    Ad creative signaling data for the ad break. Top level ad creative signaling present in ASSET-LIST applicable to the entire ad break. For ASSET-URI, this value is present on DATE-RANGE level.

    Parsed based on SVTA spec

    ads?: SgaiLinearAd[]

    The list of ads to be played during this ad break.

    Overrides the ads property type inherited from AdBreak.

    customAdTrackingInfo?: any

    Custom ad tracking information for the ad break.

    id: string

    The id of the corresponding AdBreakConfig. If the AdBreak was generated out of a VMAP tag, then the ID present in the VMAP tag will be taken. If none is present in the VMAP tag, it will be generated.

    replaceContentDuration?: number

    Specifies how many seconds the ad break(s) should replace of the main video content.

    restrictions?: PlaybackRestrictions

    Playback restrictions to apply during ad playback (e.g., seeking, playback rate changes).

    scheduleTime: number

    The time in seconds in the media timeline the AdBreak is scheduled for.

    totalPlannedDuration?: number

    The total duration the ad break is expected to play for.

    Settings
    Member Visibility

    On This Page
    Properties