PlaybackTransportControlGlue

Added in 1.1.0

Kotlin |Java

class PlaybackTransportControlGlue<T : PlayerAdapter?> : PlaybackBaseControlGlue

kotlin.Any
↳	androidx.leanback.media.PlaybackGlue
	↳	androidx.leanback.media.PlaybackBaseControlGlue
		↳	androidx.leanback.media.PlaybackTransportControlGlue

A helper class for managing a PlaybackControlsRow being displayed in PlaybackGlueHost, it supports standard playback control actions play/pause, and skip next/previous. This helper class is a glue layer in that manages interaction between the leanback UI components PlaybackControlsRowPlaybackTransportRowPresenter and a functional PlayerAdapter which represents the underlying media player.

App must pass a PlayerAdapter in constructor for a specific implementation e.g. a MediaPlayerAdapter.

The glue has two actions bar: primary actions bar and secondary actions bar. App can provide additional actions by overriding onCreatePrimaryActions and / or onCreateSecondaryActions and respond to actions by override onActionClicked.

It's also subclass's responsibility to implement the "repeat mode" in onPlayCompleted.

Apps calls setSeekProvider to provide seek data. If the PlaybackGlueHost is instance of PlaybackSeekUi, the provider will be passed to PlaybackGlueHost to render thumb bitmaps.

Sample Code:

public class MyVideoFragment extends VideoFragment {
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        PlaybackTransportControlGlueplayerGlue =
                new PlaybackTransportControlGlue(getActivity(),
                        new MediaPlayerAdapter(getActivity()));
        playerGlue.setHost(new VideoFragmentGlueHost(this));
        playerGlue.setSubtitle("Leanback artist");
        playerGlue.setTitle("Leanback team at work");
        String uriPath = "android.resource://com.example.android.leanback/raw/video";
        playerGlue.getPlayerAdapter().setDataSource(Uri.parse(uriPath));
        playerGlue.playWhenPrepared();
    }
}

Parameters
`<T : PlayerAdapter?>`	Type of `PlayerAdapter` passed in constructor.

Summary

Public constructors
`PlaybackTransportControlGlue(context: Context!, impl: T!)` Constructor for the glue.

Public functions
`PlaybackSeekDataProvider!`	`getSeekProvider()` Get seek data provider used during user seeking.
`Boolean`	`isSeekEnabled()`
`Unit`	`onActionClicked(action: Action)` Handles action clicks.
`Boolean`	`onKey(v: View!, keyCode: Int, event: KeyEvent!)` Handles key events and returns true if handled.
`Unit`	`setControlsRow(controlsRow: PlaybackControlsRow)` Sets the controls row to be managed by the glue layer.
`Unit`	`setSeekEnabled(seekEnabled: Boolean)` Enable or disable seek when `getSeekProvider` is null.
`Unit`	`setSeekProvider(seekProvider: PlaybackSeekDataProvider!)` Set seek data provider used during user seeking.

Protected functions
`Unit`	`onAttachedToHost(host: PlaybackGlueHost)` This method is called attached to associated `PlaybackGlueHost`.
`Unit`	`onCreatePrimaryActions(primaryActionsAdapter: ArrayObjectAdapter)` May be overridden to add primary actions to the adapter.
`PlaybackRowPresenter`	`onCreateRowPresenter()`
`Unit`	`onDetachedFromHost()` This method is called when current associated `PlaybackGlueHost` is attached to a different `PlaybackGlue` or `PlaybackGlueHost` is destroyed .
`Unit`	`onPlayStateChanged()` Event when play state changed.
`Unit`	`onUpdateProgress()`

Inherited Constants

From androidx.leanback.media.PlaybackBaseControlGlue

`const Int`	`ACTION_CUSTOM_LEFT_FIRST = 1` The adapter key for the first custom control on the left side of the predefined primary controls.
`const Int`	`ACTION_CUSTOM_RIGHT_FIRST = 4096` The adapter key for the first custom control on the right side of the predefined primary controls.
`const Int`	`ACTION_FAST_FORWARD = 128` The adapter key for the fast forward control.
`const Int`	`ACTION_PLAY_PAUSE = 64` The adapter key for the play/pause control.
`const Int`	`ACTION_REPEAT = 512` The adapter key for the repeat control.
`const Int`	`ACTION_REWIND = 32` The adapter key for the rewind control.
`const Int`	`ACTION_SHUFFLE = 1024` The adapter key for the shuffle control.
`const Int`	`ACTION_SKIP_TO_NEXT = 256` The adapter key for the skip to next control.
`const Int`	`ACTION_SKIP_TO_PREVIOUS = 16` The adapter key for the skip to previous control.

Inherited functions

From androidx.leanback.media.PlaybackBaseControlGlue

`Drawable?`	`getArt()`
`Long`	`getBufferedPosition()`
`PlaybackControlsRow?`	`getControlsRow()` Returns the playback controls row managed by the glue layer.
`Long`	`getCurrentPosition()`
`Long`	`getDuration()`
`PlaybackRowPresenter?`	`getPlaybackRowPresenter()` Returns the playback controls row Presenter managed by the glue layer.
`T!`	`getPlayerAdapter()`
`CharSequence?`	`getSubtitle()` Return The media subtitle.
`Long`	`getSupportedActions()` Returns a bitmask of actions supported by the media player.
`CharSequence?`	`getTitle()` Returns the title of the media item.
`Boolean`	`isControlsOverlayAutoHideEnabled()` Returns true if the controls auto hides after a timeout when media is playing.
`Boolean`	`isPlaying()` Returns true if media is currently playing.
`Boolean`	`isPrepared()` Returns true when the media player is prepared to start media playback.
`Unit`	`next()` Goes to the next media item.
`java-static Unit`	`notifyItemChanged(adapter: ArrayObjectAdapter, object: Any)`
`Unit`	`onCreateSecondaryActions(secondaryActionsAdapter: ArrayObjectAdapter)` May be overridden to add secondary actions to the adapter.
`Unit`	`onHostStart()` This method is called when `PlaybackGlueHost` is started.
`Unit`	`onHostStop()` This method is called when `PlaybackGlueHost` is stopped.
`Unit`	`onMetadataChanged()` Event when metadata changed
`Unit`	`@CallSuper onPlayCompleted()` Event when play finishes, subclass may handling repeat mode here.
`Unit`	`@CallSuper onPreparedStateChanged()` Event when ready state for play changes.
`Unit`	`@CallSuper onUpdateBufferedProgress()`
`Unit`	`@CallSuper onUpdateDuration()`
`Unit`	`pause()` Pauses the media player.
`Unit`	`play()` Starts the media player.
`Unit`	`previous()` Goes to the previous media item.
`Unit`	`seekTo(position: Long)` Seek media to a new position.
`Unit`	`setArt(cover: Drawable?)` Sets the drawable representing cover image.
`Unit`	`setControlsOverlayAutoHideEnabled(enable: Boolean)` Sets the controls to auto hide after a timeout when media is playing.
`Unit`	`setPlaybackRowPresenter(presenter: PlaybackRowPresenter?)` Sets the controls row Presenter to be managed by the glue layer.
`Unit`	`setSubtitle(subtitle: CharSequence?)` Sets the media subtitle.
`Unit`	`setTitle(title: CharSequence?)` Sets the media title.

From androidx.leanback.media.PlaybackGlue

`Unit`	`addPlayerCallback(playerCallback: PlaybackGlue.PlayerCallback)` Add a PlayerCallback.
`Context`	`getContext()` Returns the context.
`PlaybackGlueHost?`	`getHost()`
`(Mutable)List<PlaybackGlue.PlayerCallback!>?`	`getPlayerCallbacks()`
`Unit`	`onHostPause()` This method is called when `PlaybackGlueHost` is paused.
`Unit`	`onHostResume()` This method is called when `PlaybackGlueHost` is resumed.
`Unit`	`playWhenPrepared()` Starts play when `isPrepared` becomes true.
`Unit`	`removePlayerCallback(callback: PlaybackGlue.PlayerCallback)` Remove a PlayerCallback.
`Unit`	`setHost(host: PlaybackGlueHost?)` This method is used to associate a PlaybackGlue with the `PlaybackGlueHost` which provides UI and optional `SurfaceHolderGlueHost`.

From android.view.View.OnKeyListener

abstract Boolean

onKey(p: View!, p1: Int, p2: KeyEvent!)

Public constructors

PlaybackTransportControlGlue

Added in 1.1.0

PlaybackTransportControlGlue(context: Context!, impl: T!)

Constructor for the glue.

Parameters
`context: Context!`
`impl: T!`	Implementation to underlying media player.

Public functions

getSeekProvider

Added in 1.1.0

fun getSeekProvider(): PlaybackSeekDataProvider!

Get seek data provider used during user seeking.

Returns
`PlaybackSeekDataProvider!`	Seek data provider used during user seeking.

isSeekEnabled

Added in 1.1.0

fun isSeekEnabled(): Boolean

Returns
`Boolean`	True if seek is enabled without `PlaybackSeekDataProvider`, false otherwise.

fun onActionClicked(action: Action): Unit

Handles action clicks. A subclass may override this add support for additional actions.

onKey

Added in 1.1.0

fun onKey(v: View!, keyCode: Int, event: KeyEvent!): Boolean

Handles key events and returns true if handled. A subclass may override this to provide additional support.

fun setControlsRow(controlsRow: PlaybackControlsRow): Unit

Sets the controls row to be managed by the glue layer. If getPrimaryActionsAdapter is not provided, a default ArrayObjectAdapter will be created and initialized in onCreatePrimaryActions. If getSecondaryActionsAdapter is not provided, a default ArrayObjectAdapter will be created and initialized in onCreateSecondaryActions. The primary actions and playback state related aspects of the row are updated by the glue.

setSeekEnabled

Added in 1.1.0

fun setSeekEnabled(seekEnabled: Boolean): Unit

Enable or disable seek when getSeekProvider is null. When true, seekTo will be called during user seeking.

Parameters
`seekEnabled: Boolean`	True to enable seek, false otherwise

Added in 1.1.0

fun setSeekProvider(seekProvider: PlaybackSeekDataProvider!): Unit

Set seek data provider used during user seeking.

Parameters
`seekProvider: PlaybackSeekDataProvider!`	Seek data provider used during user seeking.

Protected functions

onAttachedToHost

protected fun onAttachedToHost(host: PlaybackGlueHost): Unit

This method is called attached to associated PlaybackGlueHost. Subclass may override and call super.onAttachedToHost().

protected fun onCreatePrimaryActions(primaryActionsAdapter: ArrayObjectAdapter): Unit

May be overridden to add primary actions to the adapter. Default implementation add PlaybackControlsRow.PlayPauseAction.

Parameters
`primaryActionsAdapter: ArrayObjectAdapter`	The adapter to add primary `Action`s.

onCreateRowPresenter

protected fun onCreateRowPresenter(): PlaybackRowPresenter

onDetachedFromHost

protected fun onDetachedFromHost(): Unit

This method is called when current associated PlaybackGlueHost is attached to a different PlaybackGlue or PlaybackGlueHost is destroyed . Subclass may override and call super.onDetachedFromHost() at last. A typical PlaybackGlue will release resources (e.g. MediaPlayer or connection to playback service) in this method.

onPlayStateChanged

protected fun onPlayStateChanged(): Unit

Event when play state changed.

onUpdateProgress

protected fun onUpdateProgress(): Unit