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

Package-level declarations

Types

data class AdPricing(val value: Double?, val model: String?, val currency: String?)

Used to provide a value that represents a price that can be used by real-time bidding (RTB) systems. Specified in Inline.Pricing in the VAST response.

AdQualitySelectionContext

data class AdQualitySelectionContext(val available: List<MediaFile>, val suggested: MediaFile, val bitrateEstimate: Long)

Context provided to the BitmovinAdvertisingConfig.onSelectAdQuality callback, containing information about the available media files and the current network conditions.

AdSurvey

data class AdSurvey(val uri: String?, val type: String?)

URI to any resource relating to an integrated survey. Specified in InLine.Survey in the VAST response.

AdSystem

data class AdSystem(val name: String, val version: String?)

Describes the ad system that returned the ad. Specified in InLine.AdSystem in the VAST response.

Advertiser

data class Advertiser(val name: String?, val id: String?)

Describes he advertiser as defined by the ad serving party. Specified in InLine.Advertiser in the VAST response.

Creative

data class Creative(val id: String?, val adId: String?, val universalAdId: UniversalAdId?, val universalAdIds: List<UniversalAdId>)

Contains various data about the Creative. Specified in InLine.Creative or Wrapper.Creative in the VAST Response.

MediaFile

data class MediaFile

Represents a media file to be played as part of a VAST ad.

MediaFileDeliveryType

enum MediaFileDeliveryType : Enum<MediaFileDeliveryType>

OnSelectAdQuality

fun interface OnSelectAdQuality

Callback interface for selecting a media file from the available options in a VAST response. See BitmovinAdvertisingConfig.onSelectAdQuality for usage details.

UniversalAdId

data class UniversalAdId(val idRegistry: String?, val value: String?)

Describes a unique creative identifier that is maintained across systems. Specified in Creative.UniversalAdId in the VAST response.

VastAdData

interface VastAdData : AdData

Holds various additional ad data that's available in the VAST response.