added in version 26.1.0
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1

Summary: Inherited Constants | Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

PlaybackTransportControlGlue

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public class PlaybackTransportControlGlue
extends PlaybackBaseControlGlue<T extends PlayerAdapter>

java.lang.Object
↳	android.support.v17.leanback.media.PlaybackGlue
	↳	android.support.v17.leanback.media.PlaybackBaseControlGlue<T extends android.support.v17.leanback.media.PlayerAdapter>
		↳	android.support.v17.leanback.media.PlaybackTransportControlGlue<T extends android.support.v17.leanback.media.PlayerAdapter>

---

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 PlaybackControlsRow PlaybackTransportRowPresenter 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(ArrayObjectAdapter) and / or onCreateSecondaryActions(ArrayObjectAdapter) 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:

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

Summary

Inherited constants

From class android.support.v17.leanback.media.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
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(Action action) Handles action clicks.
boolean	onKey(View v, int keyCode, KeyEvent event) Handles key events and returns true if handled.
void	setControlsRow(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(PlaybackGlueHost host) This method is called attached to associated PlaybackGlueHost.
void	onCreatePrimaryActions(ArrayObjectAdapter primaryActionsAdapter) May be overridden to add primary actions to the adapter.
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 methods
From class android.support.v17.leanback.media.PlaybackBaseControlGlue Drawable getArt() final long getBufferedPosition() PlaybackControlsRow getControlsRow() Returns the playback controls row managed by the glue layer. long getCurrentPosition() final long getDuration() PlaybackRowPresenter getPlaybackRowPresenter() Returns the playback controls row Presenter managed by the glue layer. final 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. 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(ArrayObjectAdapter adapter, Object object) abstract void onActionClicked(Action action) Handles action clicks. void onAttachedToHost(PlaybackGlueHost host) This method is called attached to associated PlaybackGlueHost. void onCreatePrimaryActions(ArrayObjectAdapter primaryActionsAdapter) May be overridden to add primary actions to the adapter. abstract PlaybackRowPresenter onCreateRowPresenter() void onCreateSecondaryActions(ArrayObjectAdapter secondaryActionsAdapter) May be overridden to add secondary actions to the adapter. void onDetachedFromHost() This method is called when current associated PlaybackGlueHost is attached to a different PlaybackGlue or PlaybackGlueHost is destroyed . void onHostStart() This method is called when {@link PlaybackGlueHost is started. void onHostStop() This method is called when {@link PlaybackGlueHost is stopped. abstract boolean onKey(View v, int keyCode, KeyEvent event) Handles key events and returns true if handled. void onMetadataChanged() Event when metadata changed void onPlayCompleted() Event when play finishes, subclass may handling repeat mode here. void onPlayStateChanged() Event when play state changed. void onPreparedStateChanged() Event when ready state for play changes. void onUpdateBufferedProgress() void onUpdateDuration() void onUpdateProgress() 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(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 setControlsRow(PlaybackControlsRow controlsRow) Sets the controls row to be managed by the glue layer. void setPlaybackRowPresenter(PlaybackRowPresenter presenter) Sets the controls row Presenter to be managed by the glue layer. void setSubtitle(CharSequence subtitle) Sets the media subtitle. void setTitle(CharSequence title) Sets the media title.
From class android.support.v17.leanback.media.PlaybackGlue void addPlayerCallback(PlaybackGlue.PlayerCallback playerCallback) Add a PlayerCallback. Context getContext() Returns the context. PlaybackGlueHost getHost() List<PlaybackGlue.PlayerCallback> getPlayerCallbacks() boolean isPlaying() Returns true if media is currently playing. boolean isPrepared() Returns true when the media player is prepared to start media playback. void next() Goes to the next media item. void onAttachedToHost(PlaybackGlueHost host) This method is called attached to associated PlaybackGlueHost. void onDetachedFromHost() This method is called when current associated PlaybackGlueHost is attached to a different PlaybackGlue or PlaybackGlueHost is destroyed . void onHostPause() This method is called when {@link PlaybackGlueHost is paused. void onHostResume() This method is called when {@link PlaybackGlueHost is resumed. void onHostStart() This method is called when {@link PlaybackGlueHost is started. void onHostStop() This method is called when {@link PlaybackGlueHost is stopped. void pause() Pauses the media player. void play() Starts the media player. void playWhenPrepared() Starts play when isPrepared() becomes true. void previous() Goes to the previous media item. void removePlayerCallback(PlaybackGlue.PlayerCallback callback) Remove a PlayerCallback. final void setHost(PlaybackGlueHost host) This method is used to associate a PlaybackGlue with the PlaybackGlueHost which provides UI and optional SurfaceHolderGlueHost.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface android.support.v17.leanback.widget.OnActionClickedListener abstract void onActionClicked(Action action) Callback fired when the host fragment receives an action.
From interface android.view.View.OnKeyListener abstract boolean onKey(View arg0, int arg1, KeyEvent arg2)

Public constructors

PlaybackTransportControlGlue

added in version 26.1.0

PlaybackTransportControlGlue (Context context, 
                T impl)

Constructor for the glue.

Parameters
impl	T: Implementation to underlying media player.

Public methods

getSeekProvider

added in version 26.1.0

PlaybackSeekDataProvider getSeekProvider ()

Get seek data provider used during user seeking.

Returns
PlaybackSeekDataProvider	Seek data provider used during user seeking.

isSeekEnabled

added in version 26.1.0

boolean isSeekEnabled ()

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

onActionClicked

added in version 26.1.0

void onActionClicked (Action action)

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

Parameters
action	Action

onKey

added in version 26.1.0

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.

Parameters
v	View
keyCode	int
event	KeyEvent

Returns
boolean

setControlsRow

added in version 26.1.0

void setControlsRow (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(ArrayObjectAdapter). If getSecondaryActionsAdapter() is not provided, a default ArrayObjectAdapter will be created and initialized in onCreateSecondaryActions(ArrayObjectAdapter). The primary actions and playback state related aspects of the row are updated by the glue.

Parameters
controlsRow	PlaybackControlsRow

setSeekEnabled

added in version 26.1.0

void setSeekEnabled (boolean seekEnabled)

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

Parameters
seekEnabled	boolean: True to enable seek, false otherwise

setSeekProvider

added in version 26.1.0

void setSeekProvider (PlaybackSeekDataProvider seekProvider)

Set seek data provider used during user seeking.

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

Protected methods

onAttachedToHost

added in version 26.1.0

void onAttachedToHost (PlaybackGlueHost host)

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

Parameters
host	PlaybackGlueHost

onCreatePrimaryActions

added in version 26.1.0

void onCreatePrimaryActions (ArrayObjectAdapter primaryActionsAdapter)

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

Parameters
primaryActionsAdapter	ArrayObjectAdapter: The adapter to add primary Actions.

onCreateRowPresenter

added in version 26.1.0

PlaybackRowPresenter onCreateRowPresenter ()

Returns
PlaybackRowPresenter

onDetachedFromHost

added in version 26.1.0

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

added in version 26.1.0

void onPlayStateChanged ()

Event when play state changed.

onUpdateProgress

added in version 27.1.0

void onUpdateProgress ()

• Interfaces

  • SurfaceHolderGlueHost

• Classes

  • MediaControllerAdapter
  • MediaControllerGlue
  • MediaPlayerAdapter
  • PlaybackBannerControlGlue
  • PlaybackBaseControlGlue
  • PlaybackControlGlue
  • PlaybackGlue
  • PlaybackGlue.PlayerCallback
  • PlaybackGlueHost
  • PlaybackGlueHost.HostCallback
  • PlaybackGlueHost.PlayerCallback
  • PlaybackTransportControlGlue
  • PlayerAdapter
  • PlayerAdapter.Callback