PlaybackGlue
public
abstract
class
PlaybackGlue
extends Object
java.lang.Object | |
↳ | androidx.leanback.media.PlaybackGlue |
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 |
void
|
onHostResume()
This method is called when |
void
|
onHostStart()
This method is called when |
void
|
onHostStop()
This method is called when |
Inherited methods | |
---|---|
Public constructors
Public methods
addPlayerCallback
public void addPlayerCallback (PlaybackGlue.PlayerCallback playerCallback)
Add a PlayerCallback.
Parameters | |
---|---|
playerCallback |
PlaybackGlue.PlayerCallback : The callback to add.
|
getHost
public PlaybackGlueHost getHost ()
Returns | |
---|---|
PlaybackGlueHost |
Associated PlaybackGlueHost or null if not attached to host.
|
isPlaying
public boolean isPlaying ()
Returns true if media is currently playing.
Returns | |
---|---|
boolean |
isPrepared
public boolean isPrepared ()
Returns true when the media player is prepared to start media playback. When returning false,
app may listen to PlaybackGlue.PlayerCallback.onPreparedStateChanged(PlaybackGlue)
event.
Returns | |
---|---|
boolean |
True if prepared, false otherwise. |
next
public void next ()
Goes to the next media item. This method is optional.
pause
public void pause ()
Pauses the media player.
play
public void play ()
Starts the media player. Does nothing if isPrepared()
is false. To wait
isPrepared()
to be true before playing, use playWhenPrepared()
.
previous
public void previous ()
Goes to the previous media item. This method is optional.
removePlayerCallback
public void removePlayerCallback (PlaybackGlue.PlayerCallback callback)
Remove a PlayerCallback.
Parameters | |
---|---|
callback |
PlaybackGlue.PlayerCallback : The callback to remove.
|
setHost
public final 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
protected List<PlaybackGlue.PlayerCallback> getPlayerCallbacks ()
Returns | |
---|---|
List<PlaybackGlue.PlayerCallback> |
A snapshot of list of PlayerCallbacks set on the Glue. |
onAttachedToHost
protected void onAttachedToHost (PlaybackGlueHost host)
This method is called attached to associated PlaybackGlueHost
. Subclass may override
and call super.onAttachedToHost().
Parameters | |
---|---|
host |
PlaybackGlueHost |
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.
onHostPause
protected void onHostPause ()
This method is called when PlaybackGlueHost
is paused. Subclass may override.
onHostResume
protected void onHostResume ()
This method is called when PlaybackGlueHost
is resumed. Subclass may override.
onHostStart
protected void onHostStart ()
This method is called when PlaybackGlueHost
is started. Subclass may override.
onHostStop
protected void onHostStop ()
This method is called when PlaybackGlueHost
is stopped. Subclass may override.
Content and code samples on this page are subject to the licenses described in the Content License. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2020-09-30 UTC.