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

SeekButtonController

abstract class SeekButtonController : AbstractButtonController

Provides an abstract class that allows a subclass to either seek back or seek forward. You are required to implemented both, the computeTargetSeekPosition and the getDidSeekHandler

Author

Sergio Martinez - smartinez@brightcove.com

Inheritors

RewindButtonController

FastForwardButtonController

Constructors

SeekButtonController

constructor(context: Context, videoView: BaseVideoView, controlBar: View, id: Int, font: Typeface, eventType: String)

Builds a button controller to handle the rewind button.

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.

getOnHoldUpdateFrequency

open fun getOnHoldUpdateFrequency(): Int

Gets the on hold update frequency time in milliseconds, used to send the SEEKBAR_DRAGGING_PROGRESS event to update the Media Controller seek bar.

getOnHoldWaitTime

open fun getOnHoldWaitTime(): Int

Gets the on hold button wait time, which is the time in milliseconds to be waited, so that the key event is considered a long press instead of a regular press.

getProperties

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

Implements a getter to add the current playhead position to the payload when emitting a rewind event.

getSeekDefault

open fun ~~getSeekDefault~~(): Int

Deprecated.

getSeekDefaultLong

open fun getSeekDefaultLong(): Long

Gets default seek time.

getSeekPercentage

open fun getSeekPercentage(): Int

Gets the seek percentage relative to video duration, used to set the seekDefaultLong The values are greater than 0 and lower than 100

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.

isSeekRelativeEnabled

open fun isSeekRelativeEnabled(): Boolean

If enabled, the seekDefaultLong will be set relative to the video duration and the seekPercentage.

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.

setOnHoldUpdateFrequency

open fun setOnHoldUpdateFrequency(onHoldUpdateFrequency: Int)

Sets the on hold update frequency time in milliseconds, used to send the SEEKBAR_DRAGGING_PROGRESS event to update the Media Controller seek bar.

setOnHoldWaitTime

open fun setOnHoldWaitTime(onHoldWaitTime: Int)

Sets the on hold button wait time, which is the time in milliseconds to be waited, so that the key event is considered a long press instead of a regular press.

setSeekDefault

open fun ~~setSeekDefault~~(value: Int)

Deprecated.

open fun setSeekDefault(value: Long)

Sets the default seek time.

setSeekPercentage

open fun setSeekPercentage(seekPercentage: Int)

Sets the seek percentage relative to video duration, used to set the seekDefaultLong The values are greater than 0 and lower than 100

setSeekRelativeEnabled

open fun setSeekRelativeEnabled(seekRelativeEnabled: Boolean)

Enable or disable relative seeking.

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.