Interface TheoAds

The THEOads API.

Remarks

- Available since v8.12.0.

interface TheoAds {
    currentInterstitials: readonly Interstitial[];
    scheduledInterstitials: readonly Interstitial[];
    addEventListener<TType extends keyof TheoAdsEventsMap>(
        type: TType | readonly TType[],
        listener: EventListener<TheoAdsEventsMap[TType]>,
    ): void;
    removeEventListener<TType extends keyof TheoAdsEventsMap>(
        type: TType | readonly TType[],
        listener: EventListener<TheoAdsEventsMap[TType]>,
    ): void;
    replaceAdTagParameters(adTagParameters?: Record<string, string>): void;
}

Hierarchy (View Summary)

EventDispatcher<TheoAdsEventsMap>
- TheoAds

Index

Properties

currentInterstitials scheduledInterstitials

Methods

addEventListener removeEventListener replaceAdTagParameters

Properties

currentInterstitials

currentInterstitials: readonly Interstitial[]

The currently playing interstitials.

scheduledInterstitials

scheduledInterstitials: readonly Interstitial[]

List of interstitials which still need to be played.

Methods

addEventListener

addEventListener<TType extends keyof TheoAdsEventsMap>(
type: TType | readonly TType[],
listener: EventListener<TheoAdsEventsMap[TType]>,
): void
Add the given listener for the given event type(s).
Type Parameters
- TType extends keyof TheoAdsEventsMap
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<TheoAdsEventsMap[TType]>
  The callback which is executed when the event occurs.
Returns void
Inherited from EventDispatcher.addEventListener

removeEventListener

removeEventListener<TType extends keyof TheoAdsEventsMap>(
type: TType | readonly TType[],
listener: EventListener<TheoAdsEventsMap[TType]>,
): void
Remove the given listener for the given event type(s).
Type Parameters
- TType extends keyof TheoAdsEventsMap
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<TheoAdsEventsMap[TType]>
  The callback which will be removed.
Returns void
Inherited from EventDispatcher.removeEventListener

replaceAdTagParameters

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

- If set, this value overrides any parameters set on the TheoAdDescription.adTagParameters.