logo

THEOplayer > AdsEventMap

AdsEventMap interface

The events fired by the ads API.

Signature:

export interface AdsEventMap 

Properties

Property

Type

Description

adbegin

Event<'adbegin'>

Fired when an ad begins.

adbreakbegin

Event<'adbreakbegin'>

Fired when an ad break begins.

adbreakchange

Event<'adbreakchange'>

Fired when an ad break changes.

adbreakend

Event<'adbreakend'>

Fired when an ad break ends.

adbuffering

AdBufferingEvent

Fired when the ad has stalled playback to buffer.

addad

Event<'addad'>

Fired when an ad is added.

addadbreak

Event<'addadbreak'>

Fired when an ad break is added.

adend

Event<'adend'>

Fired when an ad ends.

aderror

Event<'aderror'>

Fired when an ad errors.

adfirstquartile

Event<'adfirstquartile'>

Fired when an ad reaches the first quartile.

adimpression

Event<'adimpression'>

Fired when an ad counts as an impression.

adloaded

Event<'adloaded'>

Fired when an ad is loaded.

admetadata

AdMetadataEvent

Fired when an ads list is loaded.

admidpoint

Event<'admidpoint'>

Fired when an ad reaches the mid point.

adskip

Event<'adskip'>

Fired when an ad is skipped.

adthirdquartile

Event<'adthirdquartile'>

Fired when an ad reaches the third quartile.

removeadbreak

Event<'removeadbreak'>

Fired when an ad break is removed.

updatead

Event<'updatead'>

Fired when an ad is updated.

updateadbreak

Event<'updateadbreak'>

Fired when an AdBreak is updated.

Property Details

adbegin

Fired when an ad begins.

Signature:

adbegin: Event<'adbegin'>;

adbreakbegin

Fired when an ad break begins.

Signature:

adbreakbegin: Event<'adbreakbegin'>;

adbreakchange

Fired when an ad break changes.

Signature:

adbreakchange: Event<'adbreakchange'>;

adbreakend

Fired when an ad break ends.

Signature:

adbreakend: Event<'adbreakend'>;

adbuffering

Fired when the ad has stalled playback to buffer.

Signature:

adbuffering: AdBufferingEvent;

Remarks


- only available in the Google IMA integration.

addad

Fired when an ad is added.

Signature:

addad: Event<'addad'>;

Remarks


- Available since v2.60.0.

addadbreak

Fired when an ad break is added.

Signature:

addadbreak: Event<'addadbreak'>;

Remarks


- Available since v2.60.0.

adend

Fired when an ad ends.

Signature:

adend: Event<'adend'>;

aderror

Fired when an ad errors.

Signature:

aderror: Event<'aderror'>;

adfirstquartile

Fired when an ad reaches the first quartile.

Signature:

adfirstquartile: Event<'adfirstquartile'>;

adimpression

Fired when an ad counts as an impression.

Signature:

adimpression: Event<'adimpression'>;

adloaded

Fired when an ad is loaded.

Signature:

adloaded: Event<'adloaded'>;

admetadata

Fired when an ads list is loaded.

Signature:

admetadata: AdMetadataEvent;

Remarks


- only available in the Google IMA integration.

admidpoint

Fired when an ad reaches the mid point.

Signature:

admidpoint: Event<'admidpoint'>;

adskip

Fired when an ad is skipped.

Signature:

adskip: Event<'adskip'>;

adthirdquartile

Fired when an ad reaches the third quartile.

Signature:

adthirdquartile: Event<'adthirdquartile'>;

removeadbreak

Fired when an ad break is removed.

Signature:

removeadbreak: Event<'removeadbreak'>;

Remarks


- Available since v2.60.0.

updatead

Fired when an ad is updated.

Signature:

updatead: Event<'updatead'>;

Remarks


- Available since v2.60.0.

updateadbreak

Fired when an AdBreak is updated.

Signature:

updateadbreak: Event<'updateadbreak'>;

Remarks


- Available since v2.66.0.

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