Interface RunWaterfallOptions

Options map to start one of the ads with runWaterfall

Hierarchy

Properties

hooks? logger? pauseOnAdClick? responsive? timeout? tracker? videoElement? viewability? vpaidEnabled? wrapperLimit?

Methods

onAdReady onAdStart? onError? onRunFinish?

Properties

Optional hooks

hooks?: RunWaterfallHooks

Optional map with hooks to configure the behaviour of the ad.

Optional logger

logger?: Console

Optional logger instance. Must comply to the Console interface. Defaults to window.console

Optional pauseOnAdClick

pauseOnAdClick?: boolean

if true it will pause the ad unit whenever a user click on the ad Defaults to true

Optional responsive

responsive?: boolean

if true it will resize the ad unit whenever the ad container changes sizes Defaults to false

Optional timeout

timeout?: number

Timeout number in milliseconds. If set, the video ad will time out if it doesn't start within the specified time.

Optional tracker

tracker?: PixelTracker

If provided it will be used to track the VAST events instead of the default PixelTracker.

Optional videoElement

videoElement?: HTMLVideoElement

Optional videoElement that will be used to play the ad.

Optional viewability

viewability?: boolean

if true it will pause the ad whenever is not visible for the viewer. Defaults to false

Optional vpaidEnabled

vpaidEnabled?: boolean

If false and it gets a VPAID ad, it will throw an error before starting the ad and continue down in the waterfall. Defaults to true.

Optional wrapperLimit

wrapperLimit?: number

Sets the maximum number of wrappers allowed in the VastChain. Defaults to 5.

Methods

onAdReady

Optional onAdStart

Optional onError

  • Will be called whenever the an error occurs within the ad unit. It may be called several times with different errors

    Parameters

    • error: Error

      the ad unit error.

    • data: ErrorData

      Data object that will contain.

    Returns void

Optional onRunFinish

  • Will be called once the ad run is finished. It will be called no matter how the run was finished (due to an ad complete or an error). It can be used to know when to unmount the component.

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc