Class ImaAdsProvider

SPI for a client-side ads integration (Google IMA HTML5, future slot providers) — the web mirror of the mobile AdsProvider SPI. Opt-in: apps that never touch ads load none of this.

Implements

AdsProvider

Index

Constructors

Methods

attach click contentDidComplete destroy pause requestAds resize resume skip startPendingBreak

Constructors

constructor

new ImaAdsProvider(options?: ImaAdsProviderOptions): ImaAdsProvider
Parameters
- options: ImaAdsProviderOptions = {}
Returns ImaAdsProvider
- Defined in src/ads/ima.ts:133

Methods

attach

attach(
    video: HTMLVideoElement,
    adContainer: HTMLElement,
    callbacks: AdsProviderCallbacks,
): void
Wire the provider to the content element and the ad UI container. Called once before the first requestAds.
Parameters
- video: HTMLVideoElement
- adContainer: HTMLElement
- callbacks: AdsProviderCallbacks
Returns void
Implementation of AdsProvider.attach
- Defined in src/ads/ima.ts:154

click

click(): void
Returns void
Implementation of AdsProvider.click
- Defined in src/ads/ima.ts:352

contentDidComplete

contentDidComplete(): void
Content reached its end (so VMAP postrolls fire).

Returns void
Implementation of AdsProvider.contentDidComplete
- Defined in src/ads/ima.ts:348

destroy

destroy(): void
Returns void
Implementation of AdsProvider.destroy
- Defined in src/ads/ima.ts:360

pause

pause(): void
Returns void
Implementation of AdsProvider.pause
- Defined in src/ads/ima.ts:349

requestAds

requestAds(config: AdBreakConfig, autostart: boolean): void
Request ads for the item's config. autostart carries the content's autoplay intent: false = hold the break until startPendingBreak().
Parameters
- config: AdBreakConfig
- autostart: boolean
Returns void
Implementation of AdsProvider.requestAds
- Defined in src/ads/ima.ts:161

resize

resize(width: number, height: number, fullscreen: boolean): void
The player/container was resized (fullscreen, layout).
Parameters
- width: number
- height: number
- fullscreen: boolean
Returns void
Implementation of AdsProvider.resize
- Defined in src/ads/ima.ts:353

resume

resume(): void
Returns void
Implementation of AdsProvider.resume
- Defined in src/ads/ima.ts:350

skip

skip(): void
Returns void
Implementation of AdsProvider.skip
- Defined in src/ads/ima.ts:351

startPendingBreak

startPendingBreak(): boolean
Start a loaded-but-held break. True if one was started.

Returns boolean
Implementation of AdsProvider.startPendingBreak
- Defined in src/ads/ima.ts:341