sdk/com.brightcove.player.controller/VideoPlaybackController

VideoPlaybackController

@Emits(events = [EventType.COMPLETED, EventType.CUE_POINT, EventType.DID_SELECT_SOURCE, EventType.DID_SET_VIDEO, EventType.PLAY, EventType.SELECT_SOURCE, EventType.SET_SOURCE, EventType.SET_VIDEO_STILL])
@ListensFor(events = [EventType.COMPLETED, EventType.CUE_POINT, EventType.SEEK_TO, EventType.DID_SEEK_TO, EventType.DID_SET_SOURCE, EventType.PLAY, EventType.DID_PLAY, EventType.PROGRESS, EventType.READY_TO_PLAY, EventType.REMOVE_CUE_POINT, EventType.SET_CUE_POINT, EventType.SET_CUE_POINTS, EventType.SET_VIDEO, EventType.WILL_CHANGE_VIDEO])
open class VideoPlaybackController : AbstractComponent, Component

Manages video playback and provides proper translation between the Brightcove representation of videos and the underlying platform's representation. This includes performing activities such as selecting the appropriate rendition to play, given a Video object, and ensuring that a Video still image loads properly if specified in a Video object.

Constructors

Link copied to clipboard
constructor(eventEmitter: EventEmitter)
Being a Component, VideoPlaybackController requires an EventEmitter on initialization.

Properties

Link copied to clipboard
val TAG: String

Functions

Link copied to clipboard
open fun addListener(eventType: String, listener: EventListener)
Convenience method to add an EventListener for the given type using the EventEmitter.on() method.
Link copied to clipboard
open fun addOnceListener(eventType: String, listener: EventListener)
Convenience method to add an EventListener for the given type using the EventEmitter.once() method.
Link copied to clipboard
open fun getEventEmitter(): EventEmitter
Provides a reference to the EventEmitter with which this component was initialized
Link copied to clipboard
open fun getLiveWindowTimeMs(): Int
Gets the time in milliseconds for the Live Stream Window.
Link copied to clipboard
open fun hasPendingSourcesToLoad(): Boolean
Indicates whether there are pending Sources to load.
Link copied to clipboard
open fun initialize()
Resets the state of the controller to its initial values.
Link copied to clipboard
open fun isAdsDisabled(): Boolean
Link copied to clipboard
open fun removeListener(eventType: String)
Removes the specified listener from the EventEmitter.
Link copied to clipboard
open fun removeListeners()
Removes all set listeners from the EventEmitter.
Link copied to clipboard
open fun setAdsDisabled(disable: Boolean)
Link copied to clipboard
open fun setLiveWindowTimeMs(liveWindowTimeMs: Int)
Sets the time in milliseconds for the Live Stream Window.
Link copied to clipboard
open fun setShouldSelectSource(shouldSelectSource: Boolean): VideoPlaybackController
Set whether the controller selects the source or if this is handled by another component.