CastPlayer

Kotlin |Java

@UnstableApi
public final class CastPlayer extends BasePlayer

java.lang.Object
↳	androidx.media3.common.BasePlayer
	↳	androidx.media3.cast.CastPlayer

Player implementation that communicates with a Cast receiver app.

The behavior of this class depends on the underlying Cast session, which is obtained from the injected CastContext. To keep track of the session, isCastSessionAvailable can be queried and SessionAvailabilityListener can be implemented and attached to the player.

If no session is available, the player state will remain unchanged and calls to methods that alter it will be ignored. Querying the player state is possible even when no session is available, in which case, the last observed receiver app state is reported.

Methods should be called on the application's main thread.

Summary

Constants
`static final DeviceInfo`	`DEVICE_INFO_REMOTE_EMPTY` A `remoteDeviceInfo` with a null `routingControllerId`.
`static final float`	`MAX_SPEED_SUPPORTED = 2.0f`
`static final float`	`MIN_SPEED_SUPPORTED = 0.5f`

Public fields
`Player.Commands`	`availableCommands`
`Tracks`	`currentTracks`
`DeviceInfo`	`deviceInfo`
`int`	`deviceVolume`
`MediaMetadata`	`mediaMetadata`
`int`	`@Player.State playbackState`
`MediaMetadata`	`playlistMetadata`

Public constructors
`CastPlayer(CastContext castContext)` Creates a new cast player.
`CastPlayer( CastContext castContext, MediaItemConverter mediaItemConverter )` Creates a new cast player.
`CastPlayer( CastContext castContext, MediaItemConverter mediaItemConverter, @IntRange(from = 1) long seekBackIncrementMs, @IntRange(from = 1) long seekForwardIncrementMs )` Creates a new cast player.
`CastPlayer( @Nullable Context context, CastContext castContext, MediaItemConverter mediaItemConverter, @IntRange(from = 1) long seekBackIncrementMs, @IntRange(from = 1) long seekForwardIncrementMs, @IntRange(from = 0) long maxSeekToPreviousPositionMs )` Creates a new cast player.

Public methods
`void`	`addListener(Player.Listener listener)` Registers a listener to receive all events from the player.
`void`	`addMediaItems(int index, List<MediaItem> mediaItems)` Adds a list of media items at the given index of the playlist.
`void`	`clearVideoSurface()` This method is not supported and does nothing.
`void`	`clearVideoSurface(@Nullable Surface surface)` This method is not supported and does nothing.
`void`	`clearVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)` This method is not supported and does nothing.
`void`	`clearVideoSurfaceView(@Nullable SurfaceView surfaceView)` This method is not supported and does nothing.
`void`	`clearVideoTextureView(@Nullable TextureView textureView)` This method is not supported and does nothing.
`void`	`@InlineMe(replacement = "this.decreaseDeviceVolume(0)") decreaseDeviceVolume()` This method is deprecated. Use `decreaseDeviceVolume` (int)} instead.
`void`	`decreaseDeviceVolume(@C.VolumeFlags int flags)` Decreases the volume of the device.
`Looper`	`getApplicationLooper()` Returns the `Looper` associated with the application thread that's used to access the player and on which player events are received.
`AudioAttributes`	`getAudioAttributes()` This method is not supported and returns `DEFAULT`.
`Player.Commands`	`getAvailableCommands()` Returns the player's currently available `Commands`.
`long`	`getBufferedPosition()` Returns an estimate of the position in the current content or ad up to which data is buffered, in milliseconds.
`long`	`getContentBufferedPosition()` If `isPlayingAd` returns `true`, returns an estimate of the content position in the current content up to which data is buffered, in milliseconds.
`long`	`getContentPosition()` If `isPlayingAd` returns `true`, returns the content position that will be played once all ads in the ad group have finished playing, in milliseconds.
`int`	`getCurrentAdGroupIndex()` If `isPlayingAd` returns true, returns the index of the ad group in the period currently being played.
`int`	`getCurrentAdIndexInAdGroup()` If `isPlayingAd` returns true, returns the index of the ad in its ad group.
`CueGroup`	`getCurrentCues()` This method is not supported and returns an empty `CueGroup`.
`int`	`getCurrentMediaItemIndex()` Returns the index of the current `MediaItem` in the `timeline`, or the prospective index if the `current timeline` is empty.
`int`	`getCurrentPeriodIndex()` Returns the index of the period currently being played.
`long`	`getCurrentPosition()` Returns the playback position in the current content or ad, in milliseconds, or the prospective position in milliseconds if the `current timeline` is empty.
`Timeline`	`getCurrentTimeline()` Returns the current `Timeline`.
`Tracks`	`getCurrentTracks()` Returns the current tracks.
`DeviceInfo`	`getDeviceInfo()` Returns a `DeviceInfo` describing the receiver device.
`int`	`getDeviceVolume()` Gets the current volume of the device.
`long`	`getDuration()` Returns the duration of the current content or ad in milliseconds, or `TIME_UNSET` if the duration is not known.
`@Nullable MediaQueueItem`	`getItem(int periodId)` Returns the item that corresponds to the period with the given id, or null if no media queue or period with id `periodId` exist.
`long`	`getMaxSeekToPreviousPosition()` Returns the maximum position for which `seekToPrevious` seeks to the previous , in milliseconds.
`MediaMetadata`	`getMediaMetadata()` Returns the current combined `MediaMetadata`, or `EMPTY` if not supported.
`MediaMetadata`	`getMediaMetadataInternal()`
`boolean`	`getPlayWhenReady()` Whether playback will proceed when `getPlaybackState` == `STATE_READY`.
`PlaybackParameters`	`getPlaybackParameters()` Returns the currently active playback parameters.
`int`	`@Player.State getPlaybackState()` Returns the current `playback state` of the player.
`int`	`@Player.PlaybackSuppressionReason getPlaybackSuppressionReason()` Returns the reason why playback is suppressed even though `getPlayWhenReady` is `true`, or `PLAYBACK_SUPPRESSION_REASON_NONE` if playback is not suppressed.
`@Nullable PlaybackException`	`getPlayerError()` Returns the error that caused playback to fail.
`MediaMetadata`	`getPlaylistMetadata()` Returns the playlist `MediaMetadata`, as set by `setPlaylistMetadata`, or `EMPTY` if not supported.
`int`	`@Player.RepeatMode getRepeatMode()` Returns the current `RepeatMode` used for playback.
`long`	`getSeekBackIncrement()` Returns the `seekBack` increment.
`long`	`getSeekForwardIncrement()` Returns the `seekForward` increment.
`boolean`	`getShuffleModeEnabled()` Returns whether shuffling of media items is enabled.
`Size`	`getSurfaceSize()` This method is not supported and returns `UNKNOWN`.
`long`	`getTotalBufferedDuration()` Returns an estimate of the total buffered duration from the current position, in milliseconds.
`TrackSelectionParameters`	`getTrackSelectionParameters()` Returns the parameters constraining the track selection.
`VideoSize`	`getVideoSize()` This method is not supported and returns `UNKNOWN`.
`float`	`getVolume()` This method is not supported and returns 1.
`void`	`@InlineMe(replacement = "this.increaseDeviceVolume(0)") increaseDeviceVolume()` This method is deprecated. Use `increaseDeviceVolume` instead.
`void`	`increaseDeviceVolume(@C.VolumeFlags int flags)` Increases the volume of the device.
`boolean`	`isCastSessionAvailable()` Returns whether a cast session is available.
`boolean`	`isDeviceMuted()` Gets whether the device is muted or not.
`boolean`	`isLoading()` Whether the player is currently loading the source.
`boolean`	`isPlayingAd()` Returns whether the player is currently playing an ad.
`void`	`moveMediaItems(int fromIndex, int toIndex, int newIndex)` Moves the media item range to the new index.
`void`	`prepare()` Prepares the player.
`void`	`release()` Releases the player.
`void`	`removeListener(Player.Listener listener)` Unregister a listener registered through `addListener`.
`void`	`removeMediaItems(int fromIndex, int toIndex)` Removes a range of media items from the playlist.
`void`	`replaceMediaItems( int fromIndex, int toIndex, List<MediaItem> mediaItems )` Replaces the media items at the given range of the playlist.
`void`	`setAudioAttributes( AudioAttributes audioAttributes, boolean handleAudioFocus )` This method is not supported and does nothing.
`void`	`@InlineMe(replacement = "this.setDeviceMuted(muted, 0)") setDeviceMuted(boolean muted)` This method is deprecated. Use `setDeviceMuted` instead.
`void`	`setDeviceMuted(boolean muted, @C.VolumeFlags int flags)` Sets the mute state of the device.
`void`	`@InlineMe(replacement = "this.setDeviceVolume(volume, 0)") setDeviceVolume(@IntRange(from = 0) int volume)` This method is deprecated. Use `setDeviceVolume` instead.
`void`	`setDeviceVolume(@IntRange(from = 0) int volume, @C.VolumeFlags int flags)` Sets the volume of the device with volume flags.
`void`	`setMediaItems(List<MediaItem> mediaItems, boolean resetPosition)` Clears the playlist and adds the specified `media items`.
`void`	`setMediaItems( List<MediaItem> mediaItems, int startIndex, long startPositionMs )` Clears the playlist and adds the specified `media items`.
`void`	`setPlayWhenReady(boolean playWhenReady)` Sets whether playback should proceed when `getPlaybackState` == `STATE_READY`.
`void`	`setPlaybackParameters(PlaybackParameters playbackParameters)` Attempts to set the playback parameters.
`void`	`setPlaylistMetadata(MediaMetadata playlistMetadata)` Sets the playlist `MediaMetadata`.
`void`	`setRepeatMode(@Player.RepeatMode int repeatMode)` Sets the `RepeatMode` to be used for playback.
`void`	`setSessionAvailabilityListener( @Nullable SessionAvailabilityListener listener )` Sets a listener for updates on the cast session availability.
`void`	`setShuffleModeEnabled(boolean shuffleModeEnabled)` Sets whether shuffling of media items is enabled.
`void`	`setTrackSelectionParameters(TrackSelectionParameters parameters)` Sets the parameters constraining the track selection.
`void`	`setVideoSurface(@Nullable Surface surface)` This method is not supported and does nothing.
`void`	`setVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)` This method is not supported and does nothing.
`void`	`setVideoSurfaceView(@Nullable SurfaceView surfaceView)` This method is not supported and does nothing.
`void`	`setVideoTextureView(@Nullable TextureView textureView)` This method is not supported and does nothing.
`void`	`setVolume(float volume)` This method is not supported and does nothing.
`void`	`stop()` Stops playback without resetting the playlist.

Protected methods
`void`	`seekTo( int mediaItemIndex, long positionMs, @Player.Command int seekCommand, boolean isRepeatingCurrentItem )` Seeks to a position in the specified `MediaItem`.

Inherited Constants

From androidx.media3.common.Player

`static final int`	`COMMAND_ADJUST_DEVICE_VOLUME = 26` This field is deprecated. Use `COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS` instead.
`static final int`	`COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS = 34` Command to increase and decrease the device volume and mute it with volume flags.
`static final int`	`COMMAND_CHANGE_MEDIA_ITEMS = 20` Command to change the `media items` in the playlist.
`static final int`	`COMMAND_GET_AUDIO_ATTRIBUTES = 21` Command to get the player current `AudioAttributes`.
`static final int`	`COMMAND_GET_CURRENT_MEDIA_ITEM = 16` Command to get information about the currently playing `MediaItem`.
`static final int`	`COMMAND_GET_DEVICE_VOLUME = 23` Command to get the device volume and whether it is muted.
`static final int`	`COMMAND_GET_MEDIA_ITEMS_METADATA = 18` This field is deprecated. Use `COMMAND_GET_METADATA` instead.
`static final int`	`COMMAND_GET_METADATA = 18` Command to get metadata related to the playlist and current `MediaItem`.
`static final int`	`COMMAND_GET_TEXT = 28` Command to get the text that should currently be displayed by the player.
`static final int`	`COMMAND_GET_TIMELINE = 17` Command to get the information about the current timeline.
`static final int`	`COMMAND_GET_TRACKS = 30` Command to get details of the current track selection.
`static final int`	`COMMAND_GET_VOLUME = 22` Command to get the player volume.
`static final int`	`COMMAND_INVALID = -1` Represents an invalid `Command`.
`static final int`	`COMMAND_PLAY_PAUSE = 1` Command to start, pause or resume playback.
`static final int`	`COMMAND_PREPARE = 2` Command to prepare the player.
`static final int`	`COMMAND_RELEASE = 32` Command to release the player.
`static final int`	`COMMAND_SEEK_BACK = 11` Command to seek back by a fixed increment inside the current `MediaItem`.
`static final int`	`COMMAND_SEEK_FORWARD = 12` Command to seek forward by a fixed increment inside the current `MediaItem`.
`static final int`	`COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM = 5` Command to seek anywhere inside the current `MediaItem`.
`static final int`	`@UnstableApi COMMAND_SEEK_IN_CURRENT_WINDOW = 5` This field is deprecated. Use `COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM` instead.
`static final int`	`COMMAND_SEEK_TO_DEFAULT_POSITION = 4` Command to seek to the default position of the current `MediaItem`.
`static final int`	`COMMAND_SEEK_TO_MEDIA_ITEM = 10` Command to seek anywhere in any `MediaItem`.
`static final int`	`COMMAND_SEEK_TO_NEXT = 9` Command to seek to a later position in the current `MediaItem` or the default position of the next `MediaItem`.
`static final int`	`COMMAND_SEEK_TO_NEXT_MEDIA_ITEM = 8` Command to seek to the default position of the next `MediaItem`.
`static final int`	`@UnstableApi COMMAND_SEEK_TO_NEXT_WINDOW = 8` This field is deprecated. Use `COMMAND_SEEK_TO_NEXT_MEDIA_ITEM` instead.
`static final int`	`COMMAND_SEEK_TO_PREVIOUS = 7` Command to seek to an earlier position in the current `MediaItem` or the default position of the previous `MediaItem`.
`static final int`	`COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM = 6` Command to seek to the default position of the previous `MediaItem`.
`static final int`	`@UnstableApi COMMAND_SEEK_TO_PREVIOUS_WINDOW = 6` This field is deprecated. Use `COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM` instead.
`static final int`	`@UnstableApi COMMAND_SEEK_TO_WINDOW = 10` This field is deprecated. Use `COMMAND_SEEK_TO_MEDIA_ITEM` instead.
`static final int`	`COMMAND_SET_AUDIO_ATTRIBUTES = 35` Command to set the player's audio attributes.
`static final int`	`COMMAND_SET_DEVICE_VOLUME = 25` This field is deprecated. Use `COMMAND_SET_DEVICE_VOLUME_WITH_FLAGS` instead.
`static final int`	`COMMAND_SET_DEVICE_VOLUME_WITH_FLAGS = 33` Command to set the device volume with volume flags.
`static final int`	`COMMAND_SET_MEDIA_ITEM = 31` Command to set a `MediaItem`.
`static final int`	`COMMAND_SET_MEDIA_ITEMS_METADATA = 19` This field is deprecated. Use `COMMAND_SET_PLAYLIST_METADATA` instead.
`static final int`	`COMMAND_SET_PLAYLIST_METADATA = 19` Command to set the playlist metadata.
`static final int`	`COMMAND_SET_REPEAT_MODE = 15` Command to set the repeat mode.
`static final int`	`COMMAND_SET_SHUFFLE_MODE = 14` Command to enable shuffling.
`static final int`	`COMMAND_SET_SPEED_AND_PITCH = 13` Command to set the playback speed and pitch.
`static final int`	`COMMAND_SET_TRACK_SELECTION_PARAMETERS = 29` Command to set the player's track selection parameters.
`static final int`	`COMMAND_SET_VIDEO_SURFACE = 27` Command to set and clear the surface on which to render the video.
`static final int`	`COMMAND_SET_VOLUME = 24` Command to set the player volume.
`static final int`	`COMMAND_STOP = 3` Command to stop playback.
`static final int`	`DISCONTINUITY_REASON_AUTO_TRANSITION = 0` Automatic playback transition from one period in the timeline to the next.
`static final int`	`DISCONTINUITY_REASON_INTERNAL = 5` Discontinuity introduced internally (e.g. by the source).
`static final int`	`DISCONTINUITY_REASON_REMOVE = 4` Discontinuity caused by the removal of the current period from the `Timeline`.
`static final int`	`DISCONTINUITY_REASON_SEEK = 1` Seek within the current period or to another period.
`static final int`	`DISCONTINUITY_REASON_SEEK_ADJUSTMENT = 2` Seek adjustment due to being unable to seek to the requested position or because the seek was permitted to be inexact.
`static final int`	`DISCONTINUITY_REASON_SILENCE_SKIP = 6` Discontinuity introduced by a skipped silence.
`static final int`	`DISCONTINUITY_REASON_SKIP = 3` Discontinuity introduced by a skipped period (for instance a skipped ad).
`static final int`	`EVENT_AUDIO_ATTRIBUTES_CHANGED = 20` `getAudioAttributes` changed.
`static final int`	`EVENT_AUDIO_SESSION_ID = 21` The audio session id was set.
`static final int`	`EVENT_AVAILABLE_COMMANDS_CHANGED = 13` `isCommandAvailable` changed for at least one `Command`.
`static final int`	`EVENT_CUES = 27` `getCurrentCues` changed.
`static final int`	`EVENT_DEVICE_INFO_CHANGED = 29` `getDeviceInfo` changed.
`static final int`	`EVENT_DEVICE_VOLUME_CHANGED = 30` `getDeviceVolume` or `isDeviceMuted` changed.
`static final int`	`EVENT_IS_LOADING_CHANGED = 3` `isLoading` ()} changed.
`static final int`	`EVENT_IS_PLAYING_CHANGED = 7` `isPlaying` changed.
`static final int`	`EVENT_MAX_SEEK_TO_PREVIOUS_POSITION_CHANGED = 18` `getMaxSeekToPreviousPosition` changed.
`static final int`	`EVENT_MEDIA_ITEM_TRANSITION = 1` `getCurrentMediaItem` changed or the player started repeating the current item.
`static final int`	`EVENT_MEDIA_METADATA_CHANGED = 14` `getMediaMetadata` changed.
`static final int`	`EVENT_METADATA = 28` Metadata associated with the current playback time changed.
`static final int`	`EVENT_PLAYBACK_PARAMETERS_CHANGED = 12` `getPlaybackParameters` changed.
`static final int`	`EVENT_PLAYBACK_STATE_CHANGED = 4` `getPlaybackState` changed.
`static final int`	`EVENT_PLAYBACK_SUPPRESSION_REASON_CHANGED = 6` `getPlaybackSuppressionReason` changed.
`static final int`	`EVENT_PLAYER_ERROR = 10` `getPlayerError` changed.
`static final int`	`EVENT_PLAYLIST_METADATA_CHANGED = 15` `getPlaylistMetadata` changed.
`static final int`	`EVENT_PLAY_WHEN_READY_CHANGED = 5` `getPlayWhenReady` changed.
`static final int`	`EVENT_POSITION_DISCONTINUITY = 11` A position discontinuity occurred.
`static final int`	`EVENT_RENDERED_FIRST_FRAME = 26` A frame is rendered for the first time since setting the surface, or since the renderer was reset, or since the stream being rendered was changed.
`static final int`	`EVENT_REPEAT_MODE_CHANGED = 8` `getRepeatMode` changed.
`static final int`	`EVENT_SEEK_BACK_INCREMENT_CHANGED = 16` `getSeekBackIncrement` changed.
`static final int`	`EVENT_SEEK_FORWARD_INCREMENT_CHANGED = 17` `getSeekForwardIncrement` changed.
`static final int`	`EVENT_SHUFFLE_MODE_ENABLED_CHANGED = 9` `getShuffleModeEnabled` changed.
`static final int`	`EVENT_SKIP_SILENCE_ENABLED_CHANGED = 23` Skipping silences in the audio stream is enabled or disabled.
`static final int`	`EVENT_SURFACE_SIZE_CHANGED = 24` The size of the surface onto which the video is being rendered changed.
`static final int`	`EVENT_TIMELINE_CHANGED = 0` `getCurrentTimeline` changed.
`static final int`	`EVENT_TRACKS_CHANGED = 2` `getCurrentTracks` changed.
`static final int`	`EVENT_TRACK_SELECTION_PARAMETERS_CHANGED = 19` `getTrackSelectionParameters` changed.
`static final int`	`EVENT_VIDEO_SIZE_CHANGED = 25` `getVideoSize` changed.
`static final int`	`EVENT_VOLUME_CHANGED = 22` `getVolume` changed.
`static final int`	`MEDIA_ITEM_TRANSITION_REASON_AUTO = 1` Playback has automatically transitioned to the next media item.
`static final int`	`MEDIA_ITEM_TRANSITION_REASON_PLAYLIST_CHANGED = 3` The current media item has changed because of a change in the playlist.
`static final int`	`MEDIA_ITEM_TRANSITION_REASON_REPEAT = 0` The media item has been repeated.
`static final int`	`MEDIA_ITEM_TRANSITION_REASON_SEEK = 2` A seek to another media item has occurred.
`static final int`	`PLAYBACK_SUPPRESSION_REASON_NONE = 0` Playback is not suppressed.
`static final int`	`PLAYBACK_SUPPRESSION_REASON_SCRUBBING = 4` Playback is suppressed because the player is currently scrubbing.
`static final int`	`PLAYBACK_SUPPRESSION_REASON_TRANSIENT_AUDIO_FOCUS_LOSS = 1` Playback is suppressed due to transient audio focus loss.
`static final int`	`PLAYBACK_SUPPRESSION_REASON_UNSUITABLE_AUDIO_OUTPUT = 3` Playback is suppressed due to attempt to play on an unsuitable audio output (e.g. attempt to play on built-in speaker on a Wear OS device).
`static final int`	`PLAYBACK_SUPPRESSION_REASON_UNSUITABLE_AUDIO_ROUTE = 2` This field is deprecated. Use `PLAYBACK_SUPPRESSION_REASON_UNSUITABLE_AUDIO_OUTPUT` instead.
`static final int`	`PLAY_WHEN_READY_CHANGE_REASON_AUDIO_BECOMING_NOISY = 3` Playback has been paused to avoid becoming noisy.
`static final int`	`PLAY_WHEN_READY_CHANGE_REASON_AUDIO_FOCUS_LOSS = 2` Playback has been paused because of a loss of audio focus.
`static final int`	`PLAY_WHEN_READY_CHANGE_REASON_END_OF_MEDIA_ITEM = 5` Playback has been paused at the end of a media item.
`static final int`	`PLAY_WHEN_READY_CHANGE_REASON_REMOTE = 4` Playback has been started or paused because of a remote change.
`static final int`	`PLAY_WHEN_READY_CHANGE_REASON_SUPPRESSED_TOO_LONG = 6` Playback has been paused because playback has been `suppressed` too long.
`static final int`	`PLAY_WHEN_READY_CHANGE_REASON_USER_REQUEST = 1` Playback has been started or paused by a call to `setPlayWhenReady`.
`static final int`	`REPEAT_MODE_ALL = 2` Repeats the entire timeline infinitely.
`static final int`	`REPEAT_MODE_OFF = 0` Normal playback without repetition.
`static final int`	`REPEAT_MODE_ONE = 1` Repeats the currently playing `MediaItem` infinitely during ongoing playback.
`static final int`	`STATE_BUFFERING = 2` The player is not able to immediately play the media, but is doing work toward being able to do so.
`static final int`	`STATE_ENDED = 4` The player has finished playing the media.
`static final int`	`STATE_IDLE = 1` The player is idle, meaning it holds only limited resources.
`static final int`	`STATE_READY = 3` The player is able to immediately play from its current position.
`static final int`	`TIMELINE_CHANGE_REASON_PLAYLIST_CHANGED = 0` Timeline changed as a result of a change of the playlist items or the order of the items.
`static final int`	`TIMELINE_CHANGE_REASON_SOURCE_UPDATE = 1` Timeline changed as a result of a source update (e.g. result of a dynamic update by the played media).

Inherited fields

From androidx.media3.common.BasePlayer

final Timeline.Window

window

Inherited methods

From androidx.media3.common.BasePlayer

`final void`	`addMediaItem(MediaItem mediaItem)` Adds a media item to the end of the playlist.
`final void`	`addMediaItem(int index, MediaItem mediaItem)` Adds a media item at the given index of the playlist.
`final void`	`addMediaItems(List<MediaItem> mediaItems)` Adds a list of media items to the end of the playlist.
`final boolean`	`canAdvertiseSession()` Returns whether the player can be used to advertise a media session.
`final void`	`clearMediaItems()` Clears the playlist.
`final int`	`getBufferedPercentage()` Returns an estimate of the percentage in the current content or ad up to which data is buffered, or 0 if no estimate is available.
`final long`	`getContentDuration()` If `isPlayingAd` returns `true`, returns the duration of the current content in milliseconds, or `TIME_UNSET` if the duration is not known.
`final long`	`getCurrentLiveOffset()` Returns the offset of the current playback position from the live edge in milliseconds, or `TIME_UNSET` if the current `MediaItemisn't live` or the offset is unknown.
`final @Nullable Object`	`getCurrentManifest()` Returns the current manifest.
`final @Nullable MediaItem`	`getCurrentMediaItem()` Returns the currently playing `MediaItem`.
`final int`	`getCurrentWindowIndex()` This method is deprecated. Use `getCurrentMediaItemIndex` instead.
`final MediaItem`	`getMediaItemAt(int index)` Returns the `MediaItem` at the given index.
`final int`	`getMediaItemCount()` Returns the number of `media items` in the playlist.
`final int`	`getNextMediaItemIndex()` Returns the index of the `MediaItem` that will be played if `seekToNextMediaItem` is called, which may depend on the current repeat mode and whether shuffle mode is enabled.
`final int`	`getNextWindowIndex()` This method is deprecated. Use `getNextMediaItemIndex` instead.
`final int`	`getPreviousMediaItemIndex()` Returns the index of the `MediaItem` that will be played if `seekToPreviousMediaItem` is called, which may depend on the current repeat mode and whether shuffle mode is enabled.
`final int`	`getPreviousWindowIndex()` This method is deprecated. Use `getPreviousMediaItemIndex` instead.
`final boolean`	`hasNextMediaItem()` Returns whether a next `MediaItem` exists, which may depend on the current repeat mode and whether shuffle mode is enabled.
`final boolean`	`hasPreviousMediaItem()` Returns whether a previous media item exists, which may depend on the current repeat mode and whether shuffle mode is enabled.
`final boolean`	`isCommandAvailable(@Player.Command int command)` Returns whether the provided `Command` is available.
`final boolean`	`isCurrentMediaItemDynamic()` Returns whether the current `MediaItem` is dynamic (may change when the `Timeline` is updated), or `false` if the `Timeline` is empty.
`final boolean`	`isCurrentMediaItemLive()` Returns whether the current `MediaItem` is live, or `false` if the `Timeline` is empty.
`final boolean`	`isCurrentMediaItemSeekable()` Returns whether the current `MediaItem` is seekable, or `false` if the is empty.
`final boolean`	`isCurrentWindowDynamic()` This method is deprecated. Use `isCurrentMediaItemDynamic` instead.
`final boolean`	`isCurrentWindowLive()` This method is deprecated. Use `isCurrentMediaItemLive` instead.
`final boolean`	`isCurrentWindowSeekable()` This method is deprecated. Use `isCurrentMediaItemSeekable` instead.
`final boolean`	`isPlaying()` Returns whether the player is playing, i.e. `getCurrentPosition` is advancing.
`final void`	`moveMediaItem(int currentIndex, int newIndex)` Moves the media item at the current index to the new index.
`final void`	`pause()` Pauses playback.
`final void`	`play()` Resumes playback as soon as `getPlaybackState` == `STATE_READY`.
`final void`	`removeMediaItem(int index)` Removes the media item at the given index of the playlist.
`final void`	`replaceMediaItem(int index, MediaItem mediaItem)` Replaces the media item at the given index of the playlist.
`final void`	`seekBack()` Seeks back in the current `MediaItem` by `getSeekBackIncrement` milliseconds.
`final void`	`seekForward()` Seeks forward in the current `MediaItem` by `getSeekForwardIncrement` milliseconds.
`final void`	`seekTo(long positionMs)` Seeks to a position specified in milliseconds in the current `MediaItem`.
`final void`	`seekTo(int mediaItemIndex, long positionMs)` Seeks to a position specified in milliseconds in the specified `MediaItem`.
`final void`	`seekToDefaultPosition()` Seeks to the default position associated with the current `MediaItem`.
`final void`	`seekToDefaultPosition(int mediaItemIndex)` Seeks to the default position associated with the specified `MediaItem`.
`final void`	`seekToNext()` Seeks to a later position in the current or next `MediaItem` (if available).
`final void`	`seekToNextMediaItem()` Seeks to the default position of the next `MediaItem`, which may depend on the current repeat mode and whether shuffle mode is enabled.
`final void`	`seekToPrevious()` Seeks to an earlier position in the current or previous `MediaItem` (if available).
`final void`	`seekToPreviousMediaItem()` Seeks to the default position of the previous `MediaItem`, which may depend on the current repeat mode and whether shuffle mode is enabled.
`final void`	`setMediaItem(MediaItem mediaItem)` Clears the playlist, adds the specified `MediaItem` and resets the position to the default position.
`final void`	`setMediaItem(MediaItem mediaItem, boolean resetPosition)` Clears the playlist and adds the specified `MediaItem`.
`final void`	`setMediaItem(MediaItem mediaItem, long startPositionMs)` Clears the playlist and adds the specified `MediaItem`.
`final void`	`setMediaItems(List<MediaItem> mediaItems)` Clears the playlist, adds the specified `media items` and resets the position to the default position.
`final void`	`setPlaybackSpeed(float speed)` Changes the rate at which playback occurs.

From androidx.media3.common.Player

`abstract void`	`setPlaybackSpeed(@FloatRange(from = 0, fromInclusive = false) float speed)` Changes the rate at which playback occurs.
`abstract void`	`setPlaylistMetadata(MediaMetadata mediaMetadata)` Sets the playlist `MediaMetadata`.

Constants

DEVICE_INFO_REMOTE_EMPTY

public static final DeviceInfo DEVICE_INFO_REMOTE_EMPTY

A remoteDeviceInfo with a null routingControllerId.

MAX_SPEED_SUPPORTED

public static final float MAX_SPEED_SUPPORTED = 2.0f

MIN_SPEED_SUPPORTED

public static final float MIN_SPEED_SUPPORTED = 0.5f

Public fields

availableCommands

public Player.Commands availableCommands

currentTracks

public Tracks currentTracks

deviceInfo

public DeviceInfo deviceInfo

deviceVolume

public int deviceVolume

mediaMetadata

public MediaMetadata mediaMetadata

playbackState

@Player.State
public int playbackState

playlistMetadata

public MediaMetadata playlistMetadata

Public constructors

CastPlayer

public CastPlayer(CastContext castContext)

Creates a new cast player.

The returned player uses a DefaultMediaItemConverter and

mediaItemConverter is set to a DefaultMediaItemConverter, seekBackIncrementMs is set to DEFAULT_SEEK_BACK_INCREMENT_MS and seekForwardIncrementMs is set to DEFAULT_SEEK_FORWARD_INCREMENT_MS.

Parameters
`CastContext castContext`	The context from which the cast session is obtained.

CastPlayer

public CastPlayer(
    CastContext castContext,
    MediaItemConverter mediaItemConverter
)

Creates a new cast player.

seekBackIncrementMs is set to DEFAULT_SEEK_BACK_INCREMENT_MS and seekForwardIncrementMs is set to DEFAULT_SEEK_FORWARD_INCREMENT_MS.

Parameters
`CastContext castContext`	The context from which the cast session is obtained.
`MediaItemConverter mediaItemConverter`	The `MediaItemConverter` to use.

CastPlayer

public CastPlayer(
    CastContext castContext,
    MediaItemConverter mediaItemConverter,
    @IntRange(from = 1) long seekBackIncrementMs,
    @IntRange(from = 1) long seekForwardIncrementMs
)

Creates a new cast player.

Parameters
`CastContext castContext`	The context from which the cast session is obtained.
`MediaItemConverter mediaItemConverter`	The `MediaItemConverter` to use.
`@IntRange(from = 1) long seekBackIncrementMs`	The `seekBack` increment, in milliseconds.
`@IntRange(from = 1) long seekForwardIncrementMs`	The `seekForward` increment, in milliseconds.

Throws
`java.lang.IllegalArgumentException`	If `seekBackIncrementMs` or `seekForwardIncrementMs` is non-positive.

CastPlayer

public CastPlayer(
    @Nullable Context context,
    CastContext castContext,
    MediaItemConverter mediaItemConverter,
    @IntRange(from = 1) long seekBackIncrementMs,
    @IntRange(from = 1) long seekForwardIncrementMs,
    @IntRange(from = 0) long maxSeekToPreviousPositionMs
)

Creates a new cast player.

Parameters
`@Nullable Context context`	A `Context` used to populate `getDeviceInfo`. If null, `getDeviceInfo` will always return `DEVICE_INFO_REMOTE_EMPTY`.
`CastContext castContext`	The context from which the cast session is obtained.
`MediaItemConverter mediaItemConverter`	The `MediaItemConverter` to use.
`@IntRange(from = 1) long seekBackIncrementMs`	The `seekBack` increment, in milliseconds.
`@IntRange(from = 1) long seekForwardIncrementMs`	The `seekForward` increment, in milliseconds.
`@IntRange(from = 0) long maxSeekToPreviousPositionMs`	The maximum position for which `seekToPrevious` seeks to the previous `MediaItem`, in milliseconds.

Throws
`java.lang.IllegalArgumentException`	If `seekBackIncrementMs` or `seekForwardIncrementMs` is non-positive, or if `maxSeekToPreviousPositionMs` is negative.

Public methods

addListener

public void addListener(Player.Listener listener)

Registers a listener to receive all events from the player.

The listener's methods will be called on the thread associated with getApplicationLooper.

This method can be called from any thread.

Parameters
`Player.Listener listener`	The listener to register.

addMediaItems

public void addMediaItems(int index, List<MediaItem> mediaItems)

Adds a list of media items at the given index of the playlist.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`int index`	The index at which to add the media items. If the index is larger than the size of the playlist, the media items are added to the end of the playlist.
`List<MediaItem> mediaItems`	The `media items` to add.

clearVideoSurface

public void clearVideoSurface()

This method is not supported and does nothing.

clearVideoSurface

public void clearVideoSurface(@Nullable Surface surface)

This method is not supported and does nothing.

clearVideoSurfaceHolder

public void clearVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)

This method is not supported and does nothing.

clearVideoSurfaceView

public void clearVideoSurfaceView(@Nullable SurfaceView surfaceView)

This method is not supported and does nothing.

clearVideoTextureView

public void clearVideoTextureView(@Nullable TextureView textureView)

This method is not supported and does nothing.

decreaseDeviceVolume

@InlineMe(replacement = "this.decreaseDeviceVolume(0)")
public void decreaseDeviceVolume()

decreaseDeviceVolume

public void decreaseDeviceVolume(@C.VolumeFlags int flags)

Decreases the volume of the device.

The getDeviceVolume device volume cannot be decreased below minVolume.

Note that this method affects the device volume. To change the volume of the current stream only, use setVolume.

This method must only be called if COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS is available.

Parameters
`@C.VolumeFlags int flags`	Either 0 or a bitwise combination of one or more `C.VolumeFlags`.

getApplicationLooper

public Looper getApplicationLooper()

Returns the Looper associated with the application thread that's used to access the player and on which player events are received.

This method can be called from any thread.

getAudioAttributes

public AudioAttributes getAudioAttributes()

This method is not supported and returns DEFAULT.

getAvailableCommands

public Player.Commands getAvailableCommands()

Returns the player's currently available Commands.

The returned Commands are not updated when available commands change. Use onAvailableCommandsChanged to get an update when the available commands change.

Returns
`Player.Commands`	The currently available `Commands`.

See also
`onAvailableCommandsChanged`

getBufferedPosition

public long getBufferedPosition()

Returns an estimate of the position in the current content or ad up to which data is buffered, in milliseconds.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getContentBufferedPosition

public long getContentBufferedPosition()

If isPlayingAd returns true, returns an estimate of the content position in the current content up to which data is buffered, in milliseconds. If there is no ad playing, the returned position is the same as that returned by getBufferedPosition.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getContentPosition

public long getContentPosition()

If isPlayingAd returns true, returns the content position that will be played once all ads in the ad group have finished playing, in milliseconds. If there is no ad playing, the returned position is the same as that returned by getCurrentPosition.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getCurrentAdGroupIndex

public int getCurrentAdGroupIndex()

If isPlayingAd returns true, returns the index of the ad group in the period currently being played. Returns INDEX_UNSET otherwise.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getCurrentAdIndexInAdGroup

public int getCurrentAdIndexInAdGroup()

If isPlayingAd returns true, returns the index of the ad in its ad group. Returns INDEX_UNSET otherwise.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getCurrentCues

public CueGroup getCurrentCues()

This method is not supported and returns an empty CueGroup.

getCurrentMediaItemIndex

public int getCurrentMediaItemIndex()

Returns the index of the current MediaItem in the timeline, or the prospective index if the current timeline is empty.

This method must only be called if COMMAND_GET_TIMELINE is available.

getCurrentPeriodIndex

public int getCurrentPeriodIndex()

Returns the index of the period currently being played.

This method must only be called if COMMAND_GET_TIMELINE is available.

getCurrentPosition

public long getCurrentPosition()

Returns the playback position in the current content or ad, in milliseconds, or the prospective position in milliseconds if the current timeline is empty.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getCurrentTimeline

public Timeline getCurrentTimeline()

Returns the current Timeline. Never null, but may be empty.

This method must only be called if COMMAND_GET_TIMELINE is available.

See also
`onTimelineChanged`

getCurrentTracks

public Tracks getCurrentTracks()

Returns the current tracks.

This method must only be called if COMMAND_GET_TRACKS is available.

See also
`onTracksChanged`

getDeviceInfo

public DeviceInfo getDeviceInfo()

Returns a DeviceInfo describing the receiver device. Returns DEVICE_INFO_REMOTE_EMPTY if no Context was provided at construction, or if the Cast RoutingController could not be identified.

getDeviceVolume

public int getDeviceVolume()

Gets the current volume of the device.

For devices with local playback, the volume returned by this method varies according to the current stream type. The stream type is determined by getStreamType.

For devices with remote playback, the volume of the remote device is returned.

Note that this method returns the volume of the device. To check the current stream volume, use getVolume.

This method must only be called if COMMAND_GET_DEVICE_VOLUME is available.

See also
`onDeviceVolumeChanged`

getDuration

public long getDuration()

Returns the duration of the current content or ad in milliseconds, or TIME_UNSET if the duration is not known.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getItem

public @Nullable MediaQueueItem getItem(int periodId)

Returns the item that corresponds to the period with the given id, or null if no media queue or period with id periodId exist.

Parameters
`int periodId`	The id of the period (`getCurrentTimeline`) that corresponds to the item to get.

Returns
`@Nullable MediaQueueItem`	The item that corresponds to the period with the given id, or null if no media queue or period with id `periodId` exist.

getMaxSeekToPreviousPosition

public long getMaxSeekToPreviousPosition()

Returns the maximum position for which seekToPrevious seeks to the previous , in milliseconds.

Returns
`long`	The maximum seek to previous position, in milliseconds.

See also
`onMaxSeekToPreviousPositionChanged`

getMediaMetadata

public MediaMetadata getMediaMetadata()

Returns the current combined MediaMetadata, or EMPTY if not supported.

This MediaMetadata is a combination of the MediaItem metadata, the static metadata in the media's Format, and any timed metadata that has been parsed from the media and output via onMetadata. If a field is populated in the mediaMetadata, it will be prioritised above the same field coming from static or timed metadata.

This method must only be called if COMMAND_GET_METADATA is available.

See also
`onMediaMetadataChanged`

getMediaMetadataInternal

public MediaMetadata getMediaMetadataInternal()

getPlayWhenReady

public boolean getPlayWhenReady()

Whether playback will proceed when getPlaybackState == STATE_READY.

Returns
`boolean`	Whether playback will proceed when ready.

See also
`onPlayWhenReadyChanged`

getPlaybackParameters

public PlaybackParameters getPlaybackParameters()

Returns the currently active playback parameters.

See also
`onPlaybackParametersChanged`

getPlaybackState

@Player.State
public int getPlaybackState()

Returns the current playback state of the player.

Returns
`int`	The current `playback state`.

See also
`onPlaybackStateChanged`

getPlaybackSuppressionReason

@Player.PlaybackSuppressionReason
public int getPlaybackSuppressionReason()

Returns the reason why playback is suppressed even though getPlayWhenReady is true, or PLAYBACK_SUPPRESSION_REASON_NONE if playback is not suppressed.

Returns
`int`	The current `PlaybackSuppressionReason`.

See also
`onPlaybackSuppressionReasonChanged`

getPlayerError

public @Nullable PlaybackException getPlayerError()

Returns the error that caused playback to fail. This is the same error that will have been reported via onPlayerError at the time of failure. It can be queried using this method until the player is re-prepared.

Note that this method will always return null if getPlaybackState is not STATE_IDLE.

Returns
`@Nullable PlaybackException`	The error, or `null`.

See also
`onPlayerError`

getPlaylistMetadata

public MediaMetadata getPlaylistMetadata()

Returns the playlist MediaMetadata, as set by setPlaylistMetadata, or EMPTY if not supported.

This method must only be called if COMMAND_GET_METADATA is available.

See also
`onPlaylistMetadataChanged`

getRepeatMode

@Player.RepeatMode
public int getRepeatMode()

Returns the current RepeatMode used for playback.

Returns
`int`	The current repeat mode.

See also
`onRepeatModeChanged`

getSeekBackIncrement

public long getSeekBackIncrement()

Returns the seekBack increment.

Returns
`long`	The seek back increment, in milliseconds.

See also
`onSeekBackIncrementChanged`

getSeekForwardIncrement

public long getSeekForwardIncrement()

Returns the seekForward increment.

Returns
`long`	The seek forward increment, in milliseconds.

See also
`onSeekForwardIncrementChanged`

getShuffleModeEnabled

public boolean getShuffleModeEnabled()

Returns whether shuffling of media items is enabled.

See also
`onShuffleModeEnabledChanged`

getSurfaceSize

public Size getSurfaceSize()

This method is not supported and returns UNKNOWN.

getTotalBufferedDuration

public long getTotalBufferedDuration()

Returns an estimate of the total buffered duration from the current position, in milliseconds. This includes pre-buffered data for subsequent ads and media items.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getTrackSelectionParameters

public TrackSelectionParameters getTrackSelectionParameters()

Returns the parameters constraining the track selection.

See also
`onTrackSelectionParametersChanged`	}

getVideoSize

public VideoSize getVideoSize()

This method is not supported and returns UNKNOWN.

getVolume

public float getVolume()

This method is not supported and returns 1.

increaseDeviceVolume

@InlineMe(replacement = "this.increaseDeviceVolume(0)")
public void increaseDeviceVolume()

increaseDeviceVolume

public void increaseDeviceVolume(@C.VolumeFlags int flags)

Increases the volume of the device.

The getDeviceVolume device volume cannot be increased above maxVolume, if defined.

Note that this method affects the device volume. To change the volume of the current stream only, use setVolume.

This method must only be called if COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS is available.

Parameters
`@C.VolumeFlags int flags`	Either 0 or a bitwise combination of one or more `C.VolumeFlags`.

isCastSessionAvailable

public boolean isCastSessionAvailable()

Returns whether a cast session is available.

isDeviceMuted

public boolean isDeviceMuted()

Gets whether the device is muted or not.

Note that this method returns the mute state of the device. To check if the current stream is muted, use getVolume() == 0.

This method must only be called if COMMAND_GET_DEVICE_VOLUME is available.

See also
`onDeviceVolumeChanged`

isLoading

public boolean isLoading()

Whether the player is currently loading the source.

Returns
`boolean`	Whether the player is currently loading the source.

See also
`onIsLoadingChanged`

isPlayingAd

public boolean isPlayingAd()

Returns whether the player is currently playing an ad.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

moveMediaItems

public void moveMediaItems(int fromIndex, int toIndex, int newIndex)

Moves the media item range to the new index.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`int fromIndex`	The start of the range to move. If the index is larger than the size of the playlist, the request is ignored.
`int toIndex`	The first item not to be included in the range (exclusive). If the index is larger than the size of the playlist, items up to the end of the playlist are moved.
`int newIndex`	The new index of the first media item of the range. If the new index is larger than the size of the remaining playlist after removing the range, the range is moved to the end of the playlist.

prepare

public void prepare()

Prepares the player.

This method must only be called if COMMAND_PREPARE is available.

This will move the player out of idle state and the player will start loading media and acquire resources needed for playback.

release

public void release()

Releases the player. This method must be called when the player is no longer required. The player must not be used after calling this method.

This method must only be called if COMMAND_RELEASE is available.

removeListener

public void removeListener(Player.Listener listener)

Unregister a listener registered through addListener. The listener will no longer receive events.

Parameters
`Player.Listener listener`	The listener to unregister.

removeMediaItems

public void removeMediaItems(int fromIndex, int toIndex)

Removes a range of media items from the playlist.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`int fromIndex`	The index at which to start removing media items. If the index is larger than the size of the playlist, the request is ignored.
`int toIndex`	The index of the first item to be kept (exclusive). If the index is larger than the size of the playlist, media items up to the end of the playlist are removed.

replaceMediaItems

public void replaceMediaItems(
    int fromIndex,
    int toIndex,
    List<MediaItem> mediaItems
)

Replaces the media items at the given range of the playlist.

Implementations of this method may attempt to seamlessly continue playback if the currently playing media item is replaced with a compatible one (e.g. same URL, only metadata has changed).

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Note that it is possible to replace a range with an arbitrary number of new items, so that the number of removed items defined by fromIndex and toIndex does not have to match the number of added items defined by mediaItems. As result, it may also change the index of subsequent items not touched by this operation.

Parameters
`int fromIndex`	The start of the range. If the index is larger than the size of the playlist, the request is ignored.
`int toIndex`	The first item not to be included in the range (exclusive). If the index is larger than the size of the playlist, items up to the end of the playlist are replaced.
`List<MediaItem> mediaItems`	The `media items` to replace the range with.

setAudioAttributes

public void setAudioAttributes(
    AudioAttributes audioAttributes,
    boolean handleAudioFocus
)

This method is not supported and does nothing.

setDeviceMuted

@InlineMe(replacement = "this.setDeviceMuted(muted, 0)")
public void setDeviceMuted(boolean muted)

setDeviceMuted

public void setDeviceMuted(boolean muted, @C.VolumeFlags int flags)

Sets the mute state of the device.

Note that this method affects the device volume. To mute just the current stream, use setVolume(0) instead.

This method must only be called if COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS is available.

Parameters
`boolean muted`	Whether to set the device to be muted or not
`@C.VolumeFlags int flags`	Either 0 or a bitwise combination of one or more `C.VolumeFlags`.

setDeviceVolume

@InlineMe(replacement = "this.setDeviceVolume(volume, 0)")
public void setDeviceVolume(@IntRange(from = 0) int volume)

setDeviceVolume

public void setDeviceVolume(@IntRange(from = 0) int volume, @C.VolumeFlags int flags)

Sets the volume of the device with volume flags.

Note that this method affects the device volume. To change the volume of the current stream only, use setVolume.

This method must only be called if COMMAND_SET_DEVICE_VOLUME_WITH_FLAGS is available.

Parameters
`@IntRange(from = 0) int volume`	The volume to set.
`@C.VolumeFlags int flags`	Either 0 or a bitwise combination of one or more `C.VolumeFlags`.

setMediaItems

public void setMediaItems(List<MediaItem> mediaItems, boolean resetPosition)

Clears the playlist and adds the specified media items.

To replace a span of media items (possibly seamlessly) without clearing the playlist, use replaceMediaItems.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`List<MediaItem> mediaItems`	The new `media items`.
`boolean resetPosition`	Whether the playback position should be reset to the default position in the first `Timeline.Window`. If false, playback will start from the position defined by `getCurrentMediaItemIndex` and `getCurrentPosition`.

setMediaItems

public void setMediaItems(
    List<MediaItem> mediaItems,
    int startIndex,
    long startPositionMs
)

Clears the playlist and adds the specified media items.

To replace a span of media items (possibly seamlessly) without clearing the playlist, use replaceMediaItems.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`List<MediaItem> mediaItems`	The new `media items`.
`int startIndex`	The `MediaItem` index to start playback from. If `INDEX_UNSET` is passed, the current position is not reset.
`long startPositionMs`	The position in milliseconds to start playback from. If `TIME_UNSET` is passed, the default position of the given `MediaItem` is used. In any case, if `startIndex` is set to `INDEX_UNSET`, this parameter is ignored and the position is not reset at all.

Throws
`androidx.media3.common.IllegalSeekPositionException`	If the provided `startIndex` is not within the bounds of the list of media items.

setPlayWhenReady

public void setPlayWhenReady(boolean playWhenReady)

Sets whether playback should proceed when getPlaybackState == STATE_READY.

If the player is already in the ready state then this method pauses and resumes playback.

This method must only be called if COMMAND_PLAY_PAUSE is available.

Parameters
`boolean playWhenReady`	Whether playback should proceed when ready.

setPlaybackParameters

public void setPlaybackParameters(PlaybackParameters playbackParameters)

Attempts to set the playback parameters. Passing DEFAULT resets the player to the default, which means there is no speed or pitch adjustment.

Playback parameters changes may cause the player to buffer. onPlaybackParametersChanged will be called whenever the currently active playback parameters change.

This method must only be called if COMMAND_SET_SPEED_AND_PITCH is available.

Parameters
`PlaybackParameters playbackParameters`	The playback parameters.

setPlaylistMetadata

public void setPlaylistMetadata(MediaMetadata playlistMetadata)

Sets the playlist MediaMetadata.

This method must only be called if COMMAND_SET_PLAYLIST_METADATA is available.

setRepeatMode

public void setRepeatMode(@Player.RepeatMode int repeatMode)

Sets the RepeatMode to be used for playback.

This method must only be called if COMMAND_SET_REPEAT_MODE is available.

Parameters
`@Player.RepeatMode int repeatMode`	The repeat mode.

setSessionAvailabilityListener

public void setSessionAvailabilityListener(
    @Nullable SessionAvailabilityListener listener
)

Sets a listener for updates on the cast session availability.

Parameters
`@Nullable SessionAvailabilityListener listener`	The `SessionAvailabilityListener`, or null to clear the listener.

setShuffleModeEnabled

public void setShuffleModeEnabled(boolean shuffleModeEnabled)

Sets whether shuffling of media items is enabled.

This method must only be called if COMMAND_SET_SHUFFLE_MODE is available.

Parameters
`boolean shuffleModeEnabled`	Whether shuffling is enabled.

setTrackSelectionParameters

public void setTrackSelectionParameters(TrackSelectionParameters parameters)

Sets the parameters constraining the track selection.

Unsupported parameters will be silently ignored.

Use getTrackSelectionParameters to retrieve the current parameters. For example, the following snippet restricts video to SD whilst keep other track selection parameters unchanged:

player.setTrackSelectionParameters(
  player.getTrackSelectionParameters()
        .buildUpon()
        .setMaxVideoSizeSd()
        .build())

This method must only be called if COMMAND_SET_TRACK_SELECTION_PARAMETERS is available.

setVideoSurface

public void setVideoSurface(@Nullable Surface surface)

This method is not supported and does nothing.

setVideoSurfaceHolder

public void setVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)

This method is not supported and does nothing.

setVideoSurfaceView

public void setVideoSurfaceView(@Nullable SurfaceView surfaceView)

This method is not supported and does nothing.

setVideoTextureView

public void setVideoTextureView(@Nullable TextureView textureView)

This method is not supported and does nothing.

setVolume

public void setVolume(float volume)

This method is not supported and does nothing.

stop

public void stop()

Stops playback without resetting the playlist. Use pause rather than this method if the intention is to pause playback.

Calling this method will cause the playback state to transition to STATE_IDLE and the player will release the loaded media and resources required for playback. The player instance can still be used by calling prepare again, and release must still be called on the player if it's no longer required.

Calling this method does not clear the playlist, reset the playback position or the playback error.

This method must only be called if COMMAND_STOP is available.

Protected methods

seekTo

protected void seekTo(
    int mediaItemIndex,
    long positionMs,
    @Player.Command int seekCommand,
    boolean isRepeatingCurrentItem
)

Seeks to a position in the specified MediaItem.

Parameters
`int mediaItemIndex`	The index of the `MediaItem`. If the original seek operation did not directly specify an index, this is the most likely implied index based on the available player state. If the implied action is to do nothing, this will be `INDEX_UNSET`.
`long positionMs`	The seek position in the specified `MediaItem` in milliseconds, or `TIME_UNSET` to seek to the media item's default position. If the original seek operation did not directly specify a position, this is the most likely implied position based on the available player state.
`@Player.Command int seekCommand`	The `Player.Command` used to trigger the seek.
`boolean isRepeatingCurrentItem`	Whether this seeks repeats the current item.