Player Module/com.bitmovin.player.api.advertising/AdvertisingConfig

AdvertisingConfig

data class AdvertisingConfig(schedule: List<AdItem>, companionAdContainers: List<CompanionAdContainer>?, adsManagerAvailableCallback: AdsManagerAvailableCallback?, beforeInitialization: BeforeInitializationCallback?, imaUiElements: List<ImaUiElement>?) : Parcelable
Content copied to clipboard

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

Constructors

Link copied to clipboard
fun AdvertisingConfig(schedule: List<AdItem> = emptyList(), companionAdContainers: List<CompanionAdContainer>? = null, adsManagerAvailableCallback: AdsManagerAvailableCallback? = null, beforeInitialization: BeforeInitializationCallback? = null)
Content copied to clipboard
Link copied to clipboard
fun AdvertisingConfig(companionAdContainers: List<CompanionAdContainer>? = null, vararg adItems: AdItem)
Content copied to clipboard
Link copied to clipboard
fun AdvertisingConfig(vararg adItems: AdItem)
Content copied to clipboard
Link copied to clipboard
fun AdvertisingConfig(schedule: List<AdItem> = emptyList(), companionAdContainers: List<CompanionAdContainer>? = null, adsManagerAvailableCallback: AdsManagerAvailableCallback? = null, beforeInitialization: BeforeInitializationCallback? = null, imaUiElements: List<ImaUiElement>? = null)
Content copied to clipboard

Properties

Link copied to clipboard
var adsManagerAvailableCallback: AdsManagerAvailableCallback? = null
Content copied to clipboard

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

Link copied to clipboard
var beforeInitialization: BeforeInitializationCallback? = null
Content copied to clipboard

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

Link copied to clipboard
@Transient
val companionAdContainers: List<CompanionAdContainer>? = null
Content copied to clipboard
Link copied to clipboard
val imaUiElements: List<ImaUiElement>? = null
Content copied to clipboard

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

Link copied to clipboard
val schedule: List<AdItem>
Content copied to clipboard

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.