belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1
PlayerAdapter
public
abstract
class
PlayerAdapter
extends Object
java.lang.Object | |
↳ | android.support.v17.leanback.media.PlayerAdapter |
Known Direct Subclasses |
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
.
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 |
void
|
onDetachedFromHost()
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(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 | |
---|---|
From
class
java.lang.Object
|
Public constructors
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 |
getCallback
PlayerAdapter.Callback getCallback ()
Gets callback for event of PlayerAdapter.
Returns | |
---|---|
PlayerAdapter.Callback |
Client for event of PlayerAdapter. |
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 |
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 |
isPrepared
boolean isPrepared ()
Returns | |
---|---|
boolean |
True if media is ready for playback, false otherwise. |
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.
|
setCallback
void setCallback (PlayerAdapter.Callback callback)
Sets callback for event of PlayerAdapter.
Parameters | |
---|---|
callback |
PlayerAdapter.Callback : Client for event of PlayerAdapter.
|
setProgressUpdatingEnabled
void setProgressUpdatingEnabled (boolean enable)
Implement this method to enable or disable progress updating.
Parameters | |
---|---|
enable |
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
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-11 UTC.