sdk/com.brightcove.player.mediacontroller.buttons/CaptionsButtonController

CaptionsButtonController

@ListensFor(events = [EventType.ACTIVITY_RESUMED, EventType.CAPTIONS_DIALOG_OK, EventType.CAPTIONS_DIALOG_SETTINGS, EventType.FRAGMENT_RESUMED, EventType.ENTER_TV_MODE, EventType.WILL_CHANGE_VIDEO])

open class CaptionsButtonController : AbstractButtonController

The default Brightcove captions button controller.

Constructors

constructor(context: Context, videoView: BaseVideoView, controlBar: BrightcoveControlBar, font: Typeface, bundle: Bundle)

DefaultMediaController requires a reference to the Context for resource lookups and toggling full-screen mode.

Properties

button

open val button: Button

The button widget.

DEFAULT_AUDIO_TRACKS_BUTTON_ID

val DEFAULT_AUDIO_TRACKS_BUTTON_ID: Int

DEFAULT_CAPTIONS_BUTTON_ID

val DEFAULT_CAPTIONS_BUTTON_ID: Int

DEFAULT_FAST_FORWARD_BUTTON_ID

val DEFAULT_FAST_FORWARD_BUTTON_ID: Int

DEFAULT_FULL_SCREEN_BUTTON_ID

val DEFAULT_FULL_SCREEN_BUTTON_ID: Int

DEFAULT_LIVE_BUTTON_ID

val DEFAULT_LIVE_BUTTON_ID: Int

DEFAULT_PLAY_BUTTON_ID

val DEFAULT_PLAY_BUTTON_ID: Int

DEFAULT_REWIND_BUTTON_ID

val DEFAULT_REWIND_BUTTON_ID: Int

DEFAULT_SEEK_BUTTON_ID

val DEFAULT_SEEK_BUTTON_ID: Int

font

val font: Typeface

The button font, used for testing.

val id: Int

The Android resource id.

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

Implements a getter for the SDK event emitter.

getManagedState

open fun getManagedState(): Int

Implements a getter for the managed state.

getProperties

open fun getProperties(): Map<String, Any>

Implements a default behavior to get the current properties without any additional processing.

getStateList

open fun getStateList(): List<ButtonState>

Gets the button state list providing information about the states associated with a button face.

getVisibilityState

open fun getVisibilityState(): Int

Gets the current visibility state.

onAccessibilityStateChanged

open fun onAccessibilityStateChanged(enabled: Boolean)

Called back on change in the accessibility state.

onBack

open fun onBack(event: KeyEvent): Boolean

On back key actioned

onDpadCenter

open fun onDpadCenter(event: KeyEvent): Boolean

On dpad center key actioned

onDpadDown

open fun onDpadDown(event: KeyEvent): Boolean

On dpad down key actioned

onDpadLeft

open fun onDpadLeft(event: KeyEvent): Boolean

On dpad left key actioned

onDpadRight

open fun onDpadRight(event: KeyEvent): Boolean

On dpad right key actioned

onDpadUp

open fun onDpadUp(event: KeyEvent): Boolean

On dpad up key actioned

onFastForward

open fun onFastForward(event: KeyEvent): Boolean

On fast forward key actioned

onHome

open fun onHome(event: KeyEvent): Boolean

On home key actioned

onMenu

open fun onMenu(event: KeyEvent): Boolean

On menu key actioned

onPause

open fun onPause(event: KeyEvent): Boolean

On pause key actioned

onPlay

open fun onPlay(event: KeyEvent): Boolean

On play key actioned

onPlayPause

open fun onPlayPause(event: KeyEvent): Boolean

On play pause key actioned

onRewind

open fun onRewind(event: KeyEvent): Boolean

On rewind key actioned

onSkipBackward

open fun onSkipBackward(event: KeyEvent): Boolean

On skip backward key actioned

onSkipForward

open fun onSkipForward(event: KeyEvent): Boolean

On skip forward key actioned

removeListener

open fun removeListener(eventType: String)

Removes the specified listener from the EventEmitter.

removeListeners

open fun removeListeners()

Removes all set listeners from the EventEmitter.

setVisibility

open fun setVisibility(visibility: Int)

Sets the button visibility.

syncStates

open fun syncStates()

Implements to update a state (toggle) button to display the correct glyph and content description for the current managed state value.