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.


    - Available since v8.6.0.
    - If set to true, Google DAI can show additional ad UI elements on top of the player for certain ads, such as a skip button for skippable ads or a specific UI for GDPR compliance.
    - If set to false, Google DAI ads will only show a basic "Learn More" button. Ads that need additional UI elements will not be played.
    - This only applies to Google DAI server-side inserted ads. Client-side ads from Google IMA can always show additional UI elements.
    - This flag is enabled by default since v10.0.0.

    true (was false in version 9 and lower)

    Settings

    Member Visibility

    On This Page

    Properties