lib / tv.smartclip.smartclientandroid.lib.dto.core / SxAdInfo

SxAdInfo

@JsonClass(true) data class SxAdInfo

Immutable class that holds all information which are supplied by the SxAdSlotDelegate.adInfo callback.

Constructors

<init>

Immutable class that holds all information which are supplied by the SxAdSlotDelegate.adInfo callback.

SxAdInfo(header: SxAdInfoHeader? = null, adId: String? = null, title: String? = null, variant: SxVariant = SxVariant.UNKNOWN, skippable: Boolean? = null, duration: Double? = null, currentTime: Double? = null, universalAdID: String? = null)

Properties

adId

Value of the id attribute from the VAST > Ad node

val adId: String?

currentTime

Current time of the current ad.

val currentTime: Double?

duration

Total time of the current ad.

val duration: Double?

header

Header for this advertisement information object.

var header: SxAdInfoHeader?

skippable

The default value for this property is false. When the ad reaches a point where it can be skipped, the ad unit updates this property to true and sends the ON_AD_SKIPPABLE_STATE_CHANGE event. The video player can check this property at any time, but should always check it when the ON_AD_SKIPPABLE_STATE_CHANGE event is received.

val skippable: Boolean?

title

Value of the VAST > Ad > AdTitle node

val title: String?

universalAdID

A unique creative identifier that is maintained across different ad systems.

val universalAdID: String?

variant

Ad variant, depending on the current schedule and VAST manifest.

val variant: SxVariant