sdk/com.brightcove.player.mediacontroller/ShowHideController

ShowHideController

interface ShowHideController

Defines the facilities for managing media controls visibility. After showing or hiding media controls, a DID_SHOW_MEDIA_CONTROLS or DID_HIDE_MEDIA_CONTROLS SDK event will be emitted with event properties containing the current animation style and timeout value. To determine programmatically if the Brighcove media controls are being displayed, the isShowing() method can be used.

Author

Paul Michael Reilly --- pmreilly@brightcove.com

Inheritors

BrightcoveShowHideController

BrightcoveMediaController

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.

Functions

abstract fun hide()

Hides the media controls.

abstract fun isShowing(): Boolean

Determines whether or not the media controls are showing.

abstract fun show()

Shows the media controls.