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 full)

Properties

ads? discardAfterPlayback? fallbackTags? id linearAdUiConfig? passthroughMode? persistent? position preloadOffset? replaceContentDuration? scheduleTime tag trackingEvents? vastResponse?

Properties

Optional ads

ads?: Ad[]

The ads scheduled for this AdBreak.

Optional discardAfterPlayback

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.

Optional fallbackTags

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

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.

Optional linearAdUiConfig

linearAdUiConfig?: LinearAdUiConfig

Holds relevant information for the advertising UI.

Optional passthroughMode

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.

Optional persistent

persistent?: boolean

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

position

position: string

Defines when the ad break shall be started. Default is 'pre'.

Allowed values are:

  • 'pre': pre-roll ad
  • 'post': post-roll ad
  • fractional seconds: '10', '12.5' (mid-roll ad)
  • percentage of the entire video duration: '25%', '50%' (mid-roll ad)
  • timecode [hh:mm:ss.mmm]: '00:10:30.000', '01:00:00.000' (mid-roll ad)

Optional preloadOffset

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.

Optional replaceContentDuration

replaceContentDuration?: number

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

scheduleTime

scheduleTime: number

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

tag

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.

Optional trackingEvents

trackingEvents?: VmapTrackingEvent[]

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

Optional vastResponse

vastResponse?: Promise<VastResponse>

The VAST response of the specified ad tag.

Settings

Member Visibility

Theme

On This Page

adsdiscardAfterPlaybackfallbackTagsidlinearAdUiConfigpassthroughModepersistentpositionpreloadOffsetreplaceContentDurationscheduleTimetagtrackingEventsvastResponse