Interface TheoAdsAPI

The THEOads API.

Remarks

- Available since v8.17.0.

interface TheoAdsAPI {
    currentInterstitials: Promise<readonly Interstitial[]>;
    scheduledInterstitials: Promise<readonly Interstitial[]>;
    replaceAdTagParameters(adTagParameters?): void;
}

Index

Properties

currentInterstitials scheduledInterstitials

Methods

replaceAdTagParameters

Properties

currentInterstitials

currentInterstitials: Promise<readonly Interstitial[]>

The currently playing interstitials.

scheduledInterstitials

scheduledInterstitials: Promise<readonly Interstitial[]>

List of interstitials which still need to be played.

Methods

replaceAdTagParameters

replaceAdTagParameters(adTagParameters?): void
Replaces all the ad tag parameters used for upcoming ad requests for a live stream.
Parameters
- Optional adTagParameters: Record<string, string>
  The new ad tag parameters.
Returns void
Remarks

- If set, this value overrides any parameters set on the TheoAdDescription.adTagParameters.
- Defined in api/theoads/TheoAdsAPI.ts:31