-
public interface Ad<T>
Definition of an SSAI Ad.
An Ad can be composed by any type of com.brightcove.ssai.ad.CreativeType.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enum
Ad.TrackingType
Tracking types supported by an Ad.
public enum
Ad.Type
Types of Ads.
public enum
Ad.Category
The category of the Ad
-
Method Summary
Modifier and Type Method Description abstract long
getAbsoluteStartPosition()
abstract long
getAbsoluteEndPosition()
abstract long
getDuration()
abstract String
getId()
abstract String
getTitle()
abstract String
getAdSystem()
abstract boolean
isLinear()
abstract boolean
hasCompanions()
abstract long
getSkipOffset()
Returns the skip offset of the main ad. abstract List<TrackingEvent>
getTrackingEvents(Ad.TrackingType trackingType)
abstract List<TrackingEvent>
getCreativeTrackingEvents(@NonNull() TrackingType trackingType, @NonNull() Ad.Type adType)
abstract int
getCompanionCount()
abstract CreativeClicks
getCreativeClicks()
abstract T
getRawAd()
abstract T
getRawCreative()
abstract T
getRawCompanion()
Ad.Category
getCategory()
Gets the Category of this Ad. abstract String
getCreativeId()
abstract String
getCreativeAdId()
-
-
Method Detail
-
getAbsoluteStartPosition
abstract long getAbsoluteStartPosition()
-
getAbsoluteEndPosition
abstract long getAbsoluteEndPosition()
-
getDuration
abstract long getDuration()
-
getAdSystem
@NonNull() abstract String getAdSystem()
-
isLinear
abstract boolean isLinear()
-
hasCompanions
abstract boolean hasCompanions()
-
getSkipOffset
abstract long getSkipOffset()
Returns the skip offset of the main ad.It must return AD_NON_SKIPPABLE_OFFSET_VALUE when the Ad is not skippable.
-
getTrackingEvents
@NonNull() abstract List<TrackingEvent> getTrackingEvents(Ad.TrackingType trackingType)
- Parameters:
trackingType
- of the tracking events to be returned.
-
getCreativeTrackingEvents
@NonNull() abstract List<TrackingEvent> getCreativeTrackingEvents(@NonNull() TrackingType trackingType, @NonNull() Ad.Type adType)
- Parameters:
trackingType
- com.brightcove.ssai.ad.TrackingType of the Tracking events to retrieve.adType
- the Type of the creativesto retrieve the tracking events.
-
getCompanionCount
abstract int getCompanionCount()
-
getCreativeClicks
@Nullable() abstract CreativeClicks getCreativeClicks()
-
getRawCreative
@NonNull() abstract T getRawCreative()
-
getRawCompanion
@Nullable() abstract T getRawCompanion()
-
getCategory
@NonNull() Ad.Category getCategory()
Gets the Category of this Ad.
-
getCreativeId
abstract String getCreativeId()
-
getCreativeAdId
abstract String getCreativeAdId()
-
-
-
-