THEOplayer Web SDK
    Preparing search index...

    Interface GoogleImaConfiguration

    Describes the configuration of Google IMA.

    interface GoogleImaConfiguration {
        allowSeekingForGoogleDai?: boolean;
        bitrate?: number;
        language?: string;
        uiElements?: string[];
        useAdUiElementForSsai?: boolean;
    }
    Index

    Properties

    allowSeekingForGoogleDai? bitrate? language? uiElements? useAdUiElementForSsai?

    Properties

    allowSeekingForGoogleDai?: boolean

    A flag to enable seeking during an ad break in a DAI stream.


    - Available since v9.2.0

    false

    bitrate?: number

    The maximum recommended bitrate in kbit/s. Ads with a bitrate below the specified maximum will be picked.


    - When set to -1, it will select the ad with the highest bitrate.
    - If there is no ad below the specified maximum, the ad closest to the bitrate will be picked.

    -1

    language?: string

    The language code of the UI elements. See localization docs for more information.


    - This will default to UIConfiguration.language when not specified.

    uiElements?: string[]

    The UI elements passed to Google IMA. See Google IMA docs for more information.


    - Available since v6.13.0.

    useAdUiElementForSsai?: boolean

    Whether to use an ad UI element for clickthrough and displaying other ad UI.


    - Optional toggle for turning on usage of the adUiElement when using Google DAI SSAI. This is necessary for showing ads if they have UI specified, such as UI for GDPR compliance. If ads have extra UI elements specified and this is not enabled, ads with UI will not play. Enabling this option will remove the Learn More button and disable keyboard interactions with the ad.
    - This only applies to Google DAI SSAI content. IMA CSAI always uses the adUiElement.

    Settings

    Member Visibility

    On This Page

    Properties