freewheel/com.brightcove.freewheel.cuepoint/AdCuePointComponent

AdCuePointComponent

open class AdCuePointComponent

Before Video playback, converts Slots in an IAdContext into relevant CuePoints, then during playback is responsible for handling FreeWheel ad Cuepoints emitted by the VideoController. Before Video playback (most likely during SET_SOURCE), the AdCueComponent creates a series of CuePoints based on the current populated AdContext.

It will create one CuePoint for all pre-roll ads (with CuePoint.Type of BEFORE), one CuePoint for all post-roll ads, and one for each mid-roll (POINT_IN_TIME) and overlay ad.

Due to the nature of the hooks in to the EventEmitter that the AdCuePointComponent creates, it should be instantiated as soon as possible after the FreeWheelController

See also

FreeWheelController

CuePoint

IAdContext

Constructors

AdCuePointComponent

constructor(emitter: EventEmitter)

Properties

CLEAR_PLAYED_SLOTS

val CLEAR_PLAYED_SLOTS: String = "clearPlayedSlots"

Flag that when added to a COMPLETED event enables the clearing of the playedSlots, so ads will be shown again upon replay.

currentVideoAdSlots

open val currentVideoAdSlots: List<ISlot>

current playing slots which block the player activity

val CUSTOM_ID: String = "customId"

open val isLocked: Boolean

val LINEAR: String = "linear"

val NONLINEAR: String = "non-linear"

val playedSlots: List<ISlot>

val postRollSlots: List<ISlot>

val preRollSlots: List<ISlot>

val SLOT: String = "slot"

val TYPE: String = "type"

Functions

open fun addCuePoints(context: IAdContext)

Given an instance of IAdContext, parses the Ad slots contained in the context and generates CuePoints.

open fun disable()

Removes the listeners from the Component.

open fun enable()

open fun lock()

'Locks' the FreeWheelController; afterwards, certain events will be stopped and prevented from bubbling

setLiveVideoChecker

open fun setLiveVideoChecker(liveVideoChecker: LiveVideoChecker)

open fun skipCurrentAd()

Skips the currently playing advertisement within the active Ad break (a.k.

skipCurrentAdBreak

open fun skipCurrentAdBreak()

Skips the current advertisement break (a.k.

open fun ~~skipCurrentAds~~()

Functions the same as skipCurrentAdBreak

open fun unlock()

Tell the control to 'unlock' the normal Video playback control flow by re-emitting the Intercepted Event