Interface CsaiAdDescription

Describes an ad break request.

interface CsaiAdDescription {
    integration?: "csai" | "theo";
    replaceContent?: boolean;
    skipOffset?: string | number;
    sources: string | AdSource;
    timeOffset?: string | number;
}

Hierarchy (view full)

Properties

integration? replaceContent? skipOffset? sources timeOffset?

Properties

Optional integration

integration?: "csai" | "theo"

The integration of the ad break.

Default Value

'csai'

Remarks


- The 'theo' integration naming is deprecated and has been replaced with 'csai'.

Optional replaceContent

replaceContent?: boolean

Whether the ad replaces playback of the content.

Remarks


- When the ad ends, the content will resume at the ad break's offset plus its duration.

Default Value


- true for live content,
- false for VOD content.

Optional skipOffset

skipOffset?: string | number

Offset after which the ad break can be skipped.

Remarks


- A timestamp which is not in the playback window will result in the ad break not being started.
- VMAP resources will ignore this value as they contain an internal offset.

Possible formats:
- A number for the offset in seconds.
- 'start' for a preroll.
- 'end' for a postroll.
- 'HH:MM:SS.mmm' for a timestamp in the playback window.
- A percentage string (XX%) for a proportion of the content duration.

Default Value

'start'

sources

sources: string | AdSource

The source of the ad

Remarks


- Only supports VAST and VMAP.

Optional timeOffset

timeOffset?: string | number

Offset after which the ad break will start.

Possible formats:
- A number for the offset in seconds.
- 'start' for a preroll.
- 'end' for a postroll.
- 'HH:MM:SS.mmm' for a timestamp in the playback window.
- A percentage string (XX%) for a proportion of the content duration.

Remarks


- A timestamp which is not in the playback window will result in the ad break not being started.
- VMAP resources will ignore this value as they contain an internal offset.
- Since 2.18, numbers are supported for the Google IMA integration, since 2.21 other formats as well.

Default Value

'start'

Settings

Member Visibility

Theme

On This Page

integrationreplaceContentskipOffsetsourcestimeOffset