THEOplayer Web SDK
    Preparing search index...

    Interface AdsConfiguration

    Describes the configuration of advertisement.

    interface AdsConfiguration {
        allowedMimeTypes?: string[];
        allowSkipAdBreak?: boolean;
        googleIma?: GoogleImaConfiguration;
        preload?: AdPreloadType;
        showCountdown?: boolean;
        theoads?: boolean;
        vpaidMode?: VPAIDMode;
    }
    Index

    Properties

    allowedMimeTypes? allowSkipAdBreak? googleIma? preload? showCountdown? theoads? vpaidMode?

    Properties

    allowedMimeTypes?: string[]

    Allows configuring which mime types are allowed during ad playback.


    - If set to an array, all ads with another mime types will be ignored.
    - If set to undefined:

    • for Google IMA, the ad system will pick media based on the browser's capabilities.
    • for the other integrations, the ad system will ignore all streaming ads.

    undefined

    allowSkipAdBreak?: boolean

    Flag to allow seeking out of ads with skipAdBreak when using the csai integration.


    - Available since 9.4.0.

    googleIma?: GoogleImaConfiguration

    The Google IMA configuration.

    preload?: AdPreloadType

    Whether media files of mid- and postrolls are preloaded.


    - This feature is only available for Google IMA.

    'midroll-and-postroll'

    showCountdown?: boolean

    Whether an advertisement duration countdown will be shown in the UI.

    use GoogleImaConfiguration.uiElements instead


    - Available since v2.22.9.
    - This feature is only available for Google IMA.

    true

    theoads?: boolean

    Whether to enable THEOads support.


    - Available since 8.2.0.
    - This must be set to true in order to schedule a TheoAdDescription.

    false

    vpaidMode?: VPAIDMode

    The iframe policy for VPAID ads.


    - This feature is only available for Google IMA and SpotX.

    'enabled'

    Settings

    Member Visibility

    On This Page

    Properties