Interface PlayerAdvertisingAPI

interface PlayerAdvertisingAPI {
    discardAdBreak(adBreakId: string): void;
    getActiveAd(): Ad;
    getActiveAdBreak(): AdBreak;
    getModuleInfo(): ModuleInfo;
    isLinearAdActive(): boolean;
    list(): AdBreak[];
    schedule(adConfig: AdConfig): Promise<AdBreak[]>;
    skip(): Promise<void>;
}

Index

Methods

discardAdBreak getActiveAd getActiveAdBreak getModuleInfo isLinearAdActive list schedule skip

Methods

discardAdBreak

discardAdBreak(adBreakId: string): void
Discards all scheduled ad breaks with the given ID. Also stops the current ad break if it has the same ID.
Parameters
- adBreakId: string
  The ID of the ad break which shall be removed from the scheduled ad breaks.
Returns void

Since
v8.0

getActiveAd

getActiveAd(): Ad

Returns the currently active ad, or null if no ad is active.

Returns Ad
the active Ad, or null if none is active

Since
v8.1

getActiveAdBreak

getActiveAdBreak(): AdBreak

Returns the currently active ad break, or null if no ad break is active.

Returns AdBreak
the active AdBreak, or null if none is active

Since
v8.0

getModuleInfo

getModuleInfo(): ModuleInfo

Returns the name and version of the currently used advertising module.

Returns ModuleInfo

Since
v8.1

isLinearAdActive

isLinearAdActive(): boolean

Returns true if a linear ad is currently active (playing or paused). Returns false otherwise.

Returns boolean

Since
v8.0

list

list(): AdBreak[]

Returns all scheduled ad breaks. Does not include currently active ad breaks.

Returns AdBreak[]
Array containing all the scheduled ad breaks.

Since
v8.0

schedule

schedule(adConfig: AdConfig): Promise<AdBreak[]>
Schedules resulting ad break(s) of an ad config for playback.
Parameters
- adConfig: AdConfig
  The ad configuration used to schedule one or more ad breaks.
Returns Promise<AdBreak[]>
Promise that resolves with the ad breaks that were scheduled as a result of the given ad config.

Since
v8.0

skip

skip(): Promise<void>

Skips the current ad. Has no effect if the ad is not skippable, if no ad is active or if the IMA module is used (disabled by IMA in version 3.607.0).

Returns Promise<void>
Promise that resolves when the ad has been skipped and the ad player is done with cleanup of events and states.

Since
v8.0