PlaybackGlue
abstract class PlaybackGlue
PlaybackBaseControlGlue |
A base abstract class for managing a |
PlaybackControlGlue |
A helper class for managing a |
MediaControllerGlue |
This class is deprecated. Use |
PlaybackBannerControlGlue |
A helper class for managing a |
PlaybackTransportControlGlue |
A helper class for managing a |
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
setHostcall - When host (fragment or activity) is destroyed
| See also | |
|---|---|
PlaybackGlueHost |
Summary
Nested types |
|---|
abstract class PlaybackGlue.PlayerCallbackInterface to allow clients to take action once the video is ready to play and start stop. |
Public constructors |
|---|
PlaybackGlue(context: Context)Constructor. |
Public functions |
|
|---|---|
Unit |
addPlayerCallback(playerCallback: PlaybackGlue.PlayerCallback)Add a PlayerCallback. |
Context |
Returns the context. |
PlaybackGlueHost? |
getHost() |
Boolean |
Returns true if media is currently playing. |
Boolean |
Returns true when the media player is prepared to start media playback. |
Unit |
next()Goes to the next media item. |
Unit |
pause()Pauses the media player. |
Unit |
play()Starts the media player. |
Unit |
Starts play when |
Unit |
previous()Goes to the previous media item. |
Unit |
removePlayerCallback(callback: PlaybackGlue.PlayerCallback)Remove a PlayerCallback. |
Unit |
setHost(host: PlaybackGlueHost?)This method is used to associate a PlaybackGlue with the |
Protected functions |
|
|---|---|
(Mutable)List<PlaybackGlue.PlayerCallback!>? |
|
Unit |
This method is called attached to associated |
Unit |
This method is called when current associated |
Unit |
This method is called when |
Unit |
This method is called when |
Unit |
This method is called when |
Unit |
This method is called when |
Public constructors
Public functions
addPlayerCallback
fun addPlayerCallback(playerCallback: PlaybackGlue.PlayerCallback): Unit
Add a PlayerCallback.
| Parameters | |
|---|---|
playerCallback: PlaybackGlue.PlayerCallback |
The callback to add. |
getHost
fun getHost(): PlaybackGlueHost?
| Returns | |
|---|---|
PlaybackGlueHost? |
Associated |
isPrepared
fun isPrepared(): Boolean
Returns true when the media player is prepared to start media playback. When returning false, app may listen to onPreparedStateChanged event.
| Returns | |
|---|---|
Boolean |
True if prepared, false otherwise. |
play
fun play(): Unit
Starts the media player. Does nothing if isPrepared is false. To wait isPrepared to be true before playing, use playWhenPrepared.
playWhenPrepared
fun playWhenPrepared(): Unit
Starts play when isPrepared becomes true.
previous
fun previous(): Unit
Goes to the previous media item. This method is optional.
removePlayerCallback
fun removePlayerCallback(callback: PlaybackGlue.PlayerCallback): Unit
Remove a PlayerCallback.
| Parameters | |
|---|---|
callback: PlaybackGlue.PlayerCallback |
The callback to remove. |
setHost
fun setHost(host: PlaybackGlueHost?): Unit
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 functions
getPlayerCallbacks
protected fun getPlayerCallbacks(): (Mutable)List<PlaybackGlue.PlayerCallback!>?
| Returns | |
|---|---|
(Mutable)List<PlaybackGlue.PlayerCallback!>? |
A snapshot of list of PlayerCallbacks set on the Glue. |
onAttachedToHost
@CallSuper
protected fun onAttachedToHost(host: PlaybackGlueHost): Unit
This method is called attached to associated PlaybackGlueHost. Subclass may override and call super.onAttachedToHost().
onDetachedFromHost
@CallSuper
protected fun onDetachedFromHost(): Unit
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 fun onHostPause(): Unit
This method is called when PlaybackGlueHost is paused. Subclass may override.
onHostResume
protected fun onHostResume(): Unit
This method is called when PlaybackGlueHost is resumed. Subclass may override.
onHostStart
protected fun onHostStart(): Unit
This method is called when PlaybackGlueHost is started. Subclass may override.
onHostStop
protected fun onHostStop(): Unit
This method is called when PlaybackGlueHost is stopped. Subclass may override.