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

ButtonController

interface ButtonController : AccessibilityListener

Defines the interface for managing a media control button which uses an icon fontset to present the button operation via a glyph defined by the font. Each button can have one or more states (a toggle button has two states) where each state is represented by a different glyph (text) on the button face. Each button state can be backed (managed) by business logic of some sort.

Author

Paul Michael Reilly --- pmreilly@brightcove.com

Inheritors

AbstractButtonController

Functions

abstract fun getButton(): Button

Obtains the managed button from the controller.

getEventEmitter

abstract fun getEventEmitter(): EventEmitter

Obtains the event emitter used to set up the controllers SDK event handling.

abstract fun getId(): Int

Obtains the Android resource id for the button being controlled.

getManagedState

abstract fun getManagedState(): Int

Obtains the managed state information.

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

Obtains a set of property values (name/value pairs) to emit as an optional part of handling a button action.

abstract fun getStateList(): List<ButtonState>

Obtain the list of button states for the button being controlled.

getVisibilityState

abstract fun getVisibilityState(): Int

Obtains the visibility state maintained for the button.

onAccessibilityStateChanged

abstract fun onAccessibilityStateChanged(enabled: Boolean)

Called back on change in the accessibility state.

removeListeners

abstract fun removeListeners()

Removes any listeners set up by this button controller.

abstract fun syncStates()

Ensures that the controlled button is in sync with the managed state it represents.