ssai/com.brightcove.ssai.ad/Ad

Ad

interface Ad<T>

Definition of an SSAI Ad.

An Ad can be composed by any type of com.brightcove.ssai.ad.CreativeType.

Types

Link copied to clipboard
enum Category
The category of the Ad
Link copied to clipboard
enum TrackingType
Tracking types supported by an Ad.
Link copied to clipboard
enum Type
Types of Ads.

Properties

Link copied to clipboard
val AD_NON_SKIPPABLE_OFFSET_VALUE: Long = -1
The default skip offset value returned when the Ad is not skippable.

Functions

Link copied to clipboard
abstract fun getAbsoluteEndPosition(): Long
Link copied to clipboard
abstract fun getAbsoluteStartPosition(): Long
Link copied to clipboard
abstract fun getAdSystem(): String
Link copied to clipboard
open fun getCategory(): Ad.Category
Gets the Category of this Ad.
Link copied to clipboard
abstract fun getCompanionCount(): Int
Link copied to clipboard
abstract fun getCreativeAdId(): String
Link copied to clipboard
Link copied to clipboard
abstract fun getCreativeId(): String
Link copied to clipboard
abstract fun getCreativeTrackingEvents(trackingType: TrackingType, adType: Ad.Type): List<TrackingEvent>
Link copied to clipboard
abstract fun getDuration(): Long
Link copied to clipboard
abstract fun getId(): String
Link copied to clipboard
abstract fun getRawAd(): T
Link copied to clipboard
abstract fun getRawCompanion(): T
Link copied to clipboard
abstract fun getRawCreative(): T
Link copied to clipboard
abstract fun getSkipOffset(): Long
Returns the skip offset of the main ad.
Link copied to clipboard
abstract fun getTitle(): String
Link copied to clipboard
abstract fun getTrackingEvents(trackingType: Ad.TrackingType): List<TrackingEvent>
Link copied to clipboard
abstract fun hasCompanions(): Boolean
Link copied to clipboard
abstract fun isLinear(): Boolean