Package 

Interface ButtonController

  • All Implemented Interfaces:
    com.brightcove.player.accessibility.AccessibilityListener

    
    public interface ButtonController
     implements 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.

    • Method Summary

      Modifier and Type Method Description
      abstract int getManagedState() Obtains the managed state information.
      abstract int getVisibilityState() Obtains the visibility state maintained for the button.
      abstract Button getButton() Obtains the managed button from the controller.
      abstract int getId() Obtains the Android resource id for the button being controlled.
      abstract List<ButtonState> getStateList() Obtain the list of button states for the button being controlled.
      abstract Map<String, Object> getProperties() Obtains a set of property values (name/value pairs) to emit asan optional part of handling a button action.
      abstract EventEmitter getEventEmitter() Obtains the event emitter used to set up the controllers SDK event handling.
      abstract void removeListeners() Removes any listeners set up by this button controller.
      abstract void syncStates() Ensures that the controlled button is in sync with the managed state it represents.
      • Methods inherited from class com.brightcove.player.accessibility.AccessibilityListener

        onAccessibilityStateChanged
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getManagedState

         abstract int getManagedState()

        Obtains the managed state information.

      • getVisibilityState

         abstract int getVisibilityState()

        Obtains the visibility state maintained for the button. This is the state which the button will be assigned on aconfiguration change or on an Activity restart.

      • getButton

         abstract Button getButton()

        Obtains the managed button from the controller.

      • getId

         abstract int getId()

        Obtains the Android resource id for the button being controlled.

      • getProperties

         abstract Map<String, Object> getProperties()

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

      • removeListeners

         abstract void removeListeners()

        Removes any listeners set up by this button controller.

      • syncStates

         abstract void syncStates()

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