AdsRenderingSettings

public interface AdsRenderingSettings

Defines parameters that control the rendering of ads.

Public Method Summary

abstract int
abstract boolean
abstract List<String>
abstract void
setBitrateKbps(int bitrate)
Maximum recommended bitrate.
abstract void
setEnablePreloading(boolean enablePreloading)
If set, the SDK will instruct the player to load the creative in response to init().
abstract void
setMimeTypes(List<String> mimeTypes)
If specified, the SDK will prioritize the media with MIME type on the list.
abstract void
setPlayAdsAfterTime(double time)
For VMAP and ad rules playlists, only play ad breaks scheduled after this time (in seconds).
abstract void
setUiElements(Set<UiElement> uiElements)
Sets the ad UI elements to be rendered by the IMA SDK.

Public Methods

public abstract int getBitrateKbps ()

public abstract boolean getEnablePreloading ()

public abstract List<String> getMimeTypes ()

public abstract void setBitrateKbps (int bitrate)

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

public abstract void setEnablePreloading (boolean enablePreloading)

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

public abstract void setMimeTypes (List<String> mimeTypes)

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

public abstract void setPlayAdsAfterTime (double time)

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

public abstract void setUiElements (Set<UiElement> uiElements)

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

Send feedback about...

IMA SDK for Android
Need help? Visit our support page.