PlaybackControlGlue

Kotlin |Java

abstract class PlaybackControlGlue : PlaybackGlue, OnActionClickedListener, OnKeyListener

kotlin.Any
↳	androidx.leanback.media.PlaybackGlue
	↳	androidx.leanback.media.PlaybackControlGlue

Known Direct Subclasses

MediaControllerGlue

A helper class for implementing a glue layer for MediaControllerCompat.

A helper class for managing a PlaybackControlsRow and PlaybackGlueHost that implements a recommended approach to handling standard playback control actions such as play/pause, fast forward/rewind at progressive speed levels, and skip to next/previous. This helper class is a glue layer in that manages the configuration of and interaction between the leanback UI components by defining a functional interface to the media player.

You can instantiate a concrete subclass such as MediaPlayerGlue or you must subclass this abstract helper. To create a subclass you must implement all of the abstract methods and the subclass must invoke onMetadataChanged() and onStateChanged() appropriately.

To use an instance of the glue layer, first construct an instance. Constructor parameters inform the glue what speed levels are supported for fast forward/rewind.

You may override onCreateControlsRowAndPresenter() which will create a PlaybackControlsRow and a PlaybackControlsRowPresenter. You may call setControlsRow(PlaybackControlsRow) and setPlaybackRowPresenter(PlaybackRowPresenter) to customize your own row and presenter.

The helper sets a SparseArrayObjectAdapter on the controls row as the primary actions adapter, and adds actions to it. You can provide additional actions by overriding onCreatePrimaryActions. This helper does not deal in secondary actions so those you may add separately.

Provide a click listener on your fragment and if an action is clicked, call onActionClicked.

This helper implements a key event handler. If you pass a PlaybackGlueHost, it will configure its fragment to intercept all key events. Otherwise, you should set the glue object as key event handler to the ViewHolder when bound by your row presenter; see RowPresenter.ViewHolder#setOnKeyListener(android.view.View.OnKeyListener).

To update the controls row progress during playback, override enableProgressUpdating to manage the lifecycle of a periodic callback to updateProgress(). getUpdatePeriod() provides a recommended update period.

Summary

Constants
static Int	`ACTION_CUSTOM_LEFT_FIRST` The adapter key for the first custom control on the left side of the predefined primary controls.
static Int	`ACTION_CUSTOM_RIGHT_FIRST` The adapter key for the first custom control on the right side of the predefined primary controls.
static Int	`ACTION_FAST_FORWARD` The adapter key for the fast forward control.
static Int	`ACTION_PLAY_PAUSE` The adapter key for the play/pause control.
static Int	`ACTION_REWIND` The adapter key for the rewind control.
static Int	`ACTION_SKIP_TO_NEXT` The adapter key for the skip to next control.
static Int	`ACTION_SKIP_TO_PREVIOUS` The adapter key for the skip to previous control.
static Int	`PLAYBACK_SPEED_FAST_L0` The initial (level 0) fast forward playback speed.
static Int	`PLAYBACK_SPEED_FAST_L1` The level 1 fast forward playback speed.
static Int	`PLAYBACK_SPEED_FAST_L2` The level 2 fast forward playback speed.
static Int	`PLAYBACK_SPEED_FAST_L3` The level 3 fast forward playback speed.
static Int	`PLAYBACK_SPEED_FAST_L4` The level 4 fast forward playback speed.
static Int	`PLAYBACK_SPEED_INVALID` Invalid playback speed.
static Int	`PLAYBACK_SPEED_NORMAL` Speed representing playback state that is playing normally.
static Int	`PLAYBACK_SPEED_PAUSED` Speed representing playback state that is paused.

Public constructors
`<init>(context: Context!, seekSpeeds: IntArray!)` Constructor for the glue.
`<init>(context: Context!, fastForwardSpeeds: IntArray!, rewindSpeeds: IntArray!)` Constructor for the glue.

Public methods
open Unit	`enableProgressUpdating(enable: Boolean)` Override this to start/stop a runnable to call `updateProgress` at an interval such as `getUpdatePeriod`.
open PlaybackControlsRow!	`getControlsRow()` Returns the playback controls row managed by the glue layer.
open PlaybackControlsRowPresenter!	`getControlsRowPresenter()` Returns the playback controls row Presenter managed by the glue layer.
abstract Int	`getCurrentPosition()` Returns the current position of the media item in milliseconds.
abstract Int	`getCurrentSpeedId()` Returns the current playback speed.
open IntArray!	`getFastForwardSpeeds()` Returns the fast forward speeds.
abstract Drawable!	`getMediaArt()` Returns a bitmap of the art for the media item.
abstract Int	`getMediaDuration()` Returns the duration of the media item in milliseconds.
abstract CharSequence!	`getMediaSubtitle()` Returns the subtitle of the media item.
abstract CharSequence!	`getMediaTitle()` Returns the title of the media item.
open PlaybackRowPresenter!	`getPlaybackRowPresenter()` Returns the playback row Presenter to be passed to `PlaybackGlueHost` in `onAttachedToHost(PlaybackGlueHost)`.
open IntArray!	`getRewindSpeeds()` Returns the rewind speeds.
abstract Long	`getSupportedActions()` Returns a bitmask of actions supported by the media player.
open Int	`getUpdatePeriod()` Returns the time period in milliseconds that should be used to update the progress.
abstract Boolean	`hasValidMedia()` Returns true if there is a valid media item.
open Boolean	`isFadingEnabled()` Returns true if controls are set to fade when media is playing.
abstract Boolean	`isMediaPlaying()` Returns true if media is currently playing.
open Boolean	`isPlaying()`
open Unit	`onActionClicked(action: Action!)` Handles action clicks.
open Boolean	`onKey(v: View!, keyCode: Int, event: KeyEvent!)` Handles key events and returns true if handled.
open Unit	`play(speed: Int)` Start playback at the given speed.
Unit	`play()`
open Unit	`setControlsRow(controlsRow: PlaybackControlsRow!)` Sets the controls row to be managed by the glue layer.
open Unit	`setControlsRowPresenter(presenter: PlaybackControlsRowPresenter!)` Sets the controls row Presenter to be managed by the glue layer.
open Unit	`setFadingEnabled(enable: Boolean)` Sets the controls to fade after a timeout when media is playing.
open Unit	`setPlaybackRowPresenter(presenter: PlaybackRowPresenter!)` Sets the controls row Presenter to be passed to `PlaybackGlueHost` in `onAttachedToHost(PlaybackGlueHost)`.
open Unit	`updateProgress()` Updates the progress bar based on the current media playback position.

Protected methods
open Unit	`onAttachedToHost(host: PlaybackGlueHost!)`
open Unit	`onCreateControlsRowAndPresenter()` Instantiating a `PlaybackControlsRow` and corresponding `PlaybackControlsRowPresenter`.
open Unit	`onCreatePrimaryActions(primaryActionsAdapter: SparseArrayObjectAdapter!)` May be overridden to add primary actions to the adapter.
open Unit	`onCreateSecondaryActions(secondaryActionsAdapter: ArrayObjectAdapter!)` May be overridden to add secondary actions to the adapter.
open Unit