logo

THEOplayer > THEOplayerAdDescription

THEOplayerAdDescription interface

Inherits from AdDescription . See parent page for inherited properties and methods.

Describes an ad break request.

Signature:

export interface THEOplayerAdDescription extends AdDescription 

Properties

Property

Type

Description

skipOffset (optional)

string | number

Offset after which the ad break can be skipped.

sources

string | AdSource

The source of the ad

Property Details

skipOffset

Offset after which the ad break can be skipped.

Signature:

skipOffset?: 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.

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.

sources

The source of the ad

Signature:

sources: string | AdSource;

Remarks


- Only supports VAST and VMAP.

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