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

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

PlaybackBaseControlGlue

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 abstract class PlaybackBaseControlGlue
extends PlaybackGlue implements OnActionClickedListener, View.OnKeyListener

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

Known Direct Subclasses PlaybackBannerControlGlue<T extends PlayerAdapter>,PlaybackTransportControlGlue<T extends PlayerAdapter> PlaybackBannerControlGlue<T extends PlayerAdapter> A helper class for managing a PlaybackControlsRow being displayed in PlaybackGlueHost.  PlaybackTransportControlGlue<T extends PlayerAdapter> A helper class for managing a PlaybackControlsRow being displayed in PlaybackGlueHost, it supports standard playback control actions play/pause, and skip next/previous.

---

A base abstract 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 that manages interaction between the leanback UI components PlaybackControlsRow PlaybackRowPresenter and a functional PlayerAdapter which represents the underlying media player.

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

The glue has two action bars: primary action bars and secondary action bars. Apps can provide additional actions by overriding onCreatePrimaryActions(ArrayObjectAdapter) and / or onCreateSecondaryActions(ArrayObjectAdapter) and respond to actions by overriding onActionClicked(Action).

The subclass is responsible for implementing the "repeat mode" in onPlayCompleted().

Summary

Constants
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
PlaybackBaseControlGlue(Context context, T impl) Constructor for the glue.

Public methods
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.
abstract void	onActionClicked(Action action) Handles action clicks.
abstract boolean	onKey(View v, int keyCode, KeyEvent event) Handles key events and returns true if handled.
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.

Protected methods
static void	notifyItemChanged(ArrayObjectAdapter adapter, Object object)
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.
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()

Inherited methods
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)

Constants

ACTION_CUSTOM_LEFT_FIRST

added in version 27.1.0

int ACTION_CUSTOM_LEFT_FIRST

The adapter key for the first custom control on the left side of the predefined primary controls.

Constant Value: 1 (0x00000001)

ACTION_CUSTOM_RIGHT_FIRST

added in version 27.1.0

int ACTION_CUSTOM_RIGHT_FIRST

The adapter key for the first custom control on the right side of the predefined primary controls.

Constant Value: 4096 (0x00001000)

ACTION_FAST_FORWARD

added in version 27.1.0

int ACTION_FAST_FORWARD

The adapter key for the fast forward control.

Constant Value: 128 (0x00000080)

ACTION_PLAY_PAUSE

added in version 27.1.0

int ACTION_PLAY_PAUSE

The adapter key for the play/pause control.

Constant Value: 64 (0x00000040)

ACTION_REPEAT

added in version 27.1.0

int ACTION_REPEAT

The adapter key for the repeat control.

Constant Value: 512 (0x00000200)

ACTION_REWIND

added in version 27.1.0

int ACTION_REWIND

The adapter key for the rewind control.

Constant Value: 32 (0x00000020)

ACTION_SHUFFLE

added in version 27.1.0

int ACTION_SHUFFLE

The adapter key for the shuffle control.

Constant Value: 1024 (0x00000400)

ACTION_SKIP_TO_NEXT

added in version 27.1.0

int ACTION_SKIP_TO_NEXT

The adapter key for the skip to next control.

Constant Value: 256 (0x00000100)

ACTION_SKIP_TO_PREVIOUS

added in version 27.1.0

int ACTION_SKIP_TO_PREVIOUS

The adapter key for the skip to previous control.

Constant Value: 16 (0x00000010)

Public constructors

PlaybackBaseControlGlue

added in version 26.1.0

PlaybackBaseControlGlue (Context context, 
                T impl)

Constructor for the glue.

Parameters
impl	T: Implementation to underlying media player.

Public methods

getArt

added in version 26.1.0

Drawable getArt ()

Returns
Drawable	The drawable representing cover image.

getBufferedPosition

added in version 26.1.0

long getBufferedPosition ()

Returns
long	The current buffered position of the media item in milliseconds.

getControlsRow

added in version 26.1.0

PlaybackControlsRow getControlsRow ()

Returns the playback controls row managed by the glue layer.

Returns
PlaybackControlsRow

getCurrentPosition

added in version 26.1.0

long getCurrentPosition ()

Returns
long	The current position of the media item in milliseconds.

getDuration

added in version 26.1.0

long getDuration ()

Returns
long	The duration of the media item in milliseconds.

getPlaybackRowPresenter

added in version 26.1.0

PlaybackRowPresenter getPlaybackRowPresenter ()

Returns the playback controls row Presenter managed by the glue layer.

Returns
PlaybackRowPresenter

getPlayerAdapter

added in version 26.1.0

T getPlayerAdapter ()

Returns
T

getSubtitle

added in version 26.1.0

CharSequence getSubtitle ()

Return The media subtitle.

Returns
CharSequence

getSupportedActions

added in version 26.1.0

long getSupportedActions ()

Returns a bitmask of actions supported by the media player.

Returns
long

getTitle

added in version 26.1.0

CharSequence getTitle ()

Returns the title of the media item.

Returns
CharSequence

isControlsOverlayAutoHideEnabled

added in version 26.1.0

boolean isControlsOverlayAutoHideEnabled ()

Returns true if the controls auto hides after a timeout when media is playing.

Returns
boolean

See also:

• isControlsOverlayAutoHideEnabled()

isPlaying

added in version 26.1.0

boolean isPlaying ()

Returns true if media is currently playing.

Returns
boolean

isPrepared

added in version 26.1.0

boolean isPrepared ()

Returns true when the media player is prepared to start media playback. When returning false, app may listen to onPreparedStateChanged(PlaybackGlue) event.

Returns
boolean	True if prepared, false otherwise.

next

added in version 26.1.0

void next ()

Goes to the next media item. This method is optional.

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

pause

added in version 26.1.0

void pause ()

Pauses the media player.

play

added in version 26.1.0

void play ()

Starts the media player. Does nothing if isPrepared() is false. To wait isPrepared() to be true before playing, use playWhenPrepared().

previous

added in version 26.1.0

void previous ()

Goes to the previous media item. This method is optional.

seekTo

added in version 26.1.0

void seekTo (long position)

Seek media to a new position.

Parameters
position	long: New position.

setArt

added in version 26.1.0

void setArt (Drawable cover)

Sets the drawable representing cover image. The drawable will be rendered by default description presenter in setDescriptionPresenter(Presenter).

Parameters
cover	Drawable: The drawable representing cover image.

setControlsOverlayAutoHideEnabled

added in version 26.1.0

void setControlsOverlayAutoHideEnabled (boolean enable)

Sets the controls to auto hide after a timeout when media is playing.

Parameters
enable	boolean: True to enable auto hide after a timeout when media is playing.

See also:

• setControlsOverlayAutoHideEnabled(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

setPlaybackRowPresenter

added in version 26.1.0

void setPlaybackRowPresenter (PlaybackRowPresenter presenter)

Sets the controls row Presenter to be managed by the glue layer.

Parameters
presenter	PlaybackRowPresenter

setSubtitle

added in version 26.1.0

void setSubtitle (CharSequence subtitle)

Sets the media subtitle. The subtitle will be rendered by default description presenter setDescriptionPresenter(Presenter).

Parameters
subtitle	CharSequence: Subtitle to set.

setTitle

added in version 26.1.0

void setTitle (CharSequence title)

Sets the media title. The title will be rendered by default description presenter setDescriptionPresenter(Presenter).

Parameters
title	CharSequence

Protected methods

notifyItemChanged

added in version 26.1.0

void notifyItemChanged (ArrayObjectAdapter adapter, 
                Object object)

Parameters
adapter	ArrayObjectAdapter
object	Object

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

onCreateSecondaryActions

added in version 26.1.0

void onCreateSecondaryActions (ArrayObjectAdapter secondaryActionsAdapter)

May be overridden to add secondary actions to the adapter.

Parameters
secondaryActionsAdapter	ArrayObjectAdapter: The adapter you need to add the Actions to.

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.

onHostStart

added in version 26.1.0

void onHostStart ()

This method is called when {@link PlaybackGlueHost is started. Subclass may override.

onHostStop

added in version 26.1.0

void onHostStop ()

This method is called when {@link PlaybackGlueHost is stopped. Subclass may override.

onMetadataChanged

added in version 27.1.0

void onMetadataChanged ()

Event when metadata changed

onPlayCompleted

added in version 26.1.0

void onPlayCompleted ()

Event when play finishes, subclass may handling repeat mode here.

onPlayStateChanged

added in version 26.1.0

void onPlayStateChanged ()

Event when play state changed.

onPreparedStateChanged

added in version 26.1.0

void onPreparedStateChanged ()

Event when ready state for play changes.

onUpdateBufferedProgress

added in version 27.1.0

void onUpdateBufferedProgress ()

onUpdateDuration

added in version 27.1.0

void onUpdateDuration ()

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