Represents an ad break which can be scheduled for playback.

One single AdItem can have multiple AdSources where all but the first act as fallback ad sources if the first one fails to load. The start and end of an ad break are signaled via AdBreakStartedEvent and AdBreakFinishedEvent.

interface AdItem {
    position?: string;
    preloadOffset?: number;
    sources: AdSource[];
}

Properties

position?: string

The playback position at which the ad break is scheduled to start. Default value is "pre".

Possible values are: • "pre": pre-roll ad (for VoD and Live streaming) • "post": post-roll ad (for VoD streaming only) • fractional seconds: "10", "12.5" (mid-roll ad, for VoD and Live streaming) • percentage of the entire video duration: "25%", "50%" (mid-roll ad, for VoD streaming only) • timecode hh:mm:ss.mmm: "00:10:30.000", "01:00:00.000" (mid-roll ad, for VoD streaming only)

preloadOffset?: number

The amount of seconds the ad manifest is loaded in advance compared to when the ad break is scheduled for playback.

Default value is 0.0

Platform

Android

sources: AdSource[]

The AdSources that make up this AdItem. The first ad source in this array is used as the main ad. Subsequent ad sources act as a fallback, meaning that if the main ad source does not provide a valid response, the subsequent ad sources will be utilized one after another.

The fallback ad sources need to have the same AdSourceType as the main ad source.