PlaybackTransportControlGlue

Added in 1.1.0

Kotlin |Java

public class PlaybackTransportControlGlue<T extends PlayerAdapter> extends PlaybackBaseControlGlue

java.lang.Object
↳	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 extends PlayerAdapter>`	Type of `PlayerAdapter` passed in constructor.

Summary

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

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

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

Inherited Constants

From androidx.leanback.media.PlaybackBaseControlGlue

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

Inherited methods

From androidx.leanback.media.PlaybackBaseControlGlue

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

From androidx.leanback.media.PlaybackGlue

`void`	`addPlayerCallback(@NonNull PlaybackGlue.PlayerCallback playerCallback)` Add a PlayerCallback.
`@NonNull Context`	`getContext()` Returns the context.
`@Nullable PlaybackGlueHost`	`getHost()`
`@Nullable List<PlaybackGlue.PlayerCallback>`	`getPlayerCallbacks()`
`void`	`onHostPause()` This method is called when `PlaybackGlueHost` is paused.
`void`	`onHostResume()` This method is called when `PlaybackGlueHost` is resumed.
`void`	`playWhenPrepared()` Starts play when `isPrepared` becomes true.
`void`	`removePlayerCallback(@NonNull PlaybackGlue.PlayerCallback callback)` Remove a PlayerCallback.
`final void`	`setHost(@Nullable PlaybackGlueHost host)` 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(View p, int p1, KeyEvent p2)

Public constructors

PlaybackTransportControlGlue

Added in 1.1.0

public PlaybackTransportControlGlue(Context context, T impl)

Constructor for the glue.

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

Public methods

getSeekProvider

Added in 1.1.0

public final PlaybackSeekDataProvider getSeekProvider()

Get seek data provider used during user seeking.

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

isSeekEnabled

Added in 1.1.0

public final boolean isSeekEnabled()

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

public void onActionClicked(@NonNull Action action)

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

onKey

Added in 1.1.0

public boolean onKey(View v, int keyCode, KeyEvent event)

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

public void setControlsRow(@NonNull PlaybackControlsRow controlsRow)

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

public final void setSeekEnabled(boolean seekEnabled)

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

Parameters
`boolean seekEnabled`	True to enable seek, false otherwise

Added in 1.1.0

public final void setSeekProvider(PlaybackSeekDataProvider seekProvider)

Set seek data provider used during user seeking.

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

Protected methods

onAttachedToHost

protected void onAttachedToHost(@NonNull PlaybackGlueHost host)

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

protected void onCreatePrimaryActions(
    @NonNull ArrayObjectAdapter primaryActionsAdapter
)

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

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

onCreateRowPresenter

protected @NonNull PlaybackRowPresenter onCreateRowPresenter()

onDetachedFromHost

protected void onDetachedFromHost()

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 void onPlayStateChanged()

Event when play state changed.

onUpdateProgress

protected void onUpdateProgress()