Interface Ads

The API for advertisements.

Remarks


- Integrates with 'theo', 'google-ima', 'google-dai', 'freewheel' or 'sgai'.

interface Ads {
    currentAdBreak: null | AdBreak;
    currentAds: Ad[];
    dai?: GoogleDAI;
    playing: boolean;
    scheduledAdBreaks: AdBreak[];
    scheduledAds: Ad[];
    addEventListener<TType>(type, listener): void;
    registerServerSideIntegration(integrationId, integrationFactory): void;
    removeEventListener<TType>(type, listener): void;
    schedule(adDescription): void;
    skip(): void;
}

Hierarchy (view full)

Properties

currentAdBreak currentAds dai? playing scheduledAdBreaks scheduledAds

Methods

addEventListener registerServerSideIntegration removeEventListener schedule skip

Properties

Readonly currentAdBreak

currentAdBreak: null | AdBreak

The currently playing ad break.

Readonly currentAds

currentAds: Ad[]

List of currently playing ads.

Optional Readonly dai

dai?: GoogleDAI

The Google DAI API.

Remarks


- Only available with the feature 'google-dai'.

playing

playing: boolean

Whether a linear ad is currently playing.

Readonly scheduledAdBreaks

scheduledAdBreaks: AdBreak[]

List of ad breaks which still need to be played.

Readonly scheduledAds

scheduledAds: Ad[]

List of ads which still need to be played.

Methods

addEventListener

registerServerSideIntegration

  • registerServerSideIntegration(integrationId, integrationFactory): void
  • Experimental

    Register a custom advertisement integration.

    This allows you to integrate with third-party advertisement providers, and have them report their ads and ad-related events through the THEOplayer Ads API.

    Parameters

    Returns void

    Remarks

    This API is experimental and is subject to change in any minor version of THEOplayer. Please consult with THEO Technologies before using this API.

removeEventListener

schedule

  • schedule(adDescription): void

  • Add an ad break request.

    Parameters

    • adDescription: AdDescription

      Describes the ad break to be scheduled.

    Returns void

    Remarks


    - Available since v2.18.0.
    - Prefer scheduling ad breaks up front through SourceConfiguration.ads.

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.

Settings

Member Visibility

Theme

On This Page

currentAdBreakcurrentAdsdaiplayingscheduledAdBreaksscheduledAdsaddEventListenerregisterServerSideIntegrationremoveEventListenerscheduleskip