@JsonClass(true) data class SxAdInfo
Immutable class that holds all information which are supplied by the SxAdSlotDelegate.adInfo callback.
<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, currentClip: Int? = null, totalClips: Int? = null, currentCommercial: Int? = null, totalCommercials: Int? = null, totalCommercialsDuration: Int? = null, totalCommercialsCurrentTime: Int? = null, duration: Int? = null, currentTime: Int? = null, wrapperTags: List<String>? = null, universalAdID: String? = null, errorCode: Int? = null) |
adId |
Value of the id attribute from the VAST > Ad node val adId: String? |
currentClip |
Index of the current ad, regardless of its variant. val currentClip: Int? |
currentCommercial |
Index of the current ad of variant COMMERCIAL. Defaulting to -1. val currentCommercial: Int? |
currentTime |
Current time of the current ad. val currentTime: Int? |
duration |
Total time of the current ad. val duration: Int? |
errorCode |
Code according to IAB VAST 4.0 Error Codes Table. Defaulting to '--' (no error). val errorCode: Int? |
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? |
totalClips |
Total number of ads within the current ad break, regardless of variants. val totalClips: Int? |
totalCommercials |
Total number of ads with variant COMMERCIAL within the current ad break. val totalCommercials: Int? |
totalCommercialsCurrentTime |
Current time of all ads with variant COMMERCIAL within the current ad break. val totalCommercialsCurrentTime: Int? |
totalCommercialsDuration |
Total duration of ads with variant COMMERCIAL within the current ad break. val totalCommercialsDuration: Int? |
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 |
wrapperTags |
List of Wrapper URLs, starting with the initial request up to the last Wrapper before the Inline tag. val wrapperTags: List<String>? |