Interface AdsAPI

interface AdsAPI {
    dai?: GoogleDAI;
    currentAdBreak(): Promise<AdBreak>;
    currentAds(): Promise<Ad[]>;
    playing(): Promise<boolean>;
    schedule(ad): void;
    scheduledAdBreaks(): Promise<AdBreak[]>;
    skip(): void;
}

Index

Properties

Methods

currentAdBreak currentAds playing schedule scheduledAdBreaks skip

Properties

`Optional` `Readonly` dai

dai?: GoogleDAI

The Google DAI API.

Remarks

- Only available when the feature or extension 'google-dai' is enabled.

Methods

currentAdBreak

currentAdBreak(): Promise<AdBreak>
The currently playing ad break.

Returns Promise<AdBreak>
- Defined in api/ads/AdsAPI.ts:26

currentAds

currentAds(): Promise<Ad[]>
List of currently playing ads.

Returns Promise<Ad[]>
- Defined in api/ads/AdsAPI.ts:31

playing

playing(): Promise<boolean>
Whether a linear ad is currently playing.

Returns Promise<boolean>
- Defined in api/ads/AdsAPI.ts:13

schedule

schedule(ad): void
Add an ad break request.
Parameters
- ad: AdDescription
Returns void
Remarks

- Prefer scheduling ad breaks up front through SourceConfiguration.ads.
- Defined in api/ads/AdsAPI.ts:44

scheduledAdBreaks

scheduledAdBreaks(): Promise<AdBreak[]>
List of ad breaks which still need to be played.

Returns Promise<AdBreak[]>
- Defined in api/ads/AdsAPI.ts:36

skip

skip(): void
Skip the current linear ad.

Returns void
Remarks

- This will have no effect when the current linear ad is (not yet) skippable.
- Defined in api/ads/AdsAPI.ts:21

Generated using TypeDoc