Package-level declarations

Contains API to enable advertising workflows.

Types

Link copied to clipboard
interface Ad

Defines basic properties available for every ad type

Link copied to clipboard
interface AdBreak : AdConfig

Contains information about an ad break.

Link copied to clipboard

Contains configuration options for an AdBreak.

Link copied to clipboard
interface AdConfig

Contains the base configuration options for an ad.

Link copied to clipboard
interface AdData

Holds various additional ad data. Refer to ImaAdData for more information on what additional data is available when using the Google IMA SDK implementation.

Link copied to clipboard
data class AdItem(val sources: Array<AdSource>, val position: String = "pre", val replaceContentDuration: Double = 0.0, val preloadOffset: Double = 0.0) : Parcelable

Represents an ad break which can be scheduled for playback.

Link copied to clipboard
Quartiles that can be reached during an ad playback.
Link copied to clipboard

Can be implemented to gain access to the currently used IMA AdsManager.

Link copied to clipboard
data class AdSource @JvmOverloads constructor(val type: AdSourceType, val tag: String, val vastLoadTimeout: Double = 8.0) : Parcelable

Represents an ad source which can be assigned to an AdItem. An AdItem can have multiple AdSources as waterfalling option.

Link copied to clipboard
@Serializable
enum AdSourceType : Enum<AdSourceType> , Parcelable

The available types an AdSource can have.

Link copied to clipboard
class AdTag(val url: String, val type: AdTagType)

Defines the url and type of an ad manifest.

Link copied to clipboard
interface AdTagConfig : AdConfig

Contains configuration options for an AdTag.

Link copied to clipboard

Types that can be specified for an AdTag.

Link copied to clipboard
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.

Link copied to clipboard

A callback to be invoked before IMA initialization, exposing the IMA settings.

Link copied to clipboard
data class CompanionAdContainer(val container: ViewGroup, val width: Int, val height: Int)
Link copied to clipboard
interface LinearAd : Ad

Defines a linear ad which requires the playback of the content to stop

Link copied to clipboard
data class LinearAdUiConfig(val requestsUi: Boolean)
Link copied to clipboard
interface OverlayAd : Ad

Defines an ad which gets displayed during content playback

Link copied to clipboard

Can be implemented to receive a callback every time an ad break is about to start.