Version: 2.67.0

Ads

THEOplayer > Ads

Ads interface

Inherits from EventDispatcher<AdsEventMap> . See parent page for inherited properties and methods.

The API for advertisements.

Signature:
export interface Ads extends EventDispatcher<AdsEventMap>

Properties

Property

Type

Description

currentAdBreak

AdBreak

The currently playing ad break.

currentAds

Ad

List of currently playing ads.

playing

boolean

Whether a linear ad is currently playing.

scheduledAdBreaks

AdBreak

List of ad breaks which still need to be played.

scheduledAds

Ad

List of ads which still need to be played.

Methods

Method

Description

schedule(adDescription)

Add an ad break request.

skip()

Skip the current linear ad.

Remarks


- Integrates with `'theo'`, `'google-ima'`, `'google-dai'` or `'freewheel'`.