Interface AdBreakConfig

interface AdBreakConfig {
    discardAfterPlayback?: boolean;
    fallbackTags?: AdTag[];
    id: string;
    linearAdUiConfig?: LinearAdUiConfig;
    persistent?: boolean;
    position: string;
    preloadOffset?: number;
    replaceContentDuration?: number;
    tag: AdTag;
}

Hierarchy (view full)

Properties

discardAfterPlayback? fallbackTags? id linearAdUiConfig? persistent? position preloadOffset? replaceContentDuration? tag

Properties

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

Unique identifier of the ad break. Used to be able to identify and discard the ad break dynamically.

Optional linearAdUiConfig

linearAdUiConfig?: LinearAdUiConfig

Holds relevant information for the advertising UI.

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.

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.

Settings

Member Visibility

Theme

On This Page

discardAfterPlaybackfallbackTagsidlinearAdUiConfigpersistentpositionpreloadOffsetreplaceContentDurationtag