logo

THEOplayer > AdDescription

AdDescription interface

Describes an ad break request.

Signature:

export interface AdDescription 

Properties

Property

Type

Description

integration (optional)

AdIntegrationKind

The integration of the ad break.

replaceContent (optional)

boolean

Whether the ad replaces playback of the content.

sources (optional)

string | AdSource

A source which contains the location of ad resources to be scheduled.

timeOffset (optional)

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.

Property Details

integration

The integration of the ad break.

Signature:

integration?: AdIntegrationKind;

replaceContent

Whether the ad replaces playback of the content.

Signature:

replaceContent?: boolean;

Remarks


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

sources

A source which contains the location of ad resources to be scheduled.

Signature:

sources?: string | AdSource;

Remarks


- Important: This should *not* be an array of sources.
- VPAID support is limited to the 'google-ima' integration.
- Not specifying this property should only happen when using a third party ad integration that uses an other system of specifying which ads to schedule

timeOffset

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.

Signature:

timeOffset?: string | number;

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.

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