Bitmovin Player API 8.277.0
    Preparing search index...

    Interface ImaAdBreak

    Ad break returned by the IMA advertising module.

    interface ImaAdBreak {
        ads?: Ad[];
        discardAfterPlayback?: boolean;
        fallbackTags?: AdTag[];
        id: string;
        linearAdUiConfig?: LinearAdUiConfig;
        passthroughMode?: ImaPassthroughMode;
        persistent?: boolean;
        position: string;
        preloadOffset?: number;
        replaceContentDuration?: number;
        scheduleTime: number;
        tag: AdTag;
        trackingEvents?: VmapTrackingEvent[];
        vastResponse?: Promise<VastResponse>;
    }

    Hierarchy (View Summary)

    Index
    ads? discardAfterPlayback? fallbackTags? id linearAdUiConfig? passthroughMode? persistent? position preloadOffset? replaceContentDuration? scheduleTime tag trackingEvents? vastResponse?
    ads?: Ad[]

    The ads scheduled for this AdBreak.

    discardAfterPlayback?: boolean

    Specifies whether ad breaks are discarded after they are played back, played over or tried to be played back but failed due to some condition. When set to false, ad breaks are played again when seeking back to a previous ad break position and never discarded in any of the above cases.

    The flag will be ignored when ImaAdTagConfig.passthroughMode is set to ImaPassthroughMode.VastAndVmap

    Default is true.

    fallbackTags?: AdTag[]

    Defines a list of fallback ad tags which will be tried one after the other if the original ad tag does not provide a valid response. The fallback ad tags need to have the same AdTagType as the main tag.

    id: string

    A unique identifier for the ad break.

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

    linearAdUiConfig?: LinearAdUiConfig

    Holds relevant information for the advertising UI.

    passthroughMode?: ImaPassthroughMode

    Indicates which ad tags should be downloaded by the IMA SDK instead of by the Player. This can be helpful if ad servers expect the IMA SDK to add some specific parameters to the request.

    persistent?: boolean

    If set, the ad tag will be processed and rescheduled automatically when a new source is loaded.

    position: string

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

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

    preloadOffset?: number

    Specifies how many seconds before the ad break would start playing should the ad tag (and if possible the media files of the resulting ad response) start pre-loading. Default is 0.

    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.

    tag: AdTag

    Defines the url and type of the ad manifest. If the tag is a VAST or VPAID manifest, then more specific scheduling options can be defined in the AdBreakConfig.

    trackingEvents?: VmapTrackingEvent[]

    Contains the extracted VMAP tracking URLs associated with the ad break.

    vastResponse?: Promise<VastResponse>

    The VAST response of the specified ad tag.

    Settings
    Member Visibility

    On This Page
    Properties