Interface ImaClientSideConfiguration

interface ImaClientSideConfiguration {
    clickTrackingElement: undefined | HTMLElement;
    hardTimeouts: boolean;
    postRollTimeout: number;
    preRollTimeout: number;
    requestMode: "onload" | "onplay" | "ondemand" | "oncue";
    sdkUrl: string;
    serverUrl: string;
    showVpaidControls: boolean;
    useMediaCuePoints: boolean;
    vpaidMode: string;
}

Properties

clickTrackingElement: undefined | HTMLElement

Specifies the alternative video ad click element. Leave this undefined to let the IMA SDK handle clicks. More details are available in the parameter documentation for the IMA SDK AdDisplayContainer. Defaults to undefined.

hardTimeouts: boolean

Abandon ads that finish loading after they have timed out. Defaults to true.

postRollTimeout: number

Controls postrollTimeout setting in videojs-contrib-ads. If provided, overrides any value set for timeout. Default Value: same as timeout.

preRollTimeout: number

Controls prerollTimeout setting in videojs-contrib-ads. If provided, overrides any value set for timeout. Default Value: same as timeout.

requestMode: "onload" | "onplay" | "ondemand" | "oncue"

When to request ads: during player load ('onload'), during playback ('onplay'), ondemand ('ondemand'), cuechange ('oncue'). Defaults to 'onload'.

sdkUrl: string

The URL of the IMA3 SDK. Defaults to '${protocol}//imasdk.googleapis.com/js/sdkloader/ima3.js'.

serverUrl: string

The URL of the ad server to make requests to during playback. Defaults to '${protocol}//pubads.g.doubleclick.net/gampad/ads?sz=400x300&iu=%2F6062%2Fiab_vast_samples&ciu_szs=300x250%2C728x90&gdfp_req=1&env=vp&output=xml_vast2&unviewed_position_start=1&url=[referrer_url]&correlator=[timestamp]&cust_params=iab_vast_samples%3Dlinear'.

showVpaidControls: boolean

Show Brightcove player custom controls for VPAID ads. They may or may not work. Defaults to false.

useMediaCuePoints: boolean

Enables Video Cloud ad cue points being used to trigger ads. Default Value: false.

vpaidMode: string

Specify VPAID 2 mode in the IMA HTML5 SDK. If none is provided, uses the SDK's default, which is currently ENABLED. Default Value: undefined.