belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1
MediaControllerAdapter
public
class
MediaControllerAdapter
extends PlayerAdapter
java.lang.Object | ||
↳ | android.support.v17.leanback.media.PlayerAdapter | |
↳ | android.support.v17.leanback.media.MediaControllerAdapter |
A helper class for implementing a adapter layer for MediaControllerCompat
.
Summary
Public constructors | |
---|---|
MediaControllerAdapter(MediaControllerCompat controller)
Constructor for the adapter using |
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 |
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 |
void
|
onDetachedFromHost()
This method is called when current associated |
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 | |
---|---|
From
class
android.support.v17.leanback.media.PlayerAdapter
| |
From
class
java.lang.Object
|
Public constructors
MediaControllerAdapter
MediaControllerAdapter (MediaControllerCompat controller)
Constructor for the adapter using MediaControllerCompat
.
Parameters | |
---|---|
controller |
MediaControllerCompat : Object of MediaControllerCompat..
|
Public methods
fastForward
void fastForward ()
Optional method. Override this method if getSupportedActions()
include
ACTION_FAST_FORWARD
to fast
forward current media item.
getBufferedPosition
long getBufferedPosition ()
Returns the current buffered position of the media item in milliseconds.
Returns | |
---|---|
long |
getCurrentPosition
long getCurrentPosition ()
Returns the current position of the media item in milliseconds.
Returns | |
---|---|
long |
getDuration
long getDuration ()
Returns the duration of the media item in milliseconds.
Returns | |
---|---|
long |
getMediaArt
Drawable getMediaArt (Context context)
Get current media's drawable art.
Parameters | |
---|---|
context |
Context |
Returns | |
---|---|
Drawable |
Drawable art of current media. |
getMediaController
MediaControllerCompat getMediaController ()
Return the object of MediaControllerCompat
from this class.
Returns | |
---|---|
MediaControllerCompat |
Media Controller Compat object owned by this class. |
getMediaSubtitle
CharSequence getMediaSubtitle ()
Get current media's subtitle.
Returns | |
---|---|
CharSequence |
Subtitle of current media. |
getMediaTitle
CharSequence getMediaTitle ()
Get current media's title.
Returns | |
---|---|
CharSequence |
Title of current media. |
getSupportedActions
long getSupportedActions ()
Return xor combination of values defined in PlaybackBaseControlGlue. Default is PLAY_PAUSE (unless subclass enforce to be 0)
Returns | |
---|---|
long |
isPlaying
boolean isPlaying ()
Returns true if media is currently playing.
Returns | |
---|---|
boolean |
next
void next ()
Optional method. Override this method if getSupportedActions()
include
ACTION_SKIP_TO_NEXT
to skip
to next item.
onAttachedToHost
void onAttachedToHost (PlaybackGlueHost host)
This method is called attached to associated PlaybackGlueHost
.
onDetachedFromHost
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
void previous ()
Optional method. Override this method if getSupportedActions()
include
ACTION_SKIP_TO_PREVIOUS
to skip
to previous item.
rewind
void rewind ()
Optional method. Override this method if getSupportedActions()
include
ACTION_REWIND
to rewind in
current media item.
seekTo
void seekTo (long positionInMs)
Seek to new position.
Parameters | |
---|---|
positionInMs |
long : New position in milliseconds.
|
setProgressUpdatingEnabled
void setProgressUpdatingEnabled (boolean enabled)
Implement this method to enable or disable progress updating.
Parameters | |
---|---|
enabled |
boolean : True to enable progress updating, false otherwise.
|
setRepeatAction
void setRepeatAction (int repeatActionIndex)
Optional method. Override this method if getSupportedActions()
include
ACTION_REPEAT
to set the repeat action.
Parameters | |
---|---|
repeatActionIndex |
int : The shuffle action. Must be one of the followings:
INDEX_ONE
INDEX_ALL ,
INDEX_NONE ,
|
setShuffleAction
void setShuffleAction (int shuffleActionIndex)
Optional method. Override this method if getSupportedActions()
include
ACTION_SHUFFLE
to set the shuffle action.
Parameters | |
---|---|
shuffleActionIndex |
int : The repeat action. Must be one of the followings:
INDEX_OFF
INDEX_ON
|
Interfaces
Classes
- MediaControllerAdapter
- MediaControllerGlue
- MediaPlayerAdapter
- PlaybackBannerControlGlue
- PlaybackBaseControlGlue
- PlaybackControlGlue
- PlaybackGlue
- PlaybackGlue.PlayerCallback
- PlaybackGlueHost
- PlaybackGlueHost.HostCallback
- PlaybackGlueHost.PlayerCallback
- PlaybackTransportControlGlue
- PlayerAdapter
- PlayerAdapter.Callback