SessionPlayer

Added in 1.0.0
Deprecated in 1.3.0

abstract class SessionPlayer : Closeable

Known direct subclasses
MediaPlayer

This class is deprecated.

androidx.media2 is deprecated.

RemoteSessionPlayer

This class is deprecated.

androidx.media2 is deprecated.


Base interface for all media players that want media session.

APIs that return ListenableFuture should be the asynchronous calls and shouldn't block the calling thread. This guarantees the APIs are safe to be called on the main thread.

Topics covered here are:

  1. Best practices
  2. Player states
  3. Invalid method calls

Best practices

Here are best practices when implementing/using SessionPlayer:
  • When updating UI, you should respond to PlayerCallback invocations instead of PlayerResult objects since the player can be controlled by others.
  • When a SessionPlayer object is no longer being used, call close as soon as possible to release the resources used by the internal player engine associated with the SessionPlayer. For example, if a player uses hardware decoder, other player instances may fallback to software decoders or fail to play. You cannot use SessionPlayer instance after you call close. There is no way to reuse the instance.
  • The current playback position can be retrieved with a call to getCurrentPosition, which is helpful for applications such as a music player that need to keep track of the playback progress.
  • The playback position can be adjusted with a call to seekTo. Although the asynchronous seekTo call returns right away, the actual seek operation may take a while to finish, especially for audio/video being streamed.
  • You can call seekTo from the PLAYER_STATE_PAUSED. In these cases, if you are playing a video stream and the requested position is valid, one video frame may be displayed.

Player states

The playback control of audio/video files is managed as a state machine. The SessionPlayer defines four states:
  1. PLAYER_STATE_IDLE: Initial state after the instantiation.

    While in this state, you should call setMediaItem or setPlaylist. Check returned ListenableFuture for potential error.

    Calling prepare transfers this object to PLAYER_STATE_PAUSED.

  2. PLAYER_STATE_PAUSED: State when the audio/video playback is paused.

    Call play to resume or start playback from the position where it paused.

  3. PLAYER_STATE_PLAYING: State when the player plays the media item.

    In this state, onBufferingStateChanged will be called regularly to tell the buffering status.

    Playback state would remain PLAYER_STATE_PLAYING when the currently playing media item is changed.

    When the playback reaches the end of stream, the behavior depends on repeat mode, set by setRepeatMode. If the repeat mode was set to REPEAT_MODE_NONE, the player will transfer to the PLAYER_STATE_PAUSED. Otherwise, the SessionPlayer object remains in the PLAYER_STATE_PLAYING and playback will be ongoing.

  4. PLAYER_STATE_ERROR: State when the playback failed and player cannot be recovered by itself.

    In general, playback might fail due to various reasons such as unsupported audio/video format, poorly interleaved audio/video, resolution too high, streaming timeout, and others. In addition, due to programming errors, a playback control operation might be performed from an invalid state. In these cases the player may transition to this state.

Subclasses may have extra methods to reset the player state to PLAYER_STATE_IDLE from other states. Take a look at documentations of specific subclass that you're interested in.

Invalid method calls

The only method you safely call from the PLAYER_STATE_ERROR is close. Any other methods might return meaningless data.

Subclasses of the SessionPlayer may have extra methods that are safe to be called in the error state and/or provide a method to recover from the error state. Take a look at documentations of specific subclass that you're interested in.

Most methods can be called from any non-Error state. In case they're called in invalid state, the implementation should ignore and would return PlayerResult with RESULT_ERROR_INVALID_STATE. The following table lists the methods that aren't guaranteed to successfully running if they're called from the associated invalid states.

Method Name Invalid States
setAudioAttributes {Paused, Playing}
prepare {Paused, Playing}
play {Idle}
pause {Idle}
seekTo {Idle}

Summary

Nested types

This class is deprecated.

androidx.media2 is deprecated.

This class is deprecated.

androidx.media2 is deprecated.

This class is deprecated.

androidx.media2 is deprecated.

Constants

const Int

Buffering state indicating the player is buffering but enough has been buffered for this player to be able to play the content.

const Int

Buffering state indicating the player is buffering, but the player is currently starved for data, and cannot play.

const Int

Buffering state indicating the player is done buffering, and the remainder of the content is available for playback.

const Int

Buffering state is unknown.

const Int

Media item index is invalid.

const Int

State when the player is in error state and cannot be recovered self.

const Int

State when the player is idle, and needs configuration to start playback.

const Int

State when the player's playback is paused

const Int

State when the player's playback is ongoing

const Int

Playing media list will be repeated.

const Int

Playback of the playing media group will be repeated.

const Int

Playback will be stopped at the end of the playing media list.

const Int

Playback of the current playing media item will be repeated.

const Int

Media list will be played in shuffled order.

const Int

Media group will be played in shuffled order.

const Int

Media list will be played in order.

const Long
UNKNOWN_TIME = -9223372036854775808

Value indicating the time is unknown

Public constructors

Public functions

abstract ListenableFuture<SessionPlayer.PlayerResult!>
addPlaylistItem(index: Int, item: MediaItem)

Adds the media item to the playlist at the index.

Unit

Removes all existing references to callbacks and executors.

ListenableFuture<SessionPlayer.PlayerResult!>

Deselects the TrackInfo for the current media item.

abstract AudioAttributesCompat?

Gets the AudioAttributesCompat that media player has.

abstract Long

Gets the position for how much has been buffered, or UNKNOWN_TIME if unknown.

abstract Int

Returns the current buffering state of the player.

abstract MediaItem?

Gets the current media item, which is currently playing or would be played with later play.

abstract @IntRange(from = -1) Int

Gets the index of current media item in playlist.

abstract Long

Gets the current playback position.

abstract Long

Gets the duration of the current media item, or UNKNOWN_TIME if unknown.

abstract @IntRange(from = -1) Int

Gets the next item index in the playlist.

abstract Float

Gets the actual playback speed to be used by the player when playing.

abstract Int

Gets the current player state.

abstract (Mutable)List<MediaItem!>?

Gets the playlist.

abstract MediaMetadata?

Gets the playlist metadata.

abstract @IntRange(from = -1) Int

Gets the previous item index in the playlist.

abstract Int

Gets the repeat mode.

SessionPlayer.TrackInfo?
getSelectedTrack(trackType: Int)

Gets currently selected track's TrackInfo for the given track type.

abstract Int

Gets the shuffle mode.

(Mutable)List<SessionPlayer.TrackInfo!>

Gets the full list of selected and unselected tracks that the media contains.

VideoSize

Gets the size of the video.

ListenableFuture<SessionPlayer.PlayerResult!>
movePlaylistItem(
    fromIndex: @IntRange(from = 0) Int,
    toIndex: @IntRange(from = 0) Int
)

Moves the media item at fromIdx to toIdx in the playlist.

abstract ListenableFuture<SessionPlayer.PlayerResult!>

Pauses playback.

abstract ListenableFuture<SessionPlayer.PlayerResult!>

Starts or resumes playback.

abstract ListenableFuture<SessionPlayer.PlayerResult!>

Prepares the media items for playback.

Unit
registerPlayerCallback(
    executor: Executor,
    callback: SessionPlayer.PlayerCallback
)

Register PlayerCallback to listen changes.

abstract ListenableFuture<SessionPlayer.PlayerResult!>
removePlaylistItem(index: @IntRange(from = 0) Int)

Removes the media item from the playlist

abstract ListenableFuture<SessionPlayer.PlayerResult!>

Replaces the media item at index in the playlist.

abstract ListenableFuture<SessionPlayer.PlayerResult!>
seekTo(position: Long)

Seeks to the specified position.

ListenableFuture<SessionPlayer.PlayerResult!>

Selects the TrackInfo for the current media item.

abstract ListenableFuture<SessionPlayer.PlayerResult!>

Sets the AudioAttributesCompat to be used during the playback of the media.

abstract ListenableFuture<SessionPlayer.PlayerResult!>

Sets a MediaItem for playback.

abstract ListenableFuture<SessionPlayer.PlayerResult!>
setPlaybackSpeed(playbackSpeed: Float)

Sets the playback speed.

abstract ListenableFuture<SessionPlayer.PlayerResult!>

Sets a list of MediaItem with metadata.

abstract ListenableFuture<SessionPlayer.PlayerResult!>
setRepeatMode(repeatMode: Int)

Sets the repeat mode.

abstract ListenableFuture<SessionPlayer.PlayerResult!>
setShuffleMode(shuffleMode: Int)

Sets the shuffle mode.

ListenableFuture<SessionPlayer.PlayerResult!>
setSurface(surface: Surface?)

Sets the Surface to be used as the sink for the video portion of the media.

abstract ListenableFuture<SessionPlayer.PlayerResult!>

Skips to the next item in the playlist.

abstract ListenableFuture<SessionPlayer.PlayerResult!>
skipToPlaylistItem(index: @IntRange(from = 0) Int)

Skips to the item in the playlist at the index.

abstract ListenableFuture<SessionPlayer.PlayerResult!>

Skips to the previous item in the playlist.

Unit

Unregister the previously registered PlayerCallback.

abstract ListenableFuture<SessionPlayer.PlayerResult!>

Updates the playlist metadata while keeping the playlist as-is.

Protected functions

(Mutable)List<Pair<SessionPlayer.PlayerCallback!, Executor!>!>

Gets the callbacks with executors for subclasses to notify player events.

Constants

BUFFERING_STATE_BUFFERING_AND_PLAYABLE

Added in 1.0.0
Deprecated in 1.3.0
const val BUFFERING_STATE_BUFFERING_AND_PLAYABLE = 1: Int

Buffering state indicating the player is buffering but enough has been buffered for this player to be able to play the content. See getBufferedPosition for how far is buffered already.

BUFFERING_STATE_BUFFERING_AND_STARVED

Added in 1.0.0
Deprecated in 1.3.0
const val BUFFERING_STATE_BUFFERING_AND_STARVED = 2: Int

Buffering state indicating the player is buffering, but the player is currently starved for data, and cannot play.

BUFFERING_STATE_COMPLETE

Added in 1.0.0
Deprecated in 1.3.0
const val BUFFERING_STATE_COMPLETE = 3: Int

Buffering state indicating the player is done buffering, and the remainder of the content is available for playback.

BUFFERING_STATE_UNKNOWN

Added in 1.0.0
Deprecated in 1.3.0
const val BUFFERING_STATE_UNKNOWN = 0: Int

Buffering state is unknown.

INVALID_ITEM_INDEX

Added in 1.0.0
Deprecated in 1.3.0
const val INVALID_ITEM_INDEX = -1: Int

Media item index is invalid. This value will be returned when the corresponding media item does not exist.

PLAYER_STATE_ERROR

Added in 1.0.0
Deprecated in 1.3.0
const val PLAYER_STATE_ERROR = 3: Int

State when the player is in error state and cannot be recovered self.

PLAYER_STATE_IDLE

Added in 1.0.0
Deprecated in 1.3.0
const val PLAYER_STATE_IDLE = 0: Int

State when the player is idle, and needs configuration to start playback.

PLAYER_STATE_PAUSED

Added in 1.0.0
Deprecated in 1.3.0
const val PLAYER_STATE_PAUSED = 1: Int

State when the player's playback is paused

PLAYER_STATE_PLAYING

Added in 1.0.0
Deprecated in 1.3.0
const val PLAYER_STATE_PLAYING = 2: Int

State when the player's playback is ongoing

REPEAT_MODE_ALL

Added in 1.0.0
Deprecated in 1.3.0
const val REPEAT_MODE_ALL = 2: Int

Playing media list will be repeated.

REPEAT_MODE_GROUP

Added in 1.0.0
Deprecated in 1.3.0
const val REPEAT_MODE_GROUP = 3: Int

Playback of the playing media group will be repeated. A group is a logical block of media items which is specified in the section 5.7 of the Bluetooth AVRCP 1.6. An example of a group is the playlist.

REPEAT_MODE_NONE

Added in 1.0.0
Deprecated in 1.3.0
const val REPEAT_MODE_NONE = 0: Int

Playback will be stopped at the end of the playing media list.

REPEAT_MODE_ONE

Added in 1.0.0
Deprecated in 1.3.0
const val REPEAT_MODE_ONE = 1: Int

Playback of the current playing media item will be repeated.

SHUFFLE_MODE_ALL

Added in 1.0.0
Deprecated in 1.3.0
const val SHUFFLE_MODE_ALL = 1: Int

Media list will be played in shuffled order.

SHUFFLE_MODE_GROUP

Added in 1.0.0
Deprecated in 1.3.0
const val SHUFFLE_MODE_GROUP = 2: Int

Media group will be played in shuffled order. A group is a logical block of media items which is specified in the section 5.7 of the Bluetooth AVRCP 1.6. An example of a group is the playlist.

SHUFFLE_MODE_NONE

Added in 1.0.0
Deprecated in 1.3.0
const val SHUFFLE_MODE_NONE = 0: Int

Media list will be played in order.

UNKNOWN_TIME

Added in 1.0.0
Deprecated in 1.3.0
const val UNKNOWN_TIME = -9223372036854775808: Long

Value indicating the time is unknown

Public constructors

SessionPlayer

Added in 1.0.0
Deprecated in 1.3.0
SessionPlayer()

Public functions

addPlaylistItem

Added in 1.0.0
Deprecated in 1.3.0
abstract fun addPlaylistItem(index: Int, item: MediaItem): ListenableFuture<SessionPlayer.PlayerResult!>

Adds the media item to the playlist at the index. Index equals to or greater than the current playlist size (e.g. MAX_VALUE) will add the item at the end of the playlist.

If index is less than or equal to the current index of the playlist, the current index of the playlist should be increased correspondingly.

The implementation must notify registered callbacks with onPlaylistChanged when it's completed.

The implementation must close the ParcelFileDescriptor in the FileMediaItem if the given media item is a FileMediaItem.

On success, a PlayerResult should be returned with item added.

Parameters
index: Int

the index of the item you want to add in the playlist

item: MediaItem

the media item you want to add

close

Added in 1.1.0
Deprecated in 1.3.0
@CallSuper
fun close(): Unit

Removes all existing references to callbacks and executors. Note: Sub classes of SessionPlayer that override this API should call this super method.

deselectTrack

Added in 1.1.0
Deprecated in 1.3.0
fun deselectTrack(trackInfo: SessionPlayer.TrackInfo): ListenableFuture<SessionPlayer.PlayerResult!>

Deselects the TrackInfo for the current media item.

Generally, a track should already be selected in order to be deselected, and audio and video tracks should not be deselected.

The types of tracks supported may vary based on player implementation.

Note: getSelectedTrack returns the currently selected track per track type that can be deselected, but the list may be invalidated when onTracksChanged is called.

Parameters
trackInfo: SessionPlayer.TrackInfo

track to be deselected

Returns
ListenableFuture<SessionPlayer.PlayerResult!>

a ListenableFuture which represents the pending completion of the command

getAudioAttributes

Added in 1.0.0
Deprecated in 1.3.0
abstract fun getAudioAttributes(): AudioAttributesCompat?

Gets the AudioAttributesCompat that media player has.

getBufferedPosition

Added in 1.0.0
Deprecated in 1.3.0
abstract fun getBufferedPosition(): Long

Gets the position for how much has been buffered, or UNKNOWN_TIME if unknown.

The position is the relative position based on the getStartPosition. So the position 0 means the start position of the MediaItem.

Returns
Long

the buffered position in ms, or UNKNOWN_TIME if unknown

getBufferingState

Added in 1.0.0
Deprecated in 1.3.0
abstract fun getBufferingState(): Int

Returns the current buffering state of the player.

During the buffering, see getBufferedPosition for the quantifying the amount already buffered.

Returns
Int

the buffering state, or BUFFERING_STATE_UNKNOWN if unknown

getCurrentMediaItem

Added in 1.0.0
Deprecated in 1.3.0
abstract fun getCurrentMediaItem(): MediaItem?

Gets the current media item, which is currently playing or would be played with later play. This value may be updated when onCurrentMediaItemChanged or onPlaylistChanged is called.

Returns
MediaItem?

the current media item. Can be null only when the player is in PLAYER_STATE_IDLE and a media item or playlist hasn't been set.

getCurrentMediaItemIndex

Added in 1.0.0
Deprecated in 1.3.0
abstract fun getCurrentMediaItemIndex(): @IntRange(from = -1) Int

Gets the index of current media item in playlist. This value should be updated when onCurrentMediaItemChanged or onPlaylistChanged is called.

Returns
@IntRange(from = -1) Int

the index of current media item. Can be INVALID_ITEM_INDEX when current media item is null or not in the playlist, and when the playlist hasn't been set.

getCurrentPosition

Added in 1.0.0
Deprecated in 1.3.0
abstract fun getCurrentPosition(): Long

Gets the current playback position.

The position is the relative position based on the getStartPosition. So the position 0 means the start position of the MediaItem.

Returns
Long

the current playback position in ms, or UNKNOWN_TIME if unknown

getDuration

Added in 1.0.0
Deprecated in 1.3.0
abstract fun getDuration(): Long

Gets the duration of the current media item, or UNKNOWN_TIME if unknown. If the current MediaItem has either start or end position, then duration would be adjusted accordingly instead of returning the whole size of the MediaItem.

Returns
Long

the duration in ms, or UNKNOWN_TIME if unknown

getNextMediaItemIndex

Added in 1.0.0
Deprecated in 1.3.0
abstract fun getNextMediaItemIndex(): @IntRange(from = -1) Int

Gets the next item index in the playlist. This value should be updated when onCurrentMediaItemChanged or onPlaylistChanged is called.

Returns
@IntRange(from = -1) Int

the index of next media item. Can be INVALID_ITEM_INDEX only when next media item does not exist or playlist hasn't been set.

getPlaybackSpeed

Added in 1.0.0
Deprecated in 1.3.0
abstract fun getPlaybackSpeed(): Float

Gets the actual playback speed to be used by the player when playing. A value of 1.0f is the default playback value, and a negative value indicates reverse playback.

Note that it may differ from the speed set in setPlaybackSpeed.

Returns
Float

the actual playback speed

getPlayerState

Added in 1.0.0
Deprecated in 1.3.0
abstract fun getPlayerState(): Int

Gets the current player state.

Returns
Int

the current player state

getPlaylist

Added in 1.0.0
Deprecated in 1.3.0
abstract fun getPlaylist(): (Mutable)List<MediaItem!>?

Gets the playlist. It can be null if the playlist hasn't been set or it's reset by setMediaItem.

Returns
(Mutable)List<MediaItem!>?

playlist, or null

getPlaylistMetadata

Added in 1.0.0
Deprecated in 1.3.0
abstract fun getPlaylistMetadata(): MediaMetadata?

Gets the playlist metadata.

Returns
MediaMetadata?

metadata metadata of the playlist, or null if none is set

getPreviousMediaItemIndex

Added in 1.0.0
Deprecated in 1.3.0
abstract fun getPreviousMediaItemIndex(): @IntRange(from = -1) Int

Gets the previous item index in the playlist. This value should be updated when onCurrentMediaItemChanged or onPlaylistChanged is called.

Returns
@IntRange(from = -1) Int

the index of previous media item. Can be INVALID_ITEM_INDEX only when previous media item does not exist or playlist hasn't been set.

getRepeatMode

Added in 1.0.0
Deprecated in 1.3.0
abstract fun getRepeatMode(): Int

Gets the repeat mode.

Returns
Int

repeat mode

getSelectedTrack

Added in 1.1.0
Deprecated in 1.3.0
fun getSelectedTrack(trackType: Int): SessionPlayer.TrackInfo?

Gets currently selected track's TrackInfo for the given track type.

The returned value can be outdated after onTracksChanged, onTrackSelected, or onTrackDeselected is called.

Parameters
trackType: Int

type of selected track

Returns
SessionPlayer.TrackInfo?

selected track info

getShuffleMode

Added in 1.0.0
Deprecated in 1.3.0
abstract fun getShuffleMode(): Int

Gets the shuffle mode.

Returns
Int

the shuffle mode

getTracks

Added in 1.1.0
Deprecated in 1.3.0
fun getTracks(): (Mutable)List<SessionPlayer.TrackInfo!>

Gets the full list of selected and unselected tracks that the media contains. The order of the list is irrelevant as different players expose tracks in different ways, but the tracks will generally be ordered based on track type.

The types of tracks supported may vary based on player implementation.

Returns
(Mutable)List<SessionPlayer.TrackInfo!>

list of tracks. The total number of tracks is the size of the list. If empty, the implementation should return an empty list instead of null.

getVideoSize

Added in 1.1.0
Deprecated in 1.3.0
fun getVideoSize(): VideoSize

Gets the size of the video.

Returns
VideoSize

the size of the video. The width and height of size could be 0 if there is no video or the size has not been determined yet.

movePlaylistItem

Added in 1.1.0
Deprecated in 1.3.0
fun movePlaylistItem(
    fromIndex: @IntRange(from = 0) Int,
    toIndex: @IntRange(from = 0) Int
): ListenableFuture<SessionPlayer.PlayerResult!>

Moves the media item at fromIdx to toIdx in the playlist.

The implementation must notify registered callbacks with onPlaylistChanged when it's completed.

On success, a PlayerResult should be returned with item set.

Parameters
fromIndex: @IntRange(from = 0) Int

the media item's initial index in the playlist

toIndex: @IntRange(from = 0) Int

the media item's target index in the playlist

pause

Added in 1.0.0
Deprecated in 1.3.0
abstract fun pause(): ListenableFuture<SessionPlayer.PlayerResult!>

Pauses playback.

On success, this transfers the player state to PLAYER_STATE_PAUSED and a PlayerResult should be returned with the current media item when the command was completed. If it is called in PLAYER_STATE_IDLE or PLAYER_STATE_ERROR, it should be ignored and a PlayerResult should be returned with RESULT_ERROR_INVALID_STATE.

Returns
ListenableFuture<SessionPlayer.PlayerResult!>

a ListenableFuture representing the pending completion of the command

play

Added in 1.0.0
Deprecated in 1.3.0
abstract fun play(): ListenableFuture<SessionPlayer.PlayerResult!>

Starts or resumes playback.

On success, this transfers the player state to PLAYER_STATE_PLAYING and a PlayerResult should be returned with the current media item when the command was completed. If it is called in PLAYER_STATE_IDLE or PLAYER_STATE_ERROR, it should be ignored and a PlayerResult should be returned with RESULT_ERROR_INVALID_STATE.

Returns
ListenableFuture<SessionPlayer.PlayerResult!>

a ListenableFuture representing the pending completion of the command

prepare

Added in 1.0.0
Deprecated in 1.3.0
abstract fun prepare(): ListenableFuture<SessionPlayer.PlayerResult!>

Prepares the media items for playback. During this time, the player may allocate resources required to play, such as audio and video decoders. Before calling this API, set media item(s) through either setMediaItem or setPlaylist.

On success, this transfers the player state from PLAYER_STATE_IDLE to PLAYER_STATE_PAUSED and a PlayerResult should be returned with the prepared media item when the command completed. If it's not called in PLAYER_STATE_IDLE, it should be ignored and PlayerResult should be returned with RESULT_ERROR_INVALID_STATE.

Returns
ListenableFuture<SessionPlayer.PlayerResult!>

a ListenableFuture representing the pending completion of the command

registerPlayerCallback

Added in 1.0.0
Deprecated in 1.3.0
fun registerPlayerCallback(
    executor: Executor,
    callback: SessionPlayer.PlayerCallback
): Unit

Register PlayerCallback to listen changes.

Parameters
executor: Executor

a callback Executor

callback: SessionPlayer.PlayerCallback

a PlayerCallback

Throws
java.lang.IllegalArgumentException

if executor or callback is null.

removePlaylistItem

Added in 1.0.0
Deprecated in 1.3.0
abstract fun removePlaylistItem(index: @IntRange(from = 0) Int): ListenableFuture<SessionPlayer.PlayerResult!>

Removes the media item from the playlist

The implementation must notify registered callbacks with onPlaylistChanged when it's completed.

On success, a PlayerResult should be returned with item removed.

If the last item is removed, the player should be moved to PLAYER_STATE_IDLE.

Parameters
index: @IntRange(from = 0) Int

the index of the item you want to remove in the playlist

replacePlaylistItem

Added in 1.0.0
Deprecated in 1.3.0
abstract fun replacePlaylistItem(index: Int, item: MediaItem): ListenableFuture<SessionPlayer.PlayerResult!>

Replaces the media item at index in the playlist. This can be also used to update metadata of an item.

The implementation must notify registered callbacks with onPlaylistChanged when it's completed.

The implementation must close the ParcelFileDescriptor in the FileMediaItem if the given media item is a FileMediaItem.

On success, a PlayerResult should be returned with item set.

Parameters
index: Int

the index of the item to replace in the playlist

item: MediaItem

the new item

seekTo

Added in 1.0.0
Deprecated in 1.3.0
abstract fun seekTo(position: Long): ListenableFuture<SessionPlayer.PlayerResult!>

Seeks to the specified position.

The position is the relative position based on the getStartPosition. So calling seekTo with 0 means the seek to the start position.

On success, a PlayerResult should be returned with the current media item when the command completed. If it's called in PLAYER_STATE_IDLE, it is ignored and a PlayerResult should be returned with RESULT_ERROR_INVALID_STATE.

Parameters
position: Long

the new playback position in ms. The value should be in the range of start and end positions defined in MediaItem.

Returns
ListenableFuture<SessionPlayer.PlayerResult!>

a ListenableFuture representing the pending completion of the command

selectTrack

Added in 1.1.0
Deprecated in 1.3.0
fun selectTrack(trackInfo: SessionPlayer.TrackInfo): ListenableFuture<SessionPlayer.PlayerResult!>

Selects the TrackInfo for the current media item.

Generally one track will be selected for each track type.

The types of tracks supported may vary based on player implementation.

Note: getTracks returns the list of tracks that can be selected, but the list may be invalidated when onTracksChanged is called.

Parameters
trackInfo: SessionPlayer.TrackInfo

track to be selected

Returns
ListenableFuture<SessionPlayer.PlayerResult!>

a ListenableFuture representing the pending completion of the command

setAudioAttributes

Added in 1.0.0
Deprecated in 1.3.0
abstract fun setAudioAttributes(attributes: AudioAttributesCompat): ListenableFuture<SessionPlayer.PlayerResult!>

Sets the AudioAttributesCompat to be used during the playback of the media.

You must call this method in PLAYER_STATE_IDLE in order for the audio attributes to become effective thereafter. Otherwise, the call would be ignored and PlayerResult should be returned with RESULT_ERROR_INVALID_STATE.

On success, a PlayerResult should be returned with the current media item when the command completed.

Parameters
attributes: AudioAttributesCompat

non-null AudioAttributes.

setMediaItem

Added in 1.0.0
Deprecated in 1.3.0
abstract fun setMediaItem(item: MediaItem): ListenableFuture<SessionPlayer.PlayerResult!>

Sets a MediaItem for playback. Use this or setPlaylist to specify which items to play. If you want to change current item in the playlist, use one of skipToPlaylistItem, skipToNextPlaylistItem, or skipToPreviousPlaylistItem instead of this method.

This can be called multiple times in any states other than PLAYER_STATE_ERROR. This would override previous setMediaItem or setPlaylist calls.

It's recommended to fill MediaMetadata in MediaItem especially for the duration information with the key METADATA_KEY_DURATION. Without the duration information in the metadata, session will do extra work to get the duration and send it to the controller.

The implementation must notify registered callbacks with onPlaylistChanged and onCurrentMediaItemChanged when it's completed. The current item would be the item given here.

The implementation must close the ParcelFileDescriptor in the FileMediaItem if the given media item is a FileMediaItem.

On success, a PlayerResult should be returned with item set.

Parameters
item: MediaItem

the descriptor of media item you want to play

Returns
ListenableFuture<SessionPlayer.PlayerResult!>

a ListenableFuture which represents the pending completion of the command

Throws
java.lang.IllegalArgumentException

if the given item is null.

setPlaybackSpeed

Added in 1.0.0
Deprecated in 1.3.0
abstract fun setPlaybackSpeed(playbackSpeed: Float): ListenableFuture<SessionPlayer.PlayerResult!>

Sets the playback speed. The default playback speed is 1.0f, and negative values indicate reverse playback and 0.0f is not allowed.

The supported playback speed range depends on the underlying player implementation, so it is recommended to query the actual speed of the player via getPlaybackSpeed after the operation completes. In particular, please note that player implementations may not support reverse playback.

On success, a PlayerResult should be returned with the current media item when the command completed.

Parameters
playbackSpeed: Float

the requested playback speed

Returns
ListenableFuture<SessionPlayer.PlayerResult!>

a ListenableFuture representing the pending completion of the command

setPlaylist

Added in 1.0.0
Deprecated in 1.3.0
abstract fun setPlaylist(list: (Mutable)List<MediaItem!>, metadata: MediaMetadata?): ListenableFuture<SessionPlayer.PlayerResult!>

Sets a list of MediaItem with metadata. Use this or setMediaItem to specify which items to play.

This can be called multiple times in any states other than PLAYER_STATE_ERROR. This would override previous setMediaItem or setPlaylist calls.

Ensure uniqueness of each MediaItem in the playlist so the session can uniquely identity individual items. All MediaItems shouldn't be null as well.

It's recommended to fill MediaMetadata in each MediaItem especially for the duration information with the key METADATA_KEY_DURATION. Without the duration information in the metadata, session will do extra work to get the duration and send it to the controller.

The implementation must notify registered callbacks with onPlaylistChanged and onCurrentMediaItemChanged when it's completed. The current media item would be the first item in the playlist.

The implementation must close the ParcelFileDescriptor in the FileMediaItem when a media item in the playlist is a FileMediaItem.

On success, a PlayerResult should be returned with the first media item of the playlist when the command completed.

Parameters
list: (Mutable)List<MediaItem!>

a list of MediaItem objects to set as a play list

Returns
ListenableFuture<SessionPlayer.PlayerResult!>

a ListenableFuture which represents the pending completion of the command

Throws
java.lang.IllegalArgumentException

if the given list is null or empty, or has duplicated media items.

setRepeatMode

Added in 1.0.0
Deprecated in 1.3.0
abstract fun setRepeatMode(repeatMode: Int): ListenableFuture<SessionPlayer.PlayerResult!>

Sets the repeat mode.

The implementation must notify registered callbacks with onRepeatModeChanged when it's completed.

On success, a PlayerResult should be returned with the current media item when the command completed.

Parameters
repeatMode: Int

repeat mode

setShuffleMode

Added in 1.0.0
Deprecated in 1.3.0
abstract fun setShuffleMode(shuffleMode: Int): ListenableFuture<SessionPlayer.PlayerResult!>

Sets the shuffle mode.

The implementation must notify registered callbacks with onShuffleModeChanged when it's completed.

On success, a PlayerResult should be returned with the current media item when the command completed.

Parameters
shuffleMode: Int

the shuffle mode

Returns
ListenableFuture<SessionPlayer.PlayerResult!>

a ListenableFuture representing the pending completion of the command

setSurface

Added in 1.1.0
Deprecated in 1.3.0
fun setSurface(surface: Surface?): ListenableFuture<SessionPlayer.PlayerResult!>

Sets the Surface to be used as the sink for the video portion of the media.

A null surface will reset any Surface and result in only the audio track being played.

On success, a SessionPlayer.PlayerResult is returned with the current media item when the command completed.

Parameters
surface: Surface?

the Surface to be used for the video portion of the media

Returns
ListenableFuture<SessionPlayer.PlayerResult!>

a ListenableFuture which represents the pending completion of the command

skipToNextPlaylistItem

Added in 1.0.0
Deprecated in 1.3.0
abstract fun skipToNextPlaylistItem(): ListenableFuture<SessionPlayer.PlayerResult!>

Skips to the next item in the playlist.

The implementation must notify registered callbacks with onCurrentMediaItemChanged when it's completed.

On success, a PlayerResult should be returned with the current media item when the command completed.

Returns
ListenableFuture<SessionPlayer.PlayerResult!>

a ListenableFuture representing the pending completion of the command

skipToPlaylistItem

Added in 1.0.0
Deprecated in 1.3.0
abstract fun skipToPlaylistItem(index: @IntRange(from = 0) Int): ListenableFuture<SessionPlayer.PlayerResult!>

Skips to the item in the playlist at the index.

The implementation must notify registered callbacks with onCurrentMediaItemChanged when it's completed.

On success, a PlayerResult should be returned with the current media item when the command completed.

Parameters
index: @IntRange(from = 0) Int

the index of the item you want to play in the playlist

skipToPreviousPlaylistItem

Added in 1.0.0
Deprecated in 1.3.0
abstract fun skipToPreviousPlaylistItem(): ListenableFuture<SessionPlayer.PlayerResult!>

Skips to the previous item in the playlist.

The implementation must notify registered callbacks with onCurrentMediaItemChanged when it's completed.

On success, a PlayerResult should be returned with the current media item when the command completed.

Returns
ListenableFuture<SessionPlayer.PlayerResult!>

a ListenableFuture representing the pending completion of the command

unregisterPlayerCallback

Added in 1.0.0
Deprecated in 1.3.0
fun unregisterPlayerCallback(callback: SessionPlayer.PlayerCallback): Unit

Unregister the previously registered PlayerCallback.

Parameters
callback: SessionPlayer.PlayerCallback

the callback to be removed

Throws
java.lang.IllegalArgumentException

if the callback is null.

updatePlaylistMetadata

Added in 1.0.0
Deprecated in 1.3.0
abstract fun updatePlaylistMetadata(metadata: MediaMetadata?): ListenableFuture<SessionPlayer.PlayerResult!>

Updates the playlist metadata while keeping the playlist as-is.

The implementation must notify registered callbacks with onPlaylistMetadataChanged when it's completed.

On success, a PlayerResult should be returned with the current media item when the command completed.

Parameters
metadata: MediaMetadata?

metadata of the playlist

Protected functions

getCallbacks

Added in 1.0.0
Deprecated in 1.3.0
protected fun getCallbacks(): (Mutable)List<Pair<SessionPlayer.PlayerCallback!, Executor!>!>

Gets the callbacks with executors for subclasses to notify player events.

Returns
(Mutable)List<Pair<SessionPlayer.PlayerCallback!, Executor!>!>

map of callbacks and its executors