Interface AdsAPI

The API for advertisements.

interface AdsAPI {
    dai?: GoogleDAI;
    omid?: Omid;
    currentAdBreak(): Promise<AdBreak>;
    currentAds(): Promise<Ad[]>;
    playing(): Promise<boolean>;
    schedule(ad: AdDescription): 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.

`Optional` `Readonly`omid

omid?: Omid

The Omid API, which can be used to add as well as remove friendly video controls overlay obstructions.

Since

React Native THEOplayer SDK v8.7.0.

Methods

currentAdBreak

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

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

currentAds

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

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

playing

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

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

schedule

schedule(ad: AdDescription): 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:48

scheduledAdBreaks

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

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

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:25