Interface AdBreakInterstitial

The THEOads interstitial that corresponds with ad playback.

interface AdBreakInterstitial {
    adTagParameters: Record<string, string>;
    ads: readonly Ad[];
    backdropUri: undefined | string;
    duration: undefined | number;
    id: string;
    layout: TheoAdsLayout;
    startTime: number;
    type: "adbreak";
}

Hierarchy (view full)

Properties

adTagParameters ads backdropUri duration id layout startTime type

Properties

adTagParameters

adTagParameters: Record<string, string>

The ad tag parameters that are used for this specific ad break.

Remarks


- The set values are combined and potentially override parameters set on the TheoAdDescription.adTagParameters or through TheoAds.replaceAdTagParameters.

ads

ads: readonly Ad[]

The ads that are part of the interstitial.

Remarks


  • - Only available during ad playback.

backdropUri

backdropUri: undefined | string

The background when playing an ad.

Remarks


  • This is only available when playing in double or l-shape layout.

duration

duration: undefined | number

The duration of the interstitial, in seconds.

id

id: string

The identifier of the interstitial.

layout

layout: TheoAdsLayout

The layout which is used to play the ads of the interstitial.

startTime

startTime: number

The start time at which the interstitial will start.

type

type: "adbreak"

The type of the interstitial.

Settings

Member Visibility

Theme

On This Page

adTagParametersadsbackdropUridurationidlayoutstartTimetype