ogplayer-core/com.ogplayer.api.ads/AdInfo

AdInfo

class AdInfo(val adId: String, val positionInPod: Int, val podSize: Int, val breakType: AdBreakType, val isSkippable: Boolean, val skipOffsetMs: Long, val durationMs: Long, val clickThroughUrl: String? = null, val providerRendersUi: Boolean = false)

Metadata of a single ad, including its position in the pod.

Constructors

AdInfo

constructor(adId: String, positionInPod: Int, podSize: Int, breakType: AdBreakType, isSkippable: Boolean, skipOffsetMs: Long, durationMs: Long, clickThroughUrl: String? = null, providerRendersUi: Boolean = false)

Properties

adId

val adId: String

breakType

val breakType: AdBreakType

clickThroughUrl

val clickThroughUrl: String? = null

Clickthrough ("learn more") URL, or null when unavailable.

durationMs

val durationMs: Long

isSkippable

val isSkippable: Boolean

podSize

val podSize: Int

Total number of ads in this pod.

positionInPod

val positionInPod: Int

1-based position of this ad within its pod.

providerRendersUi

val providerRendersUi: Boolean = false

True when the ads SDK renders its own skip/clickthrough UI (IMA). The SDK ad chrome then suppresses its own skip and learn-more buttons; false means the SDK owns the complete ad UI (FreeWheel).

skipOffsetMs

val skipOffsetMs: Long

When the skip button becomes available, or -1 when not skippable.

Functions

toString

open override fun toString(): String