sdk/com.brightcove.player.mediacontroller/BrightcoveMediaController

BrightcoveMediaController

open class BrightcoveMediaController : AbstractComponent, ShowHideController

The default Brightcove media controller patterned on the Brightcove Web Player.

The media controller provides a container for managing the large play button and the media controls (including control bar, seekbar and the defined set of media control buttons and views) as well as managing the activity lifecycle for these controls.

Constructors

constructor(videoView: BaseVideoView)

Builds a default media controller for a given video view.

constructor(videoView: BaseVideoView, layout: Int)

Builds a media controller for a given video view and layout.

Properties

ANIMATION_STYLE_FADE

val ANIMATION_STYLE_FADE: String = "fade"

Use a fading animation style whereby ...

ANIMATION_STYLE_SLIDE

val ANIMATION_STYLE_SLIDE: String = "slide"

Use a sliding animation style whereby ...

CONTROL_BAR_CREATED

val CONTROL_BAR_CREATED: String = "controlBarCreated"

The event type emitted by the Brightcove media controller that provides for customization.

CONTROLS_HEIGHT

val CONTROLS_HEIGHT: String = "controlsHeight"

The name for the DID_SHOW_MEDIA_CONTROLS event's controls height property.

DEFAULT_TIMEOUT

val DEFAULT_TIMEOUT: Int = 3000

The default show/hide timeout value, in milliseconds.

DID_HIDE_MEDIA_CONTROLS

val DID_HIDE_MEDIA_CONTROLS: String = "didHideMediaControls"

Standard event type used to notify an app that media controls are hidden.

DID_SHOW_MEDIA_CONTROLS

val DID_SHOW_MEDIA_CONTROLS: String = "didShowMediaControls"

Standard event type used to notify an app that media controls are showing.

DURATION

val DURATION: String = "duration"

The event payload key for the duration time text value.

HIDE_MEDIA_CONTROLS

val HIDE_MEDIA_CONTROLS: String = "hideMediaControls"

Standard event type used to emit and listen for hiding media controls.

isDVRControllerEnabled

open var isDVRControllerEnabled: Boolean

isTvMode

val isTvMode: Boolean

boolean set on the constructor to check if we are on TV mode

MARKER_LIST

val MARKER_LIST: String = "markerList"

The event property key specifying the playhead positions at which markers should be placed.

mediaControlRegistry

open val mediaControlRegistry: BrightcoveMediaControlRegistry

The registry that maintains button controllers.

PROGRESS

val PROGRESS: String = "progress"

The event payload key for the current time text value.

SEEK_BAR_MAX

val SEEK_BAR_MAX: String = "seekBarMax"

The event property key for saving and restoring the seek bar max value.

SEEK_BAR_PROGRESS

val SEEK_BAR_PROGRESS: String = "seekBarProgress"

The event property key for saving and restoring the seek bar progress value.

SET_MARKERS

val SET_MARKERS: String = "setMarkers"

Standard event type for supplying markers to the seek bar.

SHOW_HIDE_ANIMATION_STYLE

val SHOW_HIDE_ANIMATION_STYLE: String = "showHideAnimationStyle"

Event property key selecting an animation style, a String constant.

SHOW_HIDE_RESOURCES

val SHOW_HIDE_RESOURCES: String = "showHideResources"

Event property key specifying the Android resource identifiers to either show or hide.

SHOW_HIDE_TIMEOUT

val SHOW_HIDE_TIMEOUT: String = "showHideTimeout"

Event property key specifying delay (in milliseconds, default is three seconds) from showing to hiding the media controls.

SHOW_MEDIA_CONTROLS

val SHOW_MEDIA_CONTROLS: String = "showMediaControls"

Standard event type used to emit and listen for showing media controls.

Functions

addListener

open fun addListener(eventType: String, listener: EventListener)

Convenience method to add an EventListener for the given type using the EventEmitter.on() method.

addOnceListener

open fun addOnceListener(eventType: String, listener: EventListener)

Convenience method to add an EventListener for the given type using the EventEmitter.once() method.

checkTvMode

open fun ~~checkTvMode~~(context: Context): Boolean

disableSeeking

open fun disableSeeking(disable: Boolean)

Disables or enables the BrightcoveControlBar of allowing seeking

dispatchKeyEvent

open fun dispatchKeyEvent(event: KeyEvent): Boolean

Dispatch the key event.

getBrightcoveControlBar

open fun getBrightcoveControlBar(): BrightcoveControlBar

Obtains the current control bar.

getBrightcoveSeekBar

open fun getBrightcoveSeekBar(): BrightcoveSeekBar

Obtains the current seek bar.

getBrightcoveSeekbarController

open fun getBrightcoveSeekbarController(): BrightcoveSeekBarController

getEventEmitter

open fun getEventEmitter(): EventEmitter

Provides a reference to the EventEmitter with which this component was initialized

getSeekBarOffset

open fun ~~getSeekBarOffset~~(): Int

Deprecated.

getSeekBarOffsetLong

open fun getSeekBarOffsetLong(): Long

Gets the live fixed sliding window offset.

hide

open fun hide()

Hides the media controls.

isDragging

open fun isDragging(): Boolean

Obtains the dragging state.

isHideControllerEnable

open fun isHideControllerEnable(): Boolean

It indicates whether the hide mechanism of the ShowHideController is enable or disable.

isShowControllerEnable

open fun isShowControllerEnable(): Boolean

It indicates whether the hide mechanism of the ShowHideController is enable or disable.

isShowing

open fun isShowing(): Boolean

Determines whether or not the media controls are showing.

removeListener

open fun removeListener(eventType: String)

Removes the specified listener from the EventEmitter.

removeListeners

open fun removeListeners()

Removes all set listeners from the EventEmitter.

requestFocusPlayButtonTV

open fun requestFocusPlayButtonTV()

Request focus for the play button if videoView is in TV mode

setCuePointMarkersEnabled

open fun setCuePointMarkersEnabled(state: Boolean)

Set the enable/disable state that allows (enabled) or prevents (disabled) ad markers being set automatically whenever a cue point has been set.

setHideControllerEnable

open fun setHideControllerEnable(hideControllerEnable: Boolean)

The ShowHideController reacts to several events which causes the Media Controller to hide.

setShowControllerEnable

open fun setShowControllerEnable(showControllerEnable: Boolean)

The ShowHideController reacts to several events which causes the Media Controller to show.

setShowHideAnimationStyle

open fun setShowHideAnimationStyle(value: BrightcoveMediaController.AnimationStyle)

Sets the animation style.

setShowHideTimeout

open fun setShowHideTimeout(value: Int)

Sets the animation timeout.

show

open fun show()

Shows the media controls.