Summary: Nested Classes | Constants | Inherited Constants | Ctors | Methods | Inherited Methods

RemoteSessionPlayer

Kotlin |Java

public abstract class RemoteSessionPlayer
extends SessionPlayer

java.lang.Object
↳	androidx.media2.common.SessionPlayer
	↳	androidx.media2.session.RemoteSessionPlayer

---

Base interface for all remote media players that want media session and playback happens on the remote device through MediaRouter.

If you use this to the MediaSession, session would dispatch incoming volume change event to the player instead of changing device stream volume.

Summary

Nested classes
class	RemoteSessionPlayer.Callback A callback class to receive notifications for events on the remote session player.

Constants
int	VOLUME_CONTROL_ABSOLUTE The volume control uses an absolute value.
int	VOLUME_CONTROL_FIXED The volume is fixed and can not be modified.
int	VOLUME_CONTROL_RELATIVE The volume control uses relative adjustment via adjustVolume(int).

Inherited constants

From class androidx.media2.common.SessionPlayer int BUFFERING_STATE_BUFFERING_AND_PLAYABLE Buffering state indicating the player is buffering but enough has been buffered for this player to be able to play the content. int BUFFERING_STATE_BUFFERING_AND_STARVED Buffering state indicating the player is buffering, but the player is currently starved for data, and cannot play. int BUFFERING_STATE_COMPLETE Buffering state indicating the player is done buffering, and the remainder of the content is available for playback. int BUFFERING_STATE_UNKNOWN Buffering state is unknown. int INVALID_ITEM_INDEX Media item index is invalid. int PLAYER_STATE_ERROR State when the player is in error state and cannot be recovered self. int PLAYER_STATE_IDLE State when the player is idle, and needs configuration to start playback. int PLAYER_STATE_PAUSED State when the player's playback is paused int PLAYER_STATE_PLAYING State when the player's playback is ongoing int REPEAT_MODE_ALL Playing media list will be repeated. int REPEAT_MODE_GROUP Playback of the playing media group will be repeated. int REPEAT_MODE_NONE Playback will be stopped at the end of the playing media list. int REPEAT_MODE_ONE Playback of the current playing media item will be repeated. int SHUFFLE_MODE_ALL Media list will be played in shuffled order. int SHUFFLE_MODE_GROUP Media group will be played in shuffled order. int SHUFFLE_MODE_NONE Media list will be played in order. long UNKNOWN_TIME Value indicating the time is unknown

Public constructors
RemoteSessionPlayer()

Public methods
abstract Future<SessionPlayer.PlayerResult>	adjustVolume(int direction) Adjusts player volume with the direction.
abstract int	getMaxVolume() Gets the maximum volume that can be used in setVolume(int).
abstract int	getVolume() Gets the current volume of this player to this player.
abstract int	getVolumeControlType() Gets the volume type.
abstract Future<SessionPlayer.PlayerResult>	setVolume(int volume) Sets the volume of the audio of the media to play, expressed as a linear multiplier on the audio samples.

Inherited methods
From class androidx.media2.common.SessionPlayer abstract ListenableFuture<SessionPlayer.PlayerResult> addPlaylistItem(int index, MediaItem item) Adds the media item to the playlist at the index. void close() Removes all existing references to callbacks and executors. ListenableFuture<SessionPlayer.PlayerResult> deselectTrack(SessionPlayer.TrackInfo trackInfo) Deselects the SessionPlayer.TrackInfo for the current media item. abstract AudioAttributesCompat getAudioAttributes() Gets the AudioAttributesCompat that media player has. abstract long getBufferedPosition() Gets the position for how much has been buffered, or UNKNOWN_TIME if unknown. abstract int getBufferingState() Returns the current buffering state of the player. final List<Pair<SessionPlayer.PlayerCallback, Executor>> getCallbacks() Gets the callbacks with executors for subclasses to notify player events. abstract MediaItem getCurrentMediaItem() Gets the current media item, which is currently playing or would be played with later play(). abstract int getCurrentMediaItemIndex() Gets the index of current media item in playlist. abstract long getCurrentPosition() Gets the current playback position. abstract long getDuration() Gets the duration of the current media item, or UNKNOWN_TIME if unknown. abstract int getNextMediaItemIndex() Gets the next item index in the playlist. abstract float getPlaybackSpeed() Gets the actual playback speed to be used by the player when playing. abstract int getPlayerState() Gets the current player state. abstract List<MediaItem> getPlaylist() Gets the playlist. abstract MediaMetadata getPlaylistMetadata() Gets the playlist metadata. abstract int getPreviousMediaItemIndex() Gets the previous item index in the playlist. abstract int getRepeatMode() Gets the repeat mode. SessionPlayer.TrackInfo getSelectedTrack(int trackType) Gets currently selected track's SessionPlayer.TrackInfo for the given track type. abstract int getShuffleMode() Gets the shuffle mode. List<SessionPlayer.TrackInfo> getTracks() Gets the full list of selected and unselected tracks that the media contains. VideoSize getVideoSize() Gets the size of the video. ListenableFuture<SessionPlayer.PlayerResult> movePlaylistItem(int fromIndex, int toIndex) Moves the media item at fromIdx to toIdx in the playlist. abstract ListenableFuture<SessionPlayer.PlayerResult> pause() Pauses playback. abstract ListenableFuture<SessionPlayer.PlayerResult> play() Starts or resumes playback. abstract ListenableFuture<SessionPlayer.PlayerResult> prepare() Prepares the media items for playback. final void registerPlayerCallback(Executor executor, SessionPlayer.PlayerCallback callback) Register SessionPlayer.PlayerCallback to listen changes. abstract ListenableFuture<SessionPlayer.PlayerResult> removePlaylistItem(int index) Removes the media item from the playlist The implementation must notify registered callbacks with SessionPlayer.PlayerCallback.onPlaylistChanged(SessionPlayer, List, MediaMetadata) when it's completed. abstract ListenableFuture<SessionPlayer.PlayerResult> replacePlaylistItem(int index, MediaItem item) Replaces the media item at index in the playlist. abstract ListenableFuture<SessionPlayer.PlayerResult> seekTo(long position) Seeks to the specified position. ListenableFuture<SessionPlayer.PlayerResult> selectTrack(SessionPlayer.TrackInfo trackInfo) Selects the SessionPlayer.TrackInfo for the current media item. abstract ListenableFuture<SessionPlayer.PlayerResult> setAudioAttributes(AudioAttributesCompat attributes) Sets the AudioAttributesCompat to be used during the playback of the media. abstract ListenableFuture<SessionPlayer.PlayerResult> setMediaItem(MediaItem item) Sets a MediaItem for playback. abstract ListenableFuture<SessionPlayer.PlayerResult> setPlaybackSpeed(float playbackSpeed) Sets the playback speed. abstract ListenableFuture<SessionPlayer.PlayerResult> setPlaylist(List<MediaItem> list, MediaMetadata metadata) Sets a list of MediaItem with metadata. abstract ListenableFuture<SessionPlayer.PlayerResult> setRepeatMode(int repeatMode) Sets the repeat mode. abstract ListenableFuture<SessionPlayer.PlayerResult> setShuffleMode(int shuffleMode) 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> skipToNextPlaylistItem() Skips to the next item in the playlist. abstract ListenableFuture<SessionPlayer.PlayerResult> skipToPlaylistItem(int index) Skips to the item in the playlist at the index. abstract ListenableFuture<SessionPlayer.PlayerResult> skipToPreviousPlaylistItem() Skips to the previous item in the playlist. final void unregisterPlayerCallback(SessionPlayer.PlayerCallback callback) Unregister the previously registered SessionPlayer.PlayerCallback. abstract ListenableFuture<SessionPlayer.PlayerResult> updatePlaylistMetadata(MediaMetadata metadata) Updates the playlist metadata while keeping the playlist as-is.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface java.io.Closeable abstract void close()
From interface java.lang.AutoCloseable abstract void close()

Constants

VOLUME_CONTROL_ABSOLUTE

public static final int VOLUME_CONTROL_ABSOLUTE

The volume control uses an absolute value. It may be adjusted using adjustVolume(int) or set directly using setVolume(int).

Constant Value: 2 (0x00000002)

VOLUME_CONTROL_FIXED

public static final int VOLUME_CONTROL_FIXED

The volume is fixed and can not be modified. Requests to change volume should be ignored.

Constant Value: 0 (0x00000000)

VOLUME_CONTROL_RELATIVE

public static final int VOLUME_CONTROL_RELATIVE

The volume control uses relative adjustment via adjustVolume(int). Attempts to set the volume to a specific value should be ignored.

Constant Value: 1 (0x00000001)

Public constructors

RemoteSessionPlayer

public RemoteSessionPlayer ()

Public methods

adjustVolume

public abstract Future<SessionPlayer.PlayerResult> adjustVolume (int direction)

Adjusts player volume with the direction. Override this API to customize volume change in remote device.

This would be ignored when volume control type is VOLUME_CONTROL_FIXED.

Parameters
direction	int: direction of the volume changes. Positive value for volume up, negative for volume down.

Returns
Future<SessionPlayer.PlayerResult>	result of adjusting the volume. Shouldn't be null.

getMaxVolume

public abstract int getMaxVolume ()

Gets the maximum volume that can be used in setVolume(int).

Returns
int	the maximum volume. Shouldn't be negative.

getVolume

public abstract int getVolume ()

Gets the current volume of this player to this player.

Note that it does not take into account the associated stream volume because the playback is happening outside of the phone device.

Returns
int	the player volume.

getVolumeControlType

public abstract int getVolumeControlType ()

Gets the volume type.

This shouldn't be changed after instantiation.

Returns
int	one of the volume type

See also:

• VOLUME_CONTROL_FIXED
• VOLUME_CONTROL_RELATIVE
• VOLUME_CONTROL_ABSOLUTE

setVolume

public abstract Future<SessionPlayer.PlayerResult> setVolume (int volume)

Sets the volume of the audio of the media to play, expressed as a linear multiplier on the audio samples.

Note that this volume is specific to the player, and is separate from stream volume used across the platform.

A value of 0 indicates muting. See getMaxVolume() for the volume range supported by this player.

Parameters
volume	int: a value between 0 and getMaxVolume().

Returns
Future<SessionPlayer.PlayerResult>	result of setting the volume. Shouldn't be null.