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

Package-level declarations

Contains API to enable advertising workflows.

Types

interface Ad

Defines basic properties available for every ad type

AdBreak

interface AdBreak : AdConfig

Contains information about an ad break.

AdBreakConfig

interface AdBreakConfig : AdTagConfig

Contains configuration options for an AdBreak.

AdConfig

interface AdConfig

Contains the base configuration options for an ad.

AdData

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.

AdItem

data class AdItem(val sources: Array<AdSource>, val position: String = DEFAULT_POSITION, val replaceContentDuration: Double = DEFAULT_REPLACE_CONTENT_DURATION, val preloadOffset: Double = DEFAULT_PRELOAD_OFFSET, val bitmovinAdTagLoading: Boolean = false) : Parcelable

Represents an ad break which can be scheduled for playback.

AdQuartile

enum AdQuartile

Quartiles that can be reached during an ad playback.

AdsManagerAvailableCallback

fun interface AdsManagerAvailableCallback

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

AdSource

data class AdSource @JvmOverloads constructor(val type: AdSourceType, val tag: String, val vastLoadTimeout: Double = DEFAULT_VAST_LOAD_TIMEOUT, val videoLoadTimeout: Double = DEFAULT_VIDEO_LOAD_TIMEOUT) : Parcelable

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

AdSourceType

@Serializable

enum AdSourceType : Enum<AdSourceType> , Parcelable

The available types an AdSource can have.

AdTag

class AdTag(val url: String, val type: AdTagType)

Defines the url and type of an ad manifest.

AdTagConfig

interface AdTagConfig : AdConfig

Contains configuration options for an AdTag.

AdTagType

enum AdTagType : Enum<AdTagType>

Types that can be specified for an AdTag.

AdvertisingApi

interface AdvertisingApi

Provides the means to interact with advertising features. Accessible through Player.ads.

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 }, val shouldPlaySeekedOverAdItems: ShouldPlaySeekedOverAdItemsCallback? = null) : Parcelable

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

BeforeInitializationCallback

fun interface BeforeInitializationCallback

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

CompanionAdContainer

data class CompanionAdContainer(val container: ViewGroup, val width: Int, val height: Int)

LinearAd

interface LinearAd : Ad

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

LinearAdUiConfig

data class LinearAdUiConfig(val requestsUi: Boolean)

OverlayAd

interface OverlayAd : Ad

Defines an ad which gets displayed during content playback

SeekedOverContext

data class SeekedOverContext

Additional information on the seek operation.

ShouldPlayAdBreakCallback

fun interface ShouldPlayAdBreakCallback

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

ShouldPlaySeekedOverAdItemsCallback

fun interface ShouldPlaySeekedOverAdItemsCallback

Invoked after a forward seek or timeshift crosses one or more scheduled ad items.