PlayerAdapter
public abstract class PlayerAdapter
LeanbackPlayerAdapter |
Leanback |
MediaControllerAdapter |
A helper class for implementing a adapter layer for |
MediaPlayerAdapter |
This implementation extends the |
Base class that wraps underlying media player. The class is used by PlaybackGlue, for example PlaybackTransportControlGlue is bound to a PlayerAdapter. This class is intended to be subclassed, MediaPlayerAdapter is a concrete subclass using android.media.MediaPlayer. ExoPlayer also provides a leanback extension that implements PlayerAdapter. Please see ExoPlayer https://developer.android.com/guide/topics/media/exoplayer
Summary
Nested types |
|---|
public class PlayerAdapter.CallbackClient for client of PlayerAdapter. |
Public constructors |
|---|
Public methods |
|
|---|---|
void |
Optional method. |
long |
Returns the current buffered position of the media item in milliseconds. |
final @Nullable PlayerAdapter.Callback |
Gets callback for event of PlayerAdapter. |
long |
Returns the current position of the media item in milliseconds. |
long |
Returns the duration of the media item in milliseconds. |
long |
Return xor combination of values defined in PlaybackBaseControlGlue. |
boolean |
Returns true if media is currently playing. |
boolean |
|
void |
next()Optional method. |
void |
This method is called attached to associated |
void |
This method is called when current associated |
abstract void |
pause()Pauses the media player. |
abstract void |
play()Starts the media player. |
void |
previous()Optional method. |
void |
rewind()Optional method. |
void |
seekTo(long positionInMs)Seek to new position. |
final void |
setCallback(@Nullable PlayerAdapter.Callback callback)Sets callback for event of PlayerAdapter. |
void |
setProgressUpdatingEnabled(boolean enable)Implement this method to enable or disable progress updating. |
void |
setRepeatAction(int repeatActionIndex)Optional method. |
void |
setShuffleAction(int shuffleActionIndex)Optional method. |
Public constructors
Public methods
fastForward
public void fastForward()
Optional method. Override this method if getSupportedActions include ACTION_FAST_FORWARD to fast forward current media item.
getBufferedPosition
public long getBufferedPosition()
Returns the current buffered position of the media item in milliseconds.
getCallback
public final @Nullable PlayerAdapter.Callback getCallback()
Gets callback for event of PlayerAdapter.
| Returns | |
|---|---|
@Nullable PlayerAdapter.Callback |
Client for event of PlayerAdapter. |
getCurrentPosition
public long getCurrentPosition()
Returns the current position of the media item in milliseconds.
getDuration
public long getDuration()
Returns the duration of the media item in milliseconds.
getSupportedActions
public long getSupportedActions()
Return xor combination of values defined in PlaybackBaseControlGlue. Default is PLAY_PAUSE (unless subclass enforce to be 0)
isPrepared
public boolean isPrepared()
| Returns | |
|---|---|
boolean |
True if media is ready for playback, false otherwise. |
next
public void next()
Optional method. Override this method if getSupportedActions include ACTION_SKIP_TO_NEXT to skip to next item.
onAttachedToHost
public void onAttachedToHost(@NonNull PlaybackGlueHost host)
This method is called attached to associated PlaybackGlueHost.
| Parameters | |
|---|---|
@NonNull PlaybackGlueHost host |
onDetachedFromHost
public void onDetachedFromHost()
This method is called when current associated PlaybackGlueHost is attached to a different PlaybackGlue or PlaybackGlueHost is destroyed. Subclass may override. A typical implementation will release resources (e.g. MediaPlayer or connection to playback service) in this method.
previous
public void previous()
Optional method. Override this method if getSupportedActions include ACTION_SKIP_TO_PREVIOUS to skip to previous item.
rewind
public void rewind()
Optional method. Override this method if getSupportedActions include ACTION_REWIND to rewind in current media item.
seekTo
public void seekTo(long positionInMs)
Seek to new position.
| Parameters | |
|---|---|
long positionInMs |
New position in milliseconds. |
setCallback
public final void setCallback(@Nullable PlayerAdapter.Callback callback)
Sets callback for event of PlayerAdapter.
| Parameters | |
|---|---|
@Nullable PlayerAdapter.Callback callback |
Client for event of PlayerAdapter. |
setProgressUpdatingEnabled
public void setProgressUpdatingEnabled(boolean enable)
Implement this method to enable or disable progress updating.
| Parameters | |
|---|---|
boolean enable |
True to enable progress updating, false otherwise. |
setRepeatAction
public void setRepeatAction(int repeatActionIndex)
Optional method. Override this method if getSupportedActions include ACTION_REPEAT to set the repeat action.
| Parameters | |
|---|---|
int repeatActionIndex |
The shuffle action. Must be one of the followings: |
setShuffleAction
public void setShuffleAction(int shuffleActionIndex)
Optional method. Override this method if getSupportedActions include ACTION_SHUFFLE to set the shuffle action.