BitmovinAdBreak | Bitmovin Player API 8.22.0

Hierarchy

AdBreak
AdBreakConfig
- BitmovinAdBreak

Index

Properties

Optional ads

ads: Ad[]

The ads scheduled for this AdBreak.

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 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.

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.