com.bitmovin.player.api.ssai
SsaiAd
data class SsaiAd@JvmOverloadsconstructor(val id: String = UUID.randomUUID().toString(), val duration: Double = -1.0, val skippableAfter: Double? = null, val clickThroughUrl: String? = null, val metadata: SsaiMetadata = SsaiMetadata()) : LinearAd
Represents an ad stitched into the media stream by an SSAI provider.
Constructors
| SsaiAd | @JvmOverloads constructor(id: String = UUID.randomUUID().toString(), duration: Double = -1.0, skippableAfter: Double? = null, clickThroughUrl: String? = null, metadata: SsaiMetadata = SsaiMetadata()) |
Properties
| Name | Summary |
|---|---|
| clickThroughUrl | open override val clickThroughUrl: String? The url the user should be redirected to when clicking the ad. |
| data | open override val data: AdData? = null Holds various additional AdData. |
| duration | open override val duration: Double The duration of the ad. |
| height | open override val height: Int = 0 The height of the ad. |
| id | open override val id: String Identifier for the ad. A random UUID is generated when no provider-specific identifier is available. |
| isLinear | open override val isLinear: Boolean = true Determines whether an ad is linear, i.e. playback of main content needs to be paused for the ad. |
| mediaFileUrl | open override val mediaFileUrl: String? = null The corresponding media file url for the ad. |
| metadata | val metadata: SsaiMetadata |
| skippableAfter | open override val skippableAfter: Double? Time in seconds, after which the ad is skippable. The ad is not skippable if this property is not set. |
| uiConfig | open override val uiConfig: LinearAdUiConfig? = null Holds relevant information for displaying the ad. |
| width | open override val width: Int = 0 The width of the ad. |
Functions
| Name | Summary |
|---|---|
| clickThroughUrlOpened | open override fun clickThroughUrlOpened() Callback function to track the opening of the clickThroughUrl. |