Interface SgaiAdBreak

interface SgaiAdBreak {
    adCreativeSignaling?: SgaiAdTrackerData;
    ads?: SgaiLinearAd[];
    customAdTrackingInfo?: any;
    id: string;
    replaceContentDuration?: number;
    restrictions?: PlaybackRestrictions;
    scheduleTime: number;
    totalPlannedDuration?: number;
}

Hierarchy (view full)

Properties

adCreativeSignaling? ads? customAdTrackingInfo? id replaceContentDuration? restrictions? scheduleTime totalPlannedDuration?

Properties

Optional adCreativeSignaling

adCreativeSignaling?: SgaiAdTrackerData

Ad creative signaling data for the ad break. Top level ad creative signaling present in ASSET-LIST applicable to the entire ad break. For ASSET-URI, this value is present on DATE-RANGE level.

Parsed based on SVTA spec

Optional ads

ads?: SgaiLinearAd[]

The list of ads to be played during this ad break.

Overrides the ads property type inherited from AdBreak.

Optional customAdTrackingInfo

customAdTrackingInfo?: any

Custom ad tracking information for the ad break.

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 replaceContentDuration

replaceContentDuration?: number

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

Optional restrictions

restrictions?: PlaybackRestrictions

Playback restrictions to apply during ad playback (e.g., seeking, playback rate changes).

scheduleTime

scheduleTime: number

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

Optional totalPlannedDuration

totalPlannedDuration?: number

The total duration the ad break is expected to play for.

Settings

Member Visibility

Theme

On This Page

adCreativeSignalingadscustomAdTrackingInfoidreplaceContentDurationrestrictionsscheduleTimetotalPlannedDuration