logo

THEOplayer > AdBreak

AdBreak interface

Represents an ad break in the VMAP specification or an ad pod in the VAST specification.

Signature:

export interface AdBreak 

Properties

Property

Type

Description

ads

Ad[] | undefined

List of ads which will be played sequentially at the ad break's time offset.

integration

string | undefined

The integration of the ad break, represented by a value from the following list:
- 'theo'
- 'google-ima'
- 'google-dai'
- 'freewheel'

maxDuration

number | undefined

The duration of the ad break, in seconds.

maxRemainingDuration

number | undefined

The remaining duration of the ad break, in seconds.

timeOffset

number

The time offset at which content will be paused to play the ad break, in seconds.

Property Details

ads

List of ads which will be played sequentially at the ad break's time offset.

Signature:

ads: Ad[] | undefined;

integration

The integration of the ad break, represented by a value from the following list:
- 'theo'
- 'google-ima'
- 'google-dai'
- 'freewheel'

Signature:

integration: string | undefined;

maxDuration

The duration of the ad break, in seconds.

Signature:

maxDuration: number | undefined;

Remarks


- Ads are lazily loaded. This property becomes available when all ads are loaded.

maxRemainingDuration

The remaining duration of the ad break, in seconds.

Signature:

maxRemainingDuration: number | undefined;

Remarks


- Ads are lazily loaded. This property becomes available when all ads are loaded.
- This feature is not available in the Google IMA integration and will default to -1.

timeOffset

The time offset at which content will be paused to play the ad break, in seconds.

Signature:

timeOffset: number;
github
Make sure to follow us on GitHub!
THEO-logo-white
twitter
facebook
linkedin
Copyright © 2020. All Rights Reserved.
Leuven
New York
Singapore
Barcelona