AdsRenderingSettings

interface AdsRenderingSettings


Defines parameters that control the rendering of ads.

Summary

Public functions

Int
Boolean

Returns whether the click-through URL will be opened using Custom Tabs feature.

Boolean
Boolean

Whether to focus on the skip button when the skippable ad can be skipped on Android TV.

(Mutable)List<String!>!
Unit
setBitrateKbps(bitrate: Int)

Maximum recommended bitrate.

Unit
setEnableCustomTabs(enableCustomTabs: Boolean)

Notifies the SDK whether to launch the click-through URL using Custom Tabs feature.

Unit
setEnablePreloading(enablePreloading: Boolean)

If set, the SDK will instruct the player to load the creative in response to init.

Unit
setFocusSkipButtonWhenAvailable(enableFocusSkipButton: Boolean)

Set whether to focus on the skip button when the skippable ad can be skipped on Android TV.

Unit
setLoadVideoTimeout(loadVideoTimeout: Int)

Specifies a non-default amount of time to wait for media to load before timing out, in milliseconds.

Unit
setMimeTypes(mimeTypes: (Mutable)List<String!>!)

If specified, the SDK will prioritize the media with MIME type on the list.

Unit

For VMAP and ad rules playlists, only play ad breaks scheduled after this time (in seconds).

Unit

Sets the ad UI elements to be rendered by the IMA SDK.

Public functions

getBitrateKbps

fun getBitrateKbps(): Int

getEnableCustomTabs

fun getEnableCustomTabs(): Boolean

Returns whether the click-through URL will be opened using Custom Tabs feature.

getEnablePreloading

fun getEnablePreloading(): Boolean

getFocusSkipButtonWhenAvailable

fun getFocusSkipButtonWhenAvailable(): 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.

getMimeTypes

fun getMimeTypes(): (Mutable)List<String!>!

setBitrateKbps

fun setBitrateKbps(bitrate: Int): Unit

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

Parameters
bitrate: Int

Maximum bitrate in kbit/s. Default is -1 for SDK to auto select.

setEnableCustomTabs

fun setEnableCustomTabs(enableCustomTabs: Boolean): Unit

Notifies the SDK whether to launch the click-through URL using Custom Tabs feature.

Parameters
enableCustomTabs: Boolean

Set to true if the SDK needs to open the video or companion click-through URL using Custom Tabs feature. Default is false.

setEnablePreloading

fun setEnablePreloading(enablePreloading: Boolean): Unit

If set, the SDK will instruct the player to load the creative in response to init. This allows the player to preload the ad at any point before calling start.

Parameters
enablePreloading: Boolean

Set to true if the SDK needs to preload the ad. Default is false.

setFocusSkipButtonWhenAvailable

fun setFocusSkipButtonWhenAvailable(enableFocusSkipButton: Boolean): Unit

Set 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.

Parameters
enableFocusSkipButton: Boolean

Set to false if the SDK need not auto focus on the skip button. Default is true.

setLoadVideoTimeout

fun setLoadVideoTimeout(loadVideoTimeout: Int): Unit

Specifies a non-default amount of time to wait for media to load before timing out, in milliseconds. This only applies to the IMA client-side SDK. Default time is 8000 ms.

Parameters
loadVideoTimeout: Int

Time in milliseconds to wait for media load.

setMimeTypes

fun setMimeTypes(mimeTypes: (Mutable)List<String!>!): Unit

If specified, the SDK will prioritize the media with MIME type on the list. If not specified, the SDK will pick the media based on player capabilities. This only refers to the mime types of videos to be selected for linear ads.

Parameters
mimeTypes: (Mutable)List<String!>!

MIME types to be prioritized during media selection.

setPlayAdsAfterTime

fun setPlayAdsAfterTime(time: Double): Unit

For VMAP and ad rules playlists, only play ad breaks scheduled after this time (in seconds). This setting is strictly after - for example, setting playAdsAfterTime to 15 will ignore an ad break scheduled to play at 15s.

Parameters
time: Double

Time in seconds after which the eligible ad breaks will be played.

setUiElements

fun setUiElements(uiElements: (Mutable)Set<UiElement!>!): Unit

Sets the ad UI elements to be rendered by the IMA SDK. All values in the list are instances of UiElement. Some elements may be required to be displayed, or unable to be displayed for a given ad (for instance, the ad UI may be customizable for DFP direct sold ads, but not for AdSense ads). In these cases, some modifications to the uiElements list may have no effect for specific ads. As a result, you should always check getUiElements after setting uiElements.

For example, the SDK will attempt to render only the ad attribution with the following code: renderingSettings.setUiElements(ImmutableSet.of(UiElements.AD_ATTRIBUTION));

Parameters
uiElements: (Mutable)Set<UiElement!>!

Ad UI elements to be rendered by the SDK.