Version: 2.67.0

AdDescription

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.