added in version 1.0.0
belongs to Maven artifact androidx.leanback:leanback:1.0.0-beta01

PlayerAdapter

public abstract class PlayerAdapter
extends Object

java.lang.Object
   ↳ androidx.leanback.media.PlayerAdapter


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 MediaPlayer. ExoPlayer also provides a leanback extension that implements PlayerAdapter. Please see ExoPlayer https://developer.android.com/guide/topics/media/exoplayer

Summary

Nested classes

class PlayerAdapter.Callback

Client for client of PlayerAdapter. 

Public constructors

PlayerAdapter()

Public methods

void fastForward()

Optional method.

long getBufferedPosition()

Returns the current buffered position of the media item in milliseconds.

final PlayerAdapter.Callback getCallback()

Gets callback for event of PlayerAdapter.

long getCurrentPosition()

Returns the current position of the media item in milliseconds.

long getDuration()

Returns the duration of the media item in milliseconds.

long getSupportedActions()

Return xor combination of values defined in PlaybackBaseControlGlue.

boolean isPlaying()

Returns true if media is currently playing.

boolean isPrepared()
void next()

Optional method.

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.

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(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.

Inherited methods

Public constructors

PlayerAdapter

added in version 1.0.0
public PlayerAdapter ()

Public methods

fastForward

added in version 1.0.0
public void fastForward ()

Optional method. Override this method if getSupportedActions() include PlaybackBaseControlGlue.ACTION_FAST_FORWARD to fast forward current media item.

getBufferedPosition

added in version 1.0.0
public long getBufferedPosition ()

Returns the current buffered position of the media item in milliseconds.

Returns
long

getCallback

added in version 1.0.0
public final PlayerAdapter.Callback getCallback ()

Gets callback for event of PlayerAdapter.

Returns
PlayerAdapter.Callback Client for event of PlayerAdapter.

getCurrentPosition

added in version 1.0.0
public long getCurrentPosition ()

Returns the current position of the media item in milliseconds.

Returns
long

getDuration

added in version 1.0.0
public long getDuration ()

Returns the duration of the media item in milliseconds.

Returns
long

getSupportedActions

added in version 1.0.0
public long getSupportedActions ()

Return xor combination of values defined in PlaybackBaseControlGlue. Default is PLAY_PAUSE (unless subclass enforce to be 0)

Returns
long

isPlaying

added in version 1.0.0
public boolean isPlaying ()

Returns true if media is currently playing.

Returns
boolean

isPrepared

added in version 1.0.0
public boolean isPrepared ()

Returns
boolean True if media is ready for playback, false otherwise.

next

added in version 1.0.0
public void next ()

Optional method. Override this method if getSupportedActions() include PlaybackBaseControlGlue.ACTION_SKIP_TO_NEXT to skip to next item.

onAttachedToHost

added in version 1.0.0
public void onAttachedToHost (PlaybackGlueHost host)

This method is called attached to associated PlaybackGlueHost.

onDetachedFromHost

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

pause

added in version 1.0.0
public abstract void pause ()

Pauses the media player.

play

added in version 1.0.0
public abstract void play ()

Starts the media player.

previous

added in version 1.0.0
public void previous ()

Optional method. Override this method if getSupportedActions() include PlaybackBaseControlGlue.ACTION_SKIP_TO_PREVIOUS to skip to previous item.

rewind

added in version 1.0.0
public void rewind ()

Optional method. Override this method if getSupportedActions() include PlaybackBaseControlGlue.ACTION_REWIND to rewind in current media item.

seekTo

added in version 1.0.0
public void seekTo (long positionInMs)

Seek to new position.

Parameters
positionInMs long: New position in milliseconds.

setCallback

added in version 1.0.0
public final void setCallback (PlayerAdapter.Callback callback)

Sets callback for event of PlayerAdapter.

Parameters
callback PlayerAdapter.Callback: Client for event of PlayerAdapter.

setProgressUpdatingEnabled

added in version 1.0.0
public void setProgressUpdatingEnabled (boolean enable)

Implement this method to enable or disable progress updating.

Parameters
enable boolean: True to enable progress updating, false otherwise.

setRepeatAction

added in version 1.0.0
public void setRepeatAction (int repeatActionIndex)

Optional method. Override this method if getSupportedActions() include PlaybackBaseControlGlue.ACTION_REPEAT to set the repeat action.

Parameters
repeatActionIndex int: The shuffle action. Must be one of the followings: PlaybackControlsRow.RepeatAction.INDEX_ONE PlaybackControlsRow.RepeatAction.INDEX_ALL, PlaybackControlsRow.RepeatAction.INDEX_NONE,

setShuffleAction

added in version 1.0.0
public void setShuffleAction (int shuffleActionIndex)

Optional method. Override this method if getSupportedActions() include PlaybackBaseControlGlue.ACTION_SHUFFLE to set the shuffle action.

Parameters
shuffleActionIndex int: The repeat action. Must be one of the followings: PlaybackControlsRow.ShuffleAction.INDEX_OFF PlaybackControlsRow.ShuffleAction.INDEX_ON