Bitmovin Player API 8.280.0
    Preparing search index...

    Interface SgaiAdBreak

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

    Hierarchy (View Summary)

    Index
    adCreativeSignaling? ads? customAdTrackingInfo? id position 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

    A unique identifier for the ad break.

    The value is either inherited from the corresponding AdBreakConfig id or extracted from a VMAP or interstitial tag. If no ID is present in a VMAP tag, one is generated.

    position: string

    Describes the position of the ad break relative to the main content.

    The value is either inherited from the corresponding AdBreakConfig position or, for SGAI ad breaks, inferred from the interstitial tag (e.g. 'pre', 'mid', 'post').

    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. This is NaN for pause-position ad breaks, which do not have a fixed position in the media timeline.

    totalPlannedDuration?: number

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

    Settings
    Member Visibility

    On This Page
    Properties