lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

belongs to Maven artifact androidx.leanback:leanback:1.0.0-alpha3

MediaControllerAdapter

public class MediaControllerAdapter
extends PlayerAdapter

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


A helper class for implementing a adapter layer for MediaControllerCompat.

Summary

Public constructors

MediaControllerAdapter(MediaControllerCompat controller)

Constructor for the adapter using MediaControllerCompat.

Public methods

void fastForward()

Optional method.

long getBufferedPosition()

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

long getCurrentPosition()

Returns the current position of the media item in milliseconds.

long getDuration()

Returns the duration of the media item in milliseconds.

Drawable getMediaArt(Context context)

Get current media's drawable art.

MediaControllerCompat getMediaController()

Return the object of MediaControllerCompat from this class.

CharSequence getMediaSubtitle()

Get current media's subtitle.

CharSequence getMediaTitle()

Get current media's title.

long getSupportedActions()

Return xor combination of values defined in PlaybackBaseControlGlue.

boolean isPlaying()

Returns true if media is currently playing.

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.

void pause()

Pauses the media player.

void play()

Starts the media player.

void previous()

Optional method.

void rewind()

Optional method.

void seekTo(long positionInMs)

Seek to new position.

void setProgressUpdatingEnabled(boolean enabled)

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

MediaControllerAdapter

public MediaControllerAdapter (MediaControllerCompat controller)

Constructor for the adapter using MediaControllerCompat.

Parameters
controller MediaControllerCompat: Object of MediaControllerCompat..

Public methods

fastForward

public void fastForward ()

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

getBufferedPosition

public long getBufferedPosition ()

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

Returns
long

getCurrentPosition

public long getCurrentPosition ()

Returns the current position of the media item in milliseconds.

Returns
long

getDuration

public long getDuration ()

Returns the duration of the media item in milliseconds.

Returns
long

getMediaArt

public Drawable getMediaArt (Context context)

Get current media's drawable art.

Parameters
context Context

Returns
Drawable Drawable art of current media.

getMediaController

public MediaControllerCompat getMediaController ()

Return the object of MediaControllerCompat from this class.

Returns
MediaControllerCompat Media Controller Compat object owned by this class.

getMediaSubtitle

public CharSequence getMediaSubtitle ()

Get current media's subtitle.

Returns
CharSequence Subtitle of current media.

getMediaTitle

public CharSequence getMediaTitle ()

Get current media's title.

Returns
CharSequence Title of current media.

getSupportedActions

public long getSupportedActions ()

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

Returns
long

isPlaying

public boolean isPlaying ()

Returns true if media is currently playing.

Returns
boolean

next

public void next ()

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

onAttachedToHost

public void onAttachedToHost (PlaybackGlueHost host)

This method is called attached to associated PlaybackGlueHost.

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.

pause

public void pause ()

Pauses the media player.

play

public void play ()

Starts the media player.

previous

public void previous ()

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

rewind

public void rewind ()

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

seekTo

public void seekTo (long positionInMs)

Seek to new position.

Parameters
positionInMs long: New position in milliseconds.

setProgressUpdatingEnabled

public void setProgressUpdatingEnabled (boolean enabled)

Implement this method to enable or disable progress updating.

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

setRepeatAction

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

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