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

Summary: Nested Classes | Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

PlaybackGlue

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 PlaybackGlue
extends Object

java.lang.Object
↳	android.support.v17.leanback.media.PlaybackGlue

Known Direct Subclasses PlaybackBaseControlGlue<T extends PlayerAdapter>,PlaybackControlGlue PlaybackBaseControlGlue<T extends PlayerAdapter> A base abstract class for managing a PlaybackControlsRow being displayed in PlaybackGlueHost.  PlaybackControlGlue A helper class for managing a PlaybackControlsRow and PlaybackGlueHost that implements a recommended approach to handling standard playback control actions such as play/pause, fast forward/rewind at progressive speed levels, and skip to next/previous.

Known Indirect Subclasses MediaControllerGlue,PlaybackBannerControlGlue<T extends PlayerAdapter>,PlaybackTransportControlGlue<T extends PlayerAdapter> MediaControllerGlue This class was deprecated in API level 27.1.0. Use MediaControllerAdapter with PlaybackTransportControlGlue or PlaybackBannerControlGlue.   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.

---

Base class for abstraction of media play/pause feature. A subclass of PlaybackGlue will contain implementation of Media Player or a connection to playback Service. App initializes PlaybackGlue subclass, associated it with a PlaybackGlueHost. PlaybackGlueHost is typically implemented by a Fragment or an Activity, it provides the environment to render UI for PlaybackGlue object, it optionally provides SurfaceHolder via SurfaceHolderGlueHost to render video. A typical PlaybackGlue should release resources (e.g. MediaPlayer or connection to playback Service) in onDetachedFromHost(). onDetachedFromHost() is called in two cases:

• app manually change it using setHost(PlaybackGlueHost) call
• When host (fragment or activity) is destroyed

In rare case if an PlaybackGlue wants to live outside fragment / activity life cycle, it may manages resource release by itself.

See also:

• PlaybackGlueHost

Summary

Nested classes
class	PlaybackGlue.PlayerCallback Interface to allow clients to take action once the video is ready to play and start stop.

Public constructors
PlaybackGlue(Context context) Constructor.

Public methods
void	addPlayerCallback(PlaybackGlue.PlayerCallback playerCallback) Add a PlayerCallback.
Context	getContext() Returns the context.
PlaybackGlueHost	getHost()
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	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.

Protected methods
List<PlaybackGlue.PlayerCallback>	getPlayerCallbacks()
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.

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

Public constructors

PlaybackGlue

added in version 25.1.0

PlaybackGlue (Context context)

Constructor.

Parameters
context	Context

Public methods

addPlayerCallback

added in version 26.1.0

void addPlayerCallback (PlaybackGlue.PlayerCallback playerCallback)

Add a PlayerCallback.

Parameters
playerCallback	PlaybackGlue.PlayerCallback: The callback to add.

getContext

added in version 25.1.0

Context getContext ()

Returns the context.

Returns
Context

getHost

added in version 25.1.0

PlaybackGlueHost getHost ()

Returns
PlaybackGlueHost	Associated PlaybackGlueHost or null if not attached to host.

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 25.1.0

void next ()

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

pause

added in version 25.1.0

void pause ()

Pauses the media player.

play

added in version 25.1.0

void play ()

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

playWhenPrepared

added in version 27.1.0

void playWhenPrepared ()

Starts play when isPrepared() becomes true.

previous

added in version 25.1.0

void previous ()

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

removePlayerCallback

added in version 26.1.0

void removePlayerCallback (PlaybackGlue.PlayerCallback callback)

Remove a PlayerCallback.

Parameters
callback	PlaybackGlue.PlayerCallback: The callback to remove.

setHost

added in version 25.1.0

void setHost (PlaybackGlueHost host)

This method is used to associate a PlaybackGlue with the PlaybackGlueHost which provides UI and optional SurfaceHolderGlueHost.

Parameters
host	PlaybackGlueHost: The host for the PlaybackGlue. Set to null to detach from the host.

Protected methods

getPlayerCallbacks

added in version 26.1.0

List<PlaybackGlue.PlayerCallback> getPlayerCallbacks ()

Returns
List<PlaybackGlue.PlayerCallback>	A snapshot of list of PlayerCallbacks set on the Glue.

onAttachedToHost

added in version 25.1.0

void onAttachedToHost (PlaybackGlueHost host)

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

Parameters
host	PlaybackGlueHost

onDetachedFromHost

added in version 25.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.

onHostPause

added in version 25.1.0

void onHostPause ()

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

onHostResume

added in version 25.1.0

void onHostResume ()

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

onHostStart

added in version 25.1.0

void onHostStart ()

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

onHostStop

added in version 25.1.0

void onHostStop ()

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

• Interfaces

  • SurfaceHolderGlueHost

• Classes

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