Interface Ads

The API for advertisements.

Remarks


- Integrates with 'csai', 'google-ima', 'google-dai', 'freewheel' or 'theoads'.

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

Hierarchy (view full)

Properties

currentAdBreak currentAds dai? playing scheduledAdBreaks scheduledAds theoads?

Methods

addEventListener registerServerSideIntegration removeEventListener schedule skip

Properties

ReadonlycurrentAdBreak

currentAdBreak: null | AdBreak

The currently playing ad break.

ReadonlycurrentAds

currentAds: Ad[]

List of currently playing ads.

Optional Readonlydai

dai?: GoogleDAI

The Google DAI API.

Remarks


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

playing

playing: boolean

Whether a linear ad is currently playing.

ReadonlyscheduledAdBreaks

scheduledAdBreaks: AdBreak[]

List of ad breaks which still need to be played.

ReadonlyscheduledAds

scheduledAds: Ad[]

List of ads which still need to be played.

Optional Readonlytheoads

theoads?: TheoAds

The THEOads API.

Remarks


- Only available with the feature 'theoads'.

Methods

addEventListener

registerServerSideIntegration

  • registerServerSideIntegration(integrationId, integrationFactory): void

  • 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

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

On This Page

Properties
Methods