Interface RunOptions

Options map to start video ad with run

Hierarchy

Properties

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

Methods

onAdReady

Properties

Optional hooks

hooks?: Hooks

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

Methods

onAdReady

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc