player-core/com.bitmovin.player.api.advertising/AdvertisingConfig

AdvertisingConfig

data class AdvertisingConfig(val schedule: List<AdItem> = emptyList(), val companionAdContainers: List<CompanionAdContainer>? = null, var adsManagerAvailableCallback: AdsManagerAvailableCallback? = null, var beforeInitialization: BeforeInitializationCallback? = null, val imaUiElements: List<ImaUiElement>? = null, val ima: ImaConfig = ImaConfig(), val bitmovin: BitmovinAdvertisingConfig = BitmovinAdvertisingConfig(), val shouldPlayAdBreak: ShouldPlayAdBreakCallback = ShouldPlayAdBreakCallback { true }) : Parcelable

Contains configuration values regarding the ads which should be played back by the player.

Constructors

AdvertisingConfig

constructor(companionAdContainers: List<CompanionAdContainer>? = null, vararg adItems: AdItem)

constructor(vararg adItems: AdItem)

constructor(schedule: List<AdItem> = emptyList(), companionAdContainers: List<CompanionAdContainer>? = null, adsManagerAvailableCallback: AdsManagerAvailableCallback? = null, beforeInitialization: BeforeInitializationCallback? = null, imaUiElements: List<ImaUiElement>? = null, ima: ImaConfig = ImaConfig(), bitmovin: BitmovinAdvertisingConfig = BitmovinAdvertisingConfig(), shouldPlayAdBreak: ShouldPlayAdBreakCallback = ShouldPlayAdBreakCallback { true })

Properties

adsManagerAvailableCallback

var ~~adsManagerAvailableCallback~~: AdsManagerAvailableCallback?

The AdsManagerAvailableCallback currently in use. Only relevant when the IMA SDK is used for ad playback.

beforeInitialization

var ~~beforeInitialization~~: BeforeInitializationCallback?

Callback that provides access to the google.ima.ImaSdkSettings before any initialization happens.

bitmovin

val bitmovin: BitmovinAdvertisingConfig

Configuration to customize Bitmovin Advertising behavior.

companionAdContainers

val companionAdContainers: List<CompanionAdContainer>? = null

ima

val ima: ImaConfig

Configuration to customize Google IMA SDK integration behavior.

imaUiElements

val ~~imaUiElements~~: List<ImaUiElement>? = null

A list of UI elements that should be displayed when an ad is active. When set to null the default IMA behavior is applied.

schedule

val schedule: List<AdItem>

The ad items that are scheduled when a new playback session is started via Player.load. When loading multiple sources via a PlaylistConfig, the ads are only scheduled for the first source in the playlist.

shouldPlayAdBreak

val shouldPlayAdBreak: ShouldPlayAdBreakCallback

The ShouldPlayAdBreakCallback that will be called every time an ad break is about to start. The return value decides whether the ad break will start playing or will be discarded.