Interface AdsAPI

Optional Readonly dai

Optional Readonly omid

currentAdBreak

• currentAdBreak(): Promise<AdBreak>

• The currently playing ad break.

  Returns Promise<AdBreak>

currentAds

• currentAds(): Promise<Ad[]>

• List of currently playing ads.

  Returns Promise<Ad[]>

playing

• playing(): Promise<boolean>

• Whether a linear ad is currently playing.

  Returns Promise<boolean>

schedule

• schedule(ad): void

• Add an ad break request.

  Parameters

  • ad: AdDescription

  Returns void

  Remarks

  
  - Prefer scheduling ad breaks up front through SourceConfiguration.ads.

scheduledAdBreaks

• scheduledAdBreaks(): Promise<AdBreak[]>

• List of ad breaks which still need to be played.

  Returns Promise<AdBreak[]>

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.