@JsonClass(true) data class SxPublicAd
Collection of data for the current running ad
<init> |
Collection of data for the current running ad SxPublicAd(isExpanded: Boolean = false, isInteractive: Boolean = false, isLinear: Boolean = false, isSkippable: Boolean = false, skipOffset: Double = 0.0, hasClickThrough: Boolean = false, width: Double = 0.0, height: Double = 0.0, remainingTime: Double = 0.0, currentTime: Double = 0.0, duration: Double = 0.0, volume: Float = 0f, companions: List<Any> = emptyList(), extensions: List<Any> = emptyList(), icons: Any? = null, closedCaptions: List<SxClosedCaption> = emptyList(), verifications: List<SxAdVerification> = emptyList(), info: SxAdInfo = SxAdInfo(), error: SxAdError? = null, wrappers: List<Any> = emptyList()) |
closedCaptions |
Contains SxClosedCaption for all available languages. val closedCaptions: List<SxClosedCaption> |
companions |
The value of this property is an Array that provides ad companion details for each element. The video player should request this value whenever it receives the ON_COMPANIONS_DETECTED event. val companions: List<Any> |
currentTime |
Current time of ad in seconds val currentTime: Double |
duration |
Duration of current ad, given in seconds val duration: Double |
error |
Latest SxAdError. val error: SxAdError? |
extensions |
The value of this property is an Array that provides ad extension details for the element. The video player should request this value whenever it receives the ON_EXTENSIONS_DETECTED add-on event. val extensions: List<Any> |
hasClickThrough |
Returns whether the current ad has a ClickThrough target (URL) or not. val hasClickThrough: Boolean |
height |
Height of the ad in pixels, as given from AdTag val height: Double |
icons |
The value of this property is an Object that provides ad icon details for the element. val icons: Any? |
info |
Info of data that describes the current video ad. val info: SxAdInfo |
isExpanded |
Indicates if the ad is currently in a expanded state val isExpanded: Boolean |
isInteractive |
Returns whether the current ad is interactive (most likely by using VPAID) or not. val isInteractive: Boolean |
isLinear |
Indicates whether the ad’s current mode of operation is linear or non-linear. val isLinear: Boolean |
isSkippable |
If true, the ad can be skipped, based on AdTag skip delay and configurable skipp offset. Changes of the state can be monitored by listening on ON_AD_SKIPPABLE_STATE_CHANGE val isSkippable: Boolean |
remainingTime |
Remaining time of ad in seconds val remainingTime: Double |
skipOffset |
Time in seconds when ad will become skippable based on playback progress. Will return -1 if ad won't become skippable. val skipOffset: Double |
verifications |
The value of this property is an Array that provides details for each element. The video player may request this value whenever it receives the ON_VERIFICATIONS_DETECTED add-on event, depending on whether the player takes care of the Open Measurement. val verifications: List<SxAdVerification> |
volume |
volume of the current running ad val volume: Float |
width |
Width of the ad in pixels, as given from AdTag val width: Double |
wrappers |
val wrappers: List<Any> |