MediaController

fun addPlaylistItem(index: @IntRange(from = 0) Int, mediaId: String): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession adds the media item to the playlist at the index with the media ID. 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 will be increased correspondingly.

On success, a SessionResult would be returned with item added.

fun adjustVolume(direction: Int, flags: Int): ListenableFuture<SessionResult!>

Requests that the connected MediaSession adjusts the volume of the output that is playing on. The direction must be one of ADJUST_LOWER, ADJUST_RAISE, or ADJUST_SAME.

The command will be ignored if the session does not support VOLUME_CONTROL_RELATIVE or VOLUME_CONTROL_ABSOLUTE.

If the session is local playback, this changes the device's volume with the stream that session's player is using. Flags will be specified for the AudioManager.

If the session is remote player (i.e. session has set volume provider), its volume provider will receive this request instead.

fun close(): Unit

Releases this object, and disconnects from the session. After this, callbacks wouldn't be received.

fun deselectTrack(trackInfo: SessionPlayer.TrackInfo): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession 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 players.

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

fun fastForward(): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession to fast forward playback.

The implementation may be different depending on the players. For example, it can be implemented by seeking forward once, series of seeking forward, or increasing playback speed. If you need full control, then use seekTo or setPlaybackSpeed directly.

fun getAllowedCommands(): SessionCommandGroup?

Gets the cached allowed commands from onAllowedCommandsChanged. If it is not connected yet, it returns null.

fun getBufferedPosition(): Long

Gets the position for how much has been buffered of the SessionPlayer associated with the connected MediaSession, or UNKNOWN_TIME if unknown or not connected.

fun getBufferingState(): Int

Gets the current buffering state of the SessionPlayer associated with the connected MediaSession.

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

fun getConnectedToken(): SessionToken?

Returns the SessionToken of the connected session. If it is not connected yet, it returns null.

This may differ from the SessionToken from the constructor. For example, if the controller is created with the token for MediaSessionService, this would return token for the MediaSession in the service.

fun getCurrentMediaItem(): MediaItem?

Gets the current media item of the SessionPlayer associated with the connected MediaSession. This can be currently playing or would be played with later play. This value may be updated when onCurrentMediaItemChanged or onPlaylistChanged is called.

fun getCurrentMediaItemIndex(): Int

Gets the current item index in the playlist of the SessionPlayer associated with the connected MediaSession. The value would be updated when onCurrentMediaItemChanged or onPlaylistChanged is called.

fun getCurrentPosition(): Long

Gets the playback position of the SessionPlayer associated with the connected MediaSession.

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

fun getDuration(): Long

Gets the duration of the current media item, or UNKNOWN_TIME if unknown or not connected. 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.

fun getNextMediaItemIndex(): Int

Gets the next item index in the playlist of the SessionPlayer associated with the connected MediaSession. This value would be updated when onCurrentMediaItemChanged or onPlaylistChanged is called.

Interoperability: When connected to android.support.v4.media.session.MediaSessionCompat, this will always return INVALID_ITEM_INDEX..

fun getPlaybackInfo(): MediaController.PlaybackInfo?

Get the current playback info for this session. If it is not connected yet, it returns null.

fun getPlaybackSpeed(): Float

Gets the playback speed to be used by the of the SessionPlayer associated with the connected MediaSession 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.

fun getPlayerState(): Int

Gets the state of the SessionPlayer associated with the connected MediaSession. If it is not connected yet, it returns PLAYER_STATE_IDLE.

fun getPlaylist(): (Mutable)List<MediaItem!>?

Gets the playlist of the SessionPlayer associated with the connected MediaSession. It can be null if the playlist hasn't been set or it's reset by setMediaItem.

This list may differ from the list that was specified with setPlaylist depending on the SessionPlayer implementation.

fun getPlaylistMetadata(): MediaMetadata?

Gets the playlist metadata of the SessionPlayer associated with the connected MediaSession.

fun getPreviousMediaItemIndex(): Int

Gets the previous item index in the playlist of the SessionPlayer associated with the connected MediaSession. This value would be updated when onCurrentMediaItemChanged or onPlaylistChanged is called.

Interoperability: When connected to android.support.v4.media.session.MediaSessionCompat, this will always return INVALID_ITEM_INDEX.

fun getRepeatMode(): Int

Gets the repeat mode of the SessionPlayer associated with the connected MediaSession. If it is not connected yet, it returns REPEAT_MODE_NONE.

fun getSelectedTrack(trackType: Int): SessionPlayer.TrackInfo?

Gets the currently selected track for the given track type of the SessionPlayer associated with the connected MediaSession. If it is not connected yet, it returns null.

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

fun getSessionActivity(): PendingIntent?

Gets an intent for launching UI associated with this session if one exists. If it is not connected yet, it returns null.

fun getShuffleMode(): Int

Gets the shuffle mode of the SessionPlayer associated with the connected MediaSession. If it is not connected yet, it returns SHUFFLE_MODE_NONE.

fun getTracks(): (Mutable)List<SessionPlayer.TrackInfo!>

Gets the full list of selected and unselected tracks that the media contains of the SessionPlayer associated with the connected MediaSession. 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.

fun getVideoSize(): VideoSize

Gets the video size of the SessionPlayer associated with the connected MediaSession. If it is not connected yet, it returns new VideoSize(0, 0).

fun isConnected(): Boolean

Returns whether this class is connected to active MediaSession or not.

fun movePlaylistItem(
    fromIndex: @IntRange(from = 0) Int,
    toIndex: @IntRange(from = 0) Int
): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession moves the media item at fromIdx to toIdx in the playlist.

On success, a SessionResult would be returned with item set.

fun pause(): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession pauses playback.

On success, this transfers the player state to PLAYER_STATE_PAUSED and a SessionResult would 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 whould be ignored and a SessionResult would be returned with RESULT_ERROR_INVALID_STATE.

fun play(): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession starts or resumes playback.

On success, this transfers the player state to PLAYER_STATE_PLAYING and a SessionResult would be returned with the current media item when the command was completed. If the player state is PLAYER_STATE_IDLE, the session would also call prepare and then play to start playback. If you want to have finer grained control of the playback start, call prepare manually before this. Calling prepare in advance would help this method to start playback faster and also help to take audio focus at the last moment.

Interoperability: When connected to android.support.v4.media.session.MediaSessionCompat, then this will be grouped together with previously called setMediaUri. See setMediaUri for details.

fun prepare(): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession 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, sets 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 SessionResult would be returned with the prepared media item when the command completed. If it's not called in PLAYER_STATE_IDLE, it would be ignored and SessionResult would be returned with RESULT_ERROR_INVALID_STATE.

Playback can be started without this. But this provides finer grained control of playback start. See play for details.

Interoperability: When connected to android.support.v4.media.session.MediaSessionCompat, then this call may be grouped together with previously called setMediaUri. See setMediaUri for details.

fun removePlaylistItem(index: @IntRange(from = 0) Int): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession removes the media item at index in the playlist.

On success, a SessionResult would be returned with item removed.

fun replacePlaylistItem(index: @IntRange(from = 0) Int, mediaId: String): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession replaces the media item at index in the playlist with the media ID.

On success, a SessionResult would be returned with item set.

fun rewind(): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession to rewind playback.

The implementation may be different depending on the players. For example, it can be implemented by seeking backward once, series of seeking backward, or decreasing playback speed. If you need full control, then use seekTo or setPlaybackSpeed directly.

fun seekTo(position: Long): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession 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 SessionResult would be returned with the current media item when the command completed. If it's called in PLAYER_STATE_IDLE, it is ignored and a SessionResult would be returned with RESULT_ERROR_INVALID_STATE.

fun selectTrack(trackInfo: SessionPlayer.TrackInfo): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession 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 players.

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

fun sendCustomCommand(command: SessionCommand, args: Bundle?): ListenableFuture<SessionResult!>

Sends a custom command to the session

Interoperability: When connected to android.support.v4.media.session.MediaSessionCompat, getResultCode will return the custom result code from the onReceiveResult instead of the standard result codes defined in the SessionResult.

A command is not accepted if it is not a custom command.

fun setMediaItem(mediaId: String): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession sets a MediaItem for playback. Use this, setMediaUri, 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 call of this, setMediaUri, or setPlaylist.

The onPlaylistChanged and/or onCurrentMediaItemChanged would be called when it's completed.

On success, a SessionResult would be returned with item set.

fun setMediaUri(uri: Uri, extras: Bundle?): ListenableFuture<SessionResult!>

Requests that the connected MediaSession sets a specific Uri for playback. Use this, setMediaItem, or setPlaylist to specify which items to play.

This can be called multiple times in any states other than PLAYER_STATE_ERROR. This would override previous call of this, setMediaItem, or setPlaylist.

The onPlaylistChanged and/or onCurrentMediaItemChanged would be called when it's completed.

On success, a SessionResult would be returned with item set.

Interoperability: When connected to android.support.v4.media.session.MediaSessionCompat, this call will be grouped together with later prepare or play, depending on the Uri pattern as follows:

Returned ListenableFuture will return RESULT_SUCCESS when it's handled together with prepare or play. If this API is called multiple times without prepare or play, then RESULT_INFO_SKIPPED will be returned for previous calls.

fun setPlaybackSpeed(playbackSpeed: Float): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession sets the playback speed. The default playback speed is 1.0f is the default, and negative values indicate reverse playback and 0.0f is not allowed.

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

On success, a SessionResult would be returned with the current media item when the command completed.

fun setPlaylist(list: (Mutable)List<String!>, metadata: MediaMetadata?): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession sets the playlist with the list of media IDs. Use this, setMediaUri, or setMediaItem to specify which items to play.

All media IDs in the list shouldn't be an empty string.

This can be called multiple times in any states other than PLAYER_STATE_ERROR. This would override previous call of this, setMediaItem, or setMediaUri.

The onPlaylistChanged and/or onCurrentMediaItemChanged would be called when it's completed. The current item would be the first item in the playlist.

fun setRating(mediaId: String, rating: Rating): ListenableFuture<SessionResult!>

Requests that the connected MediaSession rates the media. This will cause the rating to be set for the current user. The rating style must follow the user rating style from the session.You can get the rating style from the session through the getRating with the key METADATA_KEY_USER_RATING.

If the user rating was null, the media item does not accept setting user rating.

fun setRepeatMode(repeatMode: Int): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession sets the repeat mode.

On success, a SessionResult would be returned with the current media item when the command completed.

fun setShuffleMode(shuffleMode: Int): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession sets the shuffle mode.

On success, a SessionResult would be returned with the current media item when the command completed.

fun setSurface(surface: Surface?): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession 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 SessionResult is returned with the current media item when the command completed.

fun setVolumeTo(value: Int, flags: Int): ListenableFuture<SessionResult!>

Requests that the connected MediaSession sets the volume of the output that is playing on. The command will be ignored if it does not support VOLUME_CONTROL_ABSOLUTE.

If the session is local playback, this changes the device's volume with the stream that session's player is using. Flags will be specified for the AudioManager.

If the session is remote player (i.e. session has set volume provider), its volume provider will receive this request instead.

fun skipBackward(): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession skips forward within the current media item.

The implementation may be different depending on the players. For example, it can be implemented by seeking backward once with the fixed amount of seconds, or seeking backward to the nearest bookmark. If you need full control, then use seekTo directly.

fun skipForward(): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession skips backward within the current media item.

The implementation may be different depending on the players. For example, it can be implemented by seeking forward once with the fixed amount of seconds, or seeking forward to the nearest bookmark. If you need full control, then use seekTo directly.

fun skipToNextPlaylistItem(): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession skips to the next item in the playlist.

On success, a SessionResult would be returned with the current media item when the command completed.

fun skipToPlaylistItem(index: @IntRange(from = 0) Int): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession skips to the item in the playlist at the index.

On success, a SessionResult would be returned with the current media item when the command completed.

fun skipToPreviousPlaylistItem(): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession skips to the previous item in the playlist.

On success, a SessionResult would be returned with the current media item when the command completed.

fun updatePlaylistMetadata(metadata: MediaMetadata?): ListenableFuture<SessionResult!>

Requests that the SessionPlayer associated with the connected MediaSession updates the playlist metadata while keeping the playlist as-is.

On success, a SessionResult would be returned with the current media item when the command completed.