openplayerjs
Version:
HTML5 video and audio player
43 lines (42 loc) • 1.07 kB
TypeScript
/**
* Ads options
*
* @description An object that stores configuration for Google IMA SDK
* @interface Options
* @export
*/
export default interface AdsOptions {
/**
* Flag to interrupt automatic ad breaks and give end user control over it.
*/
readonly autoPlayAdBreaks?: boolean;
/**
* If `true`, enables the IMA SDK URL in debug mode.
*/
readonly debug?: boolean;
/**
* If `true`, enables the IMA SDK Ads preloading.
*/
readonly enablePreloading?: boolean;
/**
* Number of redirection to play Ad (by default, `4`).
*/
readonly numRedirects?: number;
/**
* Language of Ads, specified in standard language code (en, en_sa, jp, etc.)
*/
readonly language?: string;
/**
* Play Ad endlessly (mostly used for text Ads).
*/
readonly loop?: boolean;
/**
* The IMA SDK URL to load the plugin.
*/
readonly sdkPath?: string;
/**
* Ad or collection of Ads to be played.
*/
readonly src: string | string[];
[key: string]: any;
}