sdk/com.brightcove.player.mediacontroller/BrightcoveShowHideController

BrightcoveShowHideController

@Emits(events = [])

@ListensFor(events = [])

open class BrightcoveShowHideController : AbstractComponent, ShowHideController

Abstracts the show/hide operations.

Author

Paul Michael Reilly --- @pmreilly@brightcove.com

Constructors

BrightcoveShowHideController

constructor(controlBar: BrightcoveControlBar, videoView: BaseVideoView)

Builds the show/hide controller.

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 ...

CONTROLS_HEIGHT

val CONTROLS_HEIGHT: String = "controlsHeight"

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

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.

HIDE_MEDIA_CONTROLS

val HIDE_MEDIA_CONTROLS: String = "hideMediaControls"

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

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.

showHideTimeout

open var showHideTimeout: Int

The show/hide timeout value, in milliseconds.

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.

getEventEmitter

open fun getEventEmitter(): EventEmitter

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

hide

open fun hide()

Hides the media controls.

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.

setBrightcoveControlBar

open fun setBrightcoveControlBar(brightcoveControlBar: BrightcoveControlBar)

Sets the Brightcove control bar.

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.

show

open fun show()

Shows the media controls.