Interface GoogleImaConfigurationInternal

Describes the configuration of Google IMA.

interface GoogleImaConfiguration {
    adLoadTimeout?: number;
    autoPlayAdBreaks?: boolean;
    bitrate?: number;
    enableDebugMode?: boolean;
    featureFlags?: {
        [flag: string]: string;
    };
    focusSkipButtonWhenAvailable?: boolean;
    maxRedirects?: number;
    ppid?: string;
    sessionID?: string;
}

Properties

adLoadTimeout? autoPlayAdBreaks? bitrate? enableDebugMode? featureFlags? focusSkipButtonWhenAvailable? maxRedirects? ppid? sessionID?

Properties

Optional adLoadTimeout

adLoadTimeout?: number

The amount of time that the SDK will wait before moving onto the next ad for loading. This value will be specified in seconds.

Optional autoPlayAdBreaks

autoPlayAdBreaks?: boolean

Specifies whether to automatically play VMAP and ad rules ad breaks.

Default Value

true

Optional bitrate

bitrate?: number

Maximum recommended bitrate. The value is in kbit/s. SDK will pick media with bitrate below the specified max, or the closest bitrate if there is no media with smaller bitrate found. Default value -1, means the bitrate will be selected by the SDK.

Default Value

-1

Optional enableDebugMode

enableDebugMode?: boolean

Toggles debug mode which will output detailed log information to the console. Debug mode should be disabled in Release and will display a watermark when enabled.

Default Value

false

Optional featureFlags

featureFlags?: {
    [flag: string]: string;
}

Feature flags and their states. Used to control experimental features.

Type declaration

  • [flag: string]: string

Optional focusSkipButtonWhenAvailable

focusSkipButtonWhenAvailable?: boolean

Whether to focus on the skip button when the skippable ad can be skipped on Android TV. This is a no-op on non-Android TV devices.

Default Value

true

Platform

Android

Optional maxRedirects

maxRedirects?: number

Specifies maximum number of redirects after which subsequent redirects will be denied, and the ad load aborted. The number of redirects directly affects latency and thus user experience. This applies to all VAST wrapper ads. If the number of redirects exceeds |maxRedirects|, the ad request will fail with error code 302.

Default Value

4

Optional ppid

ppid?: string

Publisher Provided Identification (PPID) sent with ads request.

Optional sessionID

sessionID?: string

The session ID to identify a single user session. This should be a UUID. It is used exclusively for frequency capping across the user session.

Settings

Member Visibility

Theme

On This Page

adLoadTimeoutautoPlayAdBreaksbitrateenableDebugModefeatureFlagsfocusSkipButtonWhenAvailablemaxRedirectsppidsessionID