fl-player-interface/com.quickplay.vstb7.player.model/PALConfiguration

PALConfiguration

data class PALConfiguration(val willAdAutoPlay: Boolean? = null, val willAdPlayMuted: Boolean? = null, val continuousPlayback: Boolean? = null, val descriptionUrl: URL, val iconsSupported: Boolean = false, val nonceLengthLimit: Int? = null, val omidPartnerName: String, val omidPartnerVersion: String, val playerType: String = DEFAULT_PLAYER_TYPE, val playerVersion: String, val ppid: String, val videoHeight: Int? = null, val videoWidth: Int? = null, val omidVersion: String? = null, val sessionId: String? = null, val supportedApiFrameworks: MutableSet<Int>? = null)

Represents configuration data for PAL Nonce Request.

Constructors

PALConfiguration

constructor(willAdAutoPlay: Boolean? = null, willAdPlayMuted: Boolean? = null, continuousPlayback: Boolean? = null, descriptionUrl: URL, iconsSupported: Boolean = false, nonceLengthLimit: Int? = null, omidPartnerName: String, omidPartnerVersion: String, playerType: String = DEFAULT_PLAYER_TYPE, playerVersion: String, ppid: String, videoHeight: Int? = null, videoWidth: Int? = null, omidVersion: String? = null, sessionId: String? = null, supportedApiFrameworks: MutableSet<Int>? = null)

Properties

continuousPlayback

val continuousPlayback: Boolean? = null

Defines whether the player intends to continuously play the content videos one after another similar to TV broadcast or video playlist.

descriptionUrl

val descriptionUrl: URL

The description URL of the content during which the ad will be played. This helps advertisers with brand safety and contextual targeting.

iconsSupported

val iconsSupported: Boolean = false

Indicates whether the player supports displaying VAST icons, which are often used for branding or information.

nonceLengthLimit

val nonceLengthLimit: Int? = null

Defines the length limit of the generated nonce.

omidPartnerName

val omidPartnerName: String

The name of the partner integrating OMID (Open Measurement Interface Definition) measurement. OMID is an IAB standard for measuring ad viewability. This information is crucial for verification vendors.

omidPartnerVersion

val omidPartnerVersion: String

The version of the partner integrating OMID measurement.

omidVersion

val omidVersion: String? = null

The version of OMID that the player responsible for ad playback integrates with.

playerType

val playerType: String

The partner-provided player type. This helps in tracking and debugging.

playerVersion

val playerVersion: String

The partner-provided player version. This helps in tracking and debugging.

ppid

val ppid: String

The publisher-provided ID, a unique identifier for the user. This allows for frequency capping and audience segmentation without using device-resettable IDs

sessionId

val sessionId: String? = null

The unique identifier for the current playback session. It is a privacy-preserving identifier used for purposes like frequency capping.

supportedApiFrameworks

val supportedApiFrameworks: MutableSet<Int>? = null

A set of integers representing supported API frameworks (e.g., VPAID, MRAID). This tells the ad server what kind of interactive ads the player can handle.

videoHeight

val videoHeight: Int? = null

The height of the ad video element.

videoWidth

val videoWidth: Int? = null

The width of the ad video element.

willAdAutoPlay

val willAdAutoPlay: Boolean? = null

Defines whether the ad will autoplay without user interaction.

willAdPlayMuted

val willAdPlayMuted: Boolean? = null

Defines whether the ad will be played while muted.