PlaybackTransportControlGlue

Kotlin |Java

open class PlaybackTransportControlGlue<T : PlayerAdapter!> : PlaybackBaseControlGlue<T>

kotlin.Any
↳	androidx.leanback.media.PlaybackGlue
	↳	androidx.leanback.media.PlaybackBaseControlGlue<T>
		↳	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(Action).

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

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

Sample Code:

<code>
  public class MyVideoFragment extends VideoFragment {
      @Override
      public void onCreate(Bundle savedInstanceState) {
          super.onCreate(savedInstanceState);
          PlaybackTransportControlGlue
 <mediaplayeradapter>
   playerGlue = 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(); } } 
 </mediaplayeradapter></code>

Summary

Inherited constants

From class PlaybackBaseControlGlue

`Int`	`ACTION_CUSTOM_LEFT_FIRST` The adapter key for the first custom control on the left side of the predefined primary controls.
`Int`	`ACTION_CUSTOM_RIGHT_FIRST` The adapter key for the first custom control on the right side of the predefined primary controls.
`Int`	`ACTION_FAST_FORWARD` The adapter key for the fast forward control.
`Int`	`ACTION_PLAY_PAUSE` The adapter key for the play/pause control.
`Int`	`ACTION_REPEAT` The adapter key for the repeat control.
`Int`	`ACTION_REWIND` The adapter key for the rewind control.
`Int`	`ACTION_SHUFFLE` The adapter key for the shuffle control.
`Int`	`ACTION_SKIP_TO_NEXT` The adapter key for the skip to next control.
`Int`	`ACTION_SKIP_TO_PREVIOUS` The adapter key for the skip to previous control.

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

Public methods
PlaybackSeekDataProvider!	`getSeekProvider()` Get seek data provider used during user seeking.
Boolean	`isSeekEnabled()`
open Unit	`onActionClicked(action: Action!)`
open Boolean	`onKey(v: View!, keyCode: Int, event: KeyEvent!)`
open Unit	`setControlsRow(controlsRow: PlaybackControlsRow!)`
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 methods
open Unit	`onAttachedToHost(host: PlaybackGlueHost!)`
open Unit	`onCreatePrimaryActions(primaryActionsAdapter: ArrayObjectAdapter!)`
open PlaybackRowPresenter!	`onCreateRowPresenter()`
open Unit	`onDetachedFromHost()`
open Unit	`onPlayStateChanged()`
open Unit	`onUpdateProgress()`

Inherited functions

From class PlaybackGlue

`Unit`	`addPlayerCallback(playerCallback: PlaybackGlue.PlayerCallback!)` Add a PlayerCallback.
`Context!`	`getContext()` Returns the context.
`PlaybackGlueHost!`	`getHost()`
`MutableList<PlaybackGlue.PlayerCallback!>!`	`getPlayerCallbacks()`
`Unit`	`onHostPause()` This method is called when `PlaybackGlueHost` is paused. Subclass may override.
`Unit`	`onHostResume()` This method is called when `PlaybackGlueHost` is resumed. Subclass may override.
`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 class 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()`
`Boolean`	`isPrepared()`
`Unit`	`next()`
`Unit`	`notifyItemChanged(adapter: ArrayObjectAdapter!, object: Any!)`
`Unit`	`onCreateSecondaryActions(secondaryActionsAdapter: ArrayObjectAdapter!)` May be overridden to add secondary actions to the adapter.
`Unit`	`onHostStart()`
`Unit`	`onHostStop()`
`Unit`	`onMetadataChanged()` Event when metadata changed
`Unit`	`onPlayCompleted()` Event when play finishes, subclass may handling repeat mode here.
`Unit`	`onPreparedStateChanged()` Event when ready state for play changes.
`Unit`	`onUpdateBufferedProgress()`
`Unit`	`onUpdateDuration()`
`Unit`	`pause()`
`Unit`	`play()`
`Unit`	`previous()`
`Unit`	`seekTo(position: Long)` Seek media to a new position.
`Unit`	`setArt(cover: Drawable!)` Sets the drawable representing cover image. The drawable will be rendered by default description presenter in `PlaybackTransportRowPresenter#setDescriptionPresenter(Presenter)`.
`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. The subtitle will be rendered by default description presenter `PlaybackTransportRowPresenter#setDescriptionPresenter(Presenter)`.
`Unit`	`setTitle(title: CharSequence!)` Sets the media title. The title will be rendered by default description presenter `PlaybackTransportRowPresenter#setDescriptionPresenter(Presenter)`.

Public constructors

<init>

PlaybackTransportControlGlue(
    context: Context!, 
    impl: T)

Constructor for the glue.

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

Public methods

getSeekProvider

fun getSeekProvider(): PlaybackSeekDataProvider!

Get seek data provider used during user seeking.

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

isSeekEnabled

fun isSeekEnabled(): Boolean

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

onActionClicked

open fun onActionClicked(action: Action!): Unit

onKey

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

setControlsRow

open fun setControlsRow(controlsRow: PlaybackControlsRow!): Unit

setSeekEnabled

fun setSeekEnabled(seekEnabled: Boolean): Unit

Enable or disable seek when getSeekProvider() is null. When true, PlayerAdapter#seekTo(long) will be called during user seeking.

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

setSeekProvider

fun setSeekProvider(seekProvider: PlaybackSeekDataProvider!): Unit

Set seek data provider used during user seeking.

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

Protected methods

onAttachedToHost

protected open fun onAttachedToHost(host: PlaybackGlueHost!): Unit

onCreatePrimaryActions

protected open fun onCreatePrimaryActions(primaryActionsAdapter: ArrayObjectAdapter!): Unit

onCreateRowPresenter

protected open fun onCreateRowPresenter(): PlaybackRowPresenter!

onDetachedFromHost

protected open fun onDetachedFromHost(): Unit

onPlayStateChanged

protected open fun onPlayStateChanged(): Unit

onUpdateProgress

protected open fun onUpdateProgress(): Unit