Class FreewheelAdsProvider

constructor

• new FreewheelAdsProvider(
      options?: FreewheelAdsProviderOptions,
  ): FreewheelAdsProvider

  Parameters

  • options: FreewheelAdsProviderOptions = {}

  Returns FreewheelAdsProvider

ReadonlyusesContentVideoElement

attach

• attach(
      video: HTMLVideoElement,
      adContainer: HTMLElement,
      callbacks: AdsProviderCallbacks,
  ): void

  Wire the provider to the content element and the ad UI container. Called before the first requestAds, and again whenever the host's video element or ad container changes (a re-mounted ad layer) — a provider must adopt the new nodes and release anything bound to the old ones.

  Parameters

  • video: HTMLVideoElement
  • adContainer: HTMLElement
  • callbacks: AdsProviderCallbacks

  Returns void

click

• click(): void

  Returns void

contentDidComplete

• contentDidComplete(): void

  Content reached its end (so VMAP postrolls fire).

  Returns void

destroy

• destroy(): void

  Returns void

pause

• pause(): void

  Returns void

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

resize

• resize(): void

  The player/container was resized (fullscreen, layout).

  Returns void

resume

• resume(): void

  Returns void

skip

• skip(): void

  Returns void

startPendingBreak

• startPendingBreak(): boolean

  Start a loaded-but-held break. True if one was started.

  Returns boolean