Bitmovin Player API 8.280.0
    Preparing search index...

    Interface AdBreak

    interface AdBreak {
        ads?: Ad[];
        id: string;
        position: string;
        replaceContentDuration?: number;
        scheduleTime: number;
    }

    Hierarchy (View Summary)

    Index
    ads? id position replaceContentDuration? scheduleTime
    ads?: Ad[]

    The ads scheduled for this AdBreak.

    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.

    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.

    Settings
    Member Visibility

    On This Page
    Properties