belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1
PlaybackGlue
public
abstract
class
PlaybackGlue
extends Object
| java.lang.Object | |
| ↳ | android.support.v17.leanback.media.PlaybackGlue |
Known Direct Subclasses
|
|
Known Indirect Subclasses
MediaControllerGlue,PlaybackBannerControlGlue<T extends PlayerAdapter>,PlaybackTransportControlGlue<T extends PlayerAdapter>
|
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
See also:
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 |
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 |
Protected methods | |
|---|---|
List<PlaybackGlue.PlayerCallback>
|
getPlayerCallbacks()
|
void
|
onAttachedToHost(PlaybackGlueHost host)
This method is called attached to associated |
void
|
onDetachedFromHost()
This method is called when current associated |
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
| |
Public constructors
PlaybackGlue
PlaybackGlue (Context context)
Constructor.
| Parameters | |
|---|---|
context |
Context |
Public methods
addPlayerCallback
void addPlayerCallback (PlaybackGlue.PlayerCallback playerCallback)
Add a PlayerCallback.
| Parameters | |
|---|---|
playerCallback |
PlaybackGlue.PlayerCallback: The callback to add.
|
getHost
PlaybackGlueHost getHost ()
| Returns | |
|---|---|
PlaybackGlueHost |
Associated PlaybackGlueHost or null if not attached to host.
|
isPlaying
boolean isPlaying ()
Returns true if media is currently playing.
| Returns | |
|---|---|
boolean |
|
isPrepared
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. |
play
void play ()
Starts the media player. Does nothing if isPrepared() is false. To wait
isPrepared() to be true before playing, use playWhenPrepared().
playWhenPrepared
void playWhenPrepared ()
Starts play when isPrepared() becomes true.
previous
void previous ()
Goes to the previous media item. This method is optional.
removePlayerCallback
void removePlayerCallback (PlaybackGlue.PlayerCallback callback)
Remove a PlayerCallback.
| Parameters | |
|---|---|
callback |
PlaybackGlue.PlayerCallback: The callback to remove.
|
setHost
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
List<PlaybackGlue.PlayerCallback> getPlayerCallbacks ()
| Returns | |
|---|---|
List<PlaybackGlue.PlayerCallback> |
A snapshot of list of PlayerCallbacks set on the Glue. |
onAttachedToHost
void onAttachedToHost (PlaybackGlueHost host)
This method is called attached to associated PlaybackGlueHost. Subclass may override
and call super.onAttachedToHost().
| Parameters | |
|---|---|
host |
PlaybackGlueHost |
onDetachedFromHost
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
void onHostPause ()
This method is called when {@link PlaybackGlueHost is paused. Subclass may override.
onHostResume
void onHostResume ()
This method is called when {@link PlaybackGlueHost is resumed. Subclass may override.
onHostStart
void onHostStart ()
This method is called when {@link PlaybackGlueHost is started. Subclass may override.
onHostStop
void onHostStop ()
This method is called when {@link PlaybackGlueHost is stopped. Subclass may override.
Interfaces
Classes
- MediaControllerAdapter
- MediaControllerGlue
- MediaPlayerAdapter
- PlaybackBannerControlGlue
- PlaybackBaseControlGlue
- PlaybackControlGlue
- PlaybackGlue
- PlaybackGlue.PlayerCallback
- PlaybackGlueHost
- PlaybackGlueHost.HostCallback
- PlaybackGlueHost.PlayerCallback
- PlaybackTransportControlGlue
- PlayerAdapter
- PlayerAdapter.Callback
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2020-11-09 UTC.