SimpleBasePlayer

Kotlin |Java

@UnstableApi
public abstract class SimpleBasePlayer extends BasePlayer

java.lang.Object
↳	androidx.media3.common.BasePlayer
	↳	androidx.media3.common.SimpleBasePlayer

Known direct subclasses

ForwardingSimpleBasePlayer

ForwardingSimpleBasePlayer

A SimpleBasePlayer that forwards all calls to another Player instance.

A base implementation for Player that reduces the number of methods to implement to a minimum.

Implementation notes:

Subclasses must override getState to populate the current player state on request.
The State should set the available commands to indicate which Player methods are supported.
All setter-like player methods (for example, setPlayWhenReady) forward to overridable methods (for example, handleSetPlayWhenReady) that can be used to handle these requests. These methods return a ListenableFuture to indicate when the request has been handled and is fully reflected in the values returned from getState. This class will automatically request a state update once the request is done. If the state changes can be handled synchronously, these methods can return Guava's immediateVoidFuture.
Subclasses can manually trigger state updates with invalidateState, for example if something changes independent of Player method calls.

This base class handles various aspects of the player implementation to simplify the subclass:

The State can only be created with allowed combinations of state values, avoiding any invalid player states.
Only functionality that is declared as available needs to be implemented. Other methods are automatically ignored.
Listener handling and informing listeners of state changes is handled automatically.
The base class provides a framework for asynchronous handling of method calls. It changes the visible playback state immediately to the most likely outcome to ensure the user-visible state changes look like synchronous operations. The state is then updated again once the asynchronous method calls have been fully handled.

Summary

Nested types
`protected final class SimpleBasePlayer.MediaItemData` An immutable description of an item in the playlist, containing both static setup information like `MediaItem` and dynamic data that is generally read from the media like the duration.
`public final class SimpleBasePlayer.MediaItemData.Builder` A builder for `MediaItemData` objects.
`protected final class SimpleBasePlayer.PeriodData` Data describing the properties of a period inside a `MediaItemData`.
`public final class SimpleBasePlayer.PeriodData.Builder` A builder for `PeriodData` objects.
`protected interface SimpleBasePlayer.PositionSupplier` A supplier for a position.
`protected final class SimpleBasePlayer.State` An immutable state description of the player.
`public final class SimpleBasePlayer.State.Builder` A builder for `State` objects.

Public fields
`final Looper`	`applicationLooper`

Protected fields
`@MonotonicNonNull SimpleBasePlayer.State`	`@MonotonicNonNull state`

Protected constructors
`SimpleBasePlayer(Looper applicationLooper)` Creates the base class.
`SimpleBasePlayer(Looper applicationLooper, Clock clock)` Creates the base class.

Public methods
`final void`	`addListener(Player.Listener listener)` Registers a listener to receive all events from the player.
`final void`	`addMediaItems(int index, List<MediaItem> mediaItems)` Adds a list of media items at the given index of the playlist.
`final void`	`clearVideoSurface()` Clears any `Surface`, `SurfaceHolder`, `SurfaceView` or `TextureView` currently set on the player.
`final void`	`clearVideoSurface(@Nullable Surface surface)` Clears the `Surface` onto which video is being rendered if it matches the one passed.
`final void`	`clearVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)` Clears the `SurfaceHolder` that holds the `Surface` onto which video is being rendered if it matches the one passed.
`final void`	`clearVideoSurfaceView(@Nullable SurfaceView surfaceView)` Clears the `SurfaceView` onto which video is being rendered if it matches the one passed.
`final void`	`clearVideoTextureView(@Nullable TextureView textureView)` Clears the `TextureView` onto which video is being rendered if it matches the one passed.
`final void`	`decreaseDeviceVolume()` This method is deprecated. Use `decreaseDeviceVolume` instead.
`final void`	`decreaseDeviceVolume(@C.VolumeFlags int flags)` Decreases the volume of the device.
`final Looper`	`getApplicationLooper()` Returns the `Looper` associated with the application thread that's used to access the player and on which player events are received.
`final AudioAttributes`	`getAudioAttributes()` Returns the attributes for audio playback.
`final Player.Commands`	`getAvailableCommands()` Returns the player's currently available `Commands`.
`final long`	`getBufferedPosition()` Returns an estimate of the position in the current content or ad up to which data is buffered, in milliseconds.
`final 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.
`final 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.
`final int`	`getCurrentAdGroupIndex()` If `isPlayingAd` returns true, returns the index of the ad group in the period currently being played.
`final int`	`getCurrentAdIndexInAdGroup()` If `isPlayingAd` returns true, returns the index of the ad in its ad group.
`final CueGroup`	`getCurrentCues()` Returns the current `CueGroup`.
`final int`	`getCurrentMediaItemIndex()` Returns the index of the current `MediaItem` in the `timeline`, or the prospective index if the `current timeline` is empty.
`final int`	`getCurrentPeriodIndex()` Returns the index of the period currently being played.
`final 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.
`final Timeline`	`getCurrentTimeline()` Returns the current `Timeline`.
`final Tracks`	`getCurrentTracks()` Returns the current tracks.
`final DeviceInfo`	`getDeviceInfo()` Gets the device information.
`final int`	`getDeviceVolume()` Gets the current volume of the device.
`final long`	`getDuration()` Returns the duration of the current content or ad in milliseconds, or `TIME_UNSET` if the duration is not known.
`final long`	`getMaxSeekToPreviousPosition()` Returns the maximum position for which `seekToPrevious` seeks to the previous , in milliseconds.
`final MediaMetadata`	`getMediaMetadata()` Returns the current combined `MediaMetadata`, or `EMPTY` if not supported.
`final boolean`	`getPlayWhenReady()` Whether playback will proceed when `getPlaybackState` == `STATE_READY`.
`final PlaybackParameters`	`getPlaybackParameters()` Returns the currently active playback parameters.
`final int`	`@Player.State getPlaybackState()` Returns the current `playback state` of the player.
`final int`	`getPlaybackSuppressionReason()` Returns the reason why playback is suppressed even though `getPlayWhenReady` is `true`, or `PLAYBACK_SUPPRESSION_REASON_NONE` if playback is not suppressed.
`final @Nullable PlaybackException`	`getPlayerError()` Returns the error that caused playback to fail.
`final MediaMetadata`	`getPlaylistMetadata()` Returns the playlist `MediaMetadata`, as set by `setPlaylistMetadata`, or `EMPTY` if not supported.
`final int`	`@Player.RepeatMode getRepeatMode()` Returns the current `RepeatMode` used for playback.
`final long`	`getSeekBackIncrement()` Returns the `seekBack` increment.
`final long`	`getSeekForwardIncrement()` Returns the `seekForward` increment.
`final boolean`	`getShuffleModeEnabled()` Returns whether shuffling of media items is enabled.
`final Size`	`getSurfaceSize()` Gets the size of the surface on which the video is rendered.
`final long`	`getTotalBufferedDuration()` Returns an estimate of the total buffered duration from the current position, in milliseconds.
`final TrackSelectionParameters`	`getTrackSelectionParameters()` Returns the parameters constraining the track selection.
`final VideoSize`	`getVideoSize()` Gets the size of the video.
`final float`	`getVolume()` Returns the audio volume, with 0 being silence and 1 being unity gain (signal unchanged).
`final void`	`increaseDeviceVolume()` This method is deprecated. Use `increaseDeviceVolume` instead.
`final void`	`increaseDeviceVolume(@C.VolumeFlags int flags)` Increases the volume of the device.
`final boolean`	`isDeviceMuted()` Gets whether the device is muted or not.
`final boolean`	`isLoading()` Whether the player is currently loading the source.
`final boolean`	`isPlayingAd()` Returns whether the player is currently playing an ad.
`final void`	`moveMediaItems(int fromIndex, int toIndex, int newIndex)` Moves the media item range to the new index.
`final void`	`prepare()` Prepares the player.
`final void`	`release()` Releases the player.
`final void`	`removeListener(Player.Listener listener)` Unregister a listener registered through `addListener`.
`final void`	`removeMediaItems(int fromIndex, int toIndex)` Removes a range of media items from the playlist.
`final void`	`replaceMediaItems( int fromIndex, int toIndex, List<MediaItem> mediaItems )` Replaces the media items at the given range of the playlist.
`final void`	`@VisibleForTesting(otherwise = 4) seekTo( int mediaItemIndex, long positionMs, @Player.Command int seekCommand, boolean isRepeatingCurrentItem )` Seeks to a position in the specified `MediaItem`.
`final void`	`setAudioAttributes( AudioAttributes audioAttributes, boolean handleAudioFocus )` Sets the attributes for audio playback, used by the underlying audio track.
`final void`	`setDeviceMuted(boolean muted)` This method is deprecated. Use `setDeviceMuted` instead.
`final void`	`setDeviceMuted(boolean muted, @C.VolumeFlags int flags)` Sets the mute state of the device.
`final void`	`setDeviceVolume(int volume)` This method is deprecated. Use `setDeviceVolume` instead.
`final void`	`setDeviceVolume(int volume, @C.VolumeFlags int flags)` Sets the volume of the device with volume flags.
`final void`	`setMediaItems(List<MediaItem> mediaItems, boolean resetPosition)` Clears the playlist and adds the specified `media items`.
`final void`	`setMediaItems( List<MediaItem> mediaItems, int startIndex, long startPositionMs )` Clears the playlist and adds the specified `media items`.
`final void`	`setPlayWhenReady(boolean playWhenReady)` Sets whether playback should proceed when `getPlaybackState` == `STATE_READY`.
`final void`	`setPlaybackParameters(PlaybackParameters playbackParameters)` Attempts to set the playback parameters.
`final void`	`setPlaylistMetadata(MediaMetadata mediaMetadata)` Sets the playlist `MediaMetadata`.
`final void`	`setRepeatMode(@Player.RepeatMode int repeatMode)` Sets the `RepeatMode` to be used for playback.
`final void`	`setShuffleModeEnabled(boolean shuffleModeEnabled)` Sets whether shuffling of media items is enabled.
`final void`	`setTrackSelectionParameters(TrackSelectionParameters parameters)` Sets the parameters constraining the track selection.
`final void`	`setVideoSurface(@Nullable Surface surface)` Sets the `Surface` onto which video will be rendered.
`final void`	`setVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)` Sets the `SurfaceHolder` that holds the `Surface` onto which video will be rendered.
`final void`	`setVideoSurfaceView(@Nullable SurfaceView surfaceView)` Sets the `SurfaceView` onto which video will be rendered.
`final void`	`setVideoTextureView(@Nullable TextureView textureView)` Sets the `TextureView` onto which video will be rendered.
`final void`	`setVolume(float volume)` Sets the audio volume, valid values are between 0 (silence) and 1 (unity gain, signal unchanged), inclusive.
`final void`	`stop()` Stops playback without resetting the playlist.

Protected methods
`SimpleBasePlayer.MediaItemData`	`@ForOverride getPlaceholderMediaItemData(MediaItem mediaItem)` Returns the placeholder `MediaItemData` used for a new `MediaItem` added to the playlist.
`SimpleBasePlayer.State`	`@ForOverride getPlaceholderState(SimpleBasePlayer.State suggestedPlaceholderState)` Returns the placeholder state used while a player method is handled asynchronously.
`abstract SimpleBasePlayer.State`	`@ForOverride getState()` Returns the current `State` of the player.
`ListenableFuture<Object>`	`@ForOverride handleAddMediaItems(int index, List<MediaItem> mediaItems)` Handles calls to addMediaItem and addMediaItems.
`ListenableFuture<Object>`	`@ForOverride handleClearVideoOutput(@Nullable Object videoOutput)` Handles calls to clear the video output.
`ListenableFuture<Object>`	`@ForOverride handleDecreaseDeviceVolume(@C.VolumeFlags int flags)` Handles calls to `decreaseDeviceVolume` and `decreaseDeviceVolume`.
`ListenableFuture<Object>`	`@ForOverride handleIncreaseDeviceVolume(@C.VolumeFlags int flags)` Handles calls to `increaseDeviceVolume` and `increaseDeviceVolume`.
`ListenableFuture<Object>`	`@ForOverride handleMoveMediaItems(int fromIndex, int toIndex, int newIndex)` Handles calls to `moveMediaItem` and `moveMediaItems`.
`ListenableFuture<Object>`	`@ForOverride handlePrepare()` Handles calls to `prepare`.
`ListenableFuture<Object>`	`@ForOverride handleRelease()` Handles calls to `release`.
`ListenableFuture<Object>`	`@ForOverride handleRemoveMediaItems(int fromIndex, int toIndex)` Handles calls to `removeMediaItem` and `removeMediaItems`.
`ListenableFuture<Object>`	`@ForOverride handleReplaceMediaItems( int fromIndex, int toIndex, List<MediaItem> mediaItems )` Handles calls to `replaceMediaItem` and `replaceMediaItems`.
`ListenableFuture<Object>`	`@ForOverride handleSeek( int mediaItemIndex, long positionMs, @Player.Command int seekCommand )` Handles calls to seekTo and other seek operations (for example, `seekToNext`).
`ListenableFuture<Object>`	`@ForOverride handleSetAudioAttributes( AudioAttributes audioAttributes, boolean handleAudioFocus )` Handles calls to set the audio attributes.
`ListenableFuture<Object>`	`@ForOverride handleSetDeviceMuted(boolean muted, @C.VolumeFlags int flags)` Handles calls to `setDeviceMuted` and `setDeviceMuted`.
`ListenableFuture<Object>`	`@ForOverride handleSetDeviceVolume(@IntRange(from = 0) int deviceVolume, int flags)` Handles calls to `setDeviceVolume` and `setDeviceVolume`.
`ListenableFuture<Object>`	`@ForOverride handleSetMediaItems( List<MediaItem> mediaItems, int startIndex, long startPositionMs )` Handles calls to setMediaItem and setMediaItems.
`ListenableFuture<Object>`	`@ForOverride handleSetPlayWhenReady(boolean playWhenReady)` Handles calls to `setPlayWhenReady`, `play` and `pause`.
`ListenableFuture<Object>`	`@ForOverride handleSetPlaybackParameters(PlaybackParameters playbackParameters)` Handles calls to `setPlaybackParameters` or `setPlaybackSpeed`.
`ListenableFuture<Object>`	`@ForOverride handleSetPlaylistMetadata(MediaMetadata playlistMetadata)` Handles calls to `setPlaylistMetadata`.
`ListenableFuture<Object>`	`@ForOverride handleSetRepeatMode(@Player.RepeatMode int repeatMode)` Handles calls to `setRepeatMode`.
`ListenableFuture<Object>`	`@ForOverride handleSetShuffleModeEnabled(boolean shuffleModeEnabled)` Handles calls to `setShuffleModeEnabled`.
`ListenableFuture<Object>`	`@ForOverride handleSetTrackSelectionParameters( TrackSelectionParameters trackSelectionParameters )` Handles calls to `setTrackSelectionParameters`.
`ListenableFuture<Object>`	`@ForOverride handleSetVideoOutput(Object videoOutput)` Handles calls to set the video output.
`ListenableFuture<Object>`	`@ForOverride handleSetVolume(@FloatRange(from = 0, to = 1.0) float volume)` Handles calls to `setVolume`.
`ListenableFuture<Object>`	`@ForOverride handleStop()` Handles calls to `stop`.
`final void`	`invalidateState()` Invalidates the current state.
`final void`	`verifyApplicationThread()` Throws an `IllegalStateException` if the the thread calling this method does not match the `Looper` thread that was specified upon construction of this instance.

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` 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_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`	`hasNext()` This method is deprecated. Use `hasNextMediaItem` 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`	`hasNextWindow()` This method is deprecated. Use `hasNextMediaItem` instead.
`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`	`next()` This method is deprecated. Use `seekToNextMediaItem` instead.
`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`	`seekToNextWindow()` This method is deprecated. Use `seekToNextMediaItem` instead.
`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`	`seekToPreviousWindow()` This method is deprecated. Use `seekToPreviousMediaItem` instead.
`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.

Public fields

applicationLooper

public final Looper applicationLooper

Protected fields

state

@MonotonicNonNull
protected @MonotonicNonNull SimpleBasePlayer.State state

Protected constructors

SimpleBasePlayer

protected SimpleBasePlayer(Looper applicationLooper)

Creates the base class.

Parameters
`Looper applicationLooper`	The `Looper` that must be used for all calls to the player and that is used to call listeners on.

SimpleBasePlayer

protected SimpleBasePlayer(Looper applicationLooper, Clock clock)

Creates the base class.

Parameters
`Looper applicationLooper`	The `Looper` that must be used for all calls to the player and that is used to call listeners on.
`Clock clock`	The `Clock` that will be used by the player.

Public methods

addListener

public final 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 final 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 final void clearVideoSurface()

Clears any Surface, SurfaceHolder, SurfaceView or TextureView currently set on the player.

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

clearVideoSurface

public final void clearVideoSurface(@Nullable Surface surface)

Clears the Surface onto which video is being rendered if it matches the one passed. Else does nothing.

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`@Nullable Surface surface`	The surface to clear.

clearVideoSurfaceHolder

public final void clearVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)

Clears the SurfaceHolder that holds the Surface onto which video is being rendered if it matches the one passed. Else does nothing.

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`@Nullable SurfaceHolder surfaceHolder`	The surface holder to clear.

clearVideoSurfaceView

public final void clearVideoSurfaceView(@Nullable SurfaceView surfaceView)

Clears the SurfaceView onto which video is being rendered if it matches the one passed. Else does nothing.

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`@Nullable SurfaceView surfaceView`	The texture view to clear.

clearVideoTextureView

public final void clearVideoTextureView(@Nullable TextureView textureView)

Clears the TextureView onto which video is being rendered if it matches the one passed. Else does nothing.

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`@Nullable TextureView textureView`	The texture view to clear.

decreaseDeviceVolume

public final void decreaseDeviceVolume()

decreaseDeviceVolume

public final 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 final 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 final AudioAttributes getAudioAttributes()

Returns the attributes for audio playback.

This method must only be called if COMMAND_GET_AUDIO_ATTRIBUTES is available.

See also
`onAudioAttributesChanged`

getAvailableCommands

public final 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 final 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 final 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 final 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 final 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 final 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 final CueGroup getCurrentCues()

Returns the current CueGroup.

This method must only be called if COMMAND_GET_TEXT is available.

See also
`onCues`

getCurrentMediaItemIndex

public final 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 final 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 final 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 final 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 final Tracks getCurrentTracks()

Returns the current tracks.

This method must only be called if COMMAND_GET_TRACKS is available.

See also
`onTracksChanged`

getDeviceInfo

public final DeviceInfo getDeviceInfo()

Gets the device information.

getDeviceVolume

public final 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 usage which can be converted to stream type with getStreamTypeForAudioUsage.

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 final 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.

getMaxSeekToPreviousPosition

public final 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 final 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`

getPlayWhenReady

public final boolean getPlayWhenReady()

Whether playback will proceed when getPlaybackState == STATE_READY.

Returns
`boolean`	Whether playback will proceed when ready.

See also
`onPlayWhenReadyChanged`

getPlaybackParameters

public final PlaybackParameters getPlaybackParameters()

Returns the currently active playback parameters.

See also
`onPlaybackParametersChanged`

getPlaybackState

@Player.State
public final int getPlaybackState()

Returns the current playback state of the player.

Returns
`int`	The current `playback state`.

See also
`onPlaybackStateChanged`

getPlaybackSuppressionReason

public final 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 final @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 final 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 final int getRepeatMode()

Returns the current RepeatMode used for playback.

Returns
`int`	The current repeat mode.

See also
`onRepeatModeChanged`

getSeekBackIncrement

public final long getSeekBackIncrement()

Returns the seekBack increment.

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

See also
`onSeekBackIncrementChanged`

getSeekForwardIncrement

public final long getSeekForwardIncrement()

Returns the seekForward increment.

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

See also
`onSeekForwardIncrementChanged`

getShuffleModeEnabled

public final boolean getShuffleModeEnabled()

Returns whether shuffling of media items is enabled.

See also
`onShuffleModeEnabledChanged`

getSurfaceSize

public final Size getSurfaceSize()

Gets the size of the surface on which the video is rendered.

See also
`onSurfaceSizeChanged`

getTotalBufferedDuration

public final 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 final TrackSelectionParameters getTrackSelectionParameters()

Returns the parameters constraining the track selection.

See also
`onTrackSelectionParametersChanged`	}

getVideoSize

public final VideoSize getVideoSize()

Gets the size of the video.

The video's width and height are 0 if there is no supported video track or its size has not been determined yet.

See also
`onVideoSizeChanged`

getVolume

public final float getVolume()

Returns the audio volume, with 0 being silence and 1 being unity gain (signal unchanged).

This method must only be called if COMMAND_GET_VOLUME is available.

Returns
`float`	The linear gain applied to all audio channels.

See also
`onVolumeChanged`

increaseDeviceVolume

public final void increaseDeviceVolume()

increaseDeviceVolume

public final 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`.

isDeviceMuted

public final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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 final 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.

seekTo

@VisibleForTesting(otherwise = 4)
public final 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.

setAudioAttributes

public final void setAudioAttributes(
    AudioAttributes audioAttributes,
    boolean handleAudioFocus
)

Sets the attributes for audio playback, used by the underlying audio track. If not set, the default audio attributes will be used. They are suitable for general media playback.

Setting the audio attributes during playback may introduce a short gap in audio output as the audio track is recreated. A new audio session id will also be generated.

If tunneling is enabled by the track selector, the specified audio attributes will be ignored, but they will take effect if audio is later played without tunneling.

If the device is running a build before platform API version 21, audio attributes cannot be set directly on the underlying audio track. In this case, the usage will be mapped onto an equivalent stream type using getStreamTypeForAudioUsage.

If audio focus should be handled, the usage must be USAGE_MEDIA or USAGE_GAME. Other usages will throw an .

This method must only be called if COMMAND_SET_AUDIO_ATTRIBUTES is available.

Parameters
`AudioAttributes audioAttributes`	The attributes to use for audio playback.
`boolean handleAudioFocus`	True if the player should handle audio focus, false otherwise.

setDeviceMuted

public final void setDeviceMuted(boolean muted)

setDeviceMuted

public final 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

public final void setDeviceVolume(int volume)

setDeviceVolume

public final void setDeviceVolume(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
`int volume`	The volume to set.
`@C.VolumeFlags int flags`	Either 0 or a bitwise combination of one or more `C.VolumeFlags`.

setMediaItems

public final 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 final 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 final 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 final 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 final void setPlaylistMetadata(MediaMetadata mediaMetadata)

Sets the playlist MediaMetadata.

This method must only be called if COMMAND_SET_PLAYLIST_METADATA is available.

setRepeatMode

public final 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.

setShuffleModeEnabled

public final 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 final 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 final void setVideoSurface(@Nullable Surface surface)

Sets the Surface onto which video will be rendered. The caller is responsible for tracking the lifecycle of the surface, and must clear the surface by calling setVideoSurface(null) if the surface is destroyed.

If the surface is held by a SurfaceView, TextureView or then it's recommended to use setVideoSurfaceView, setVideoTextureView or setVideoSurfaceHolder rather than this method, since passing the holder allows the player to track the lifecycle of the surface automatically.

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`@Nullable Surface surface`	The `Surface`.

setVideoSurfaceHolder

public final void setVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)

Sets the SurfaceHolder that holds the Surface onto which video will be rendered. The player will track the lifecycle of the surface automatically.

The thread that calls the SurfaceHolder.Callback methods must be the thread associated with getApplicationLooper.

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`@Nullable SurfaceHolder surfaceHolder`	The surface holder.

setVideoSurfaceView

public final void setVideoSurfaceView(@Nullable SurfaceView surfaceView)

Sets the SurfaceView onto which video will be rendered. The player will track the lifecycle of the surface automatically.

The thread that calls the SurfaceHolder.Callback methods must be the thread associated with getApplicationLooper.

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`@Nullable SurfaceView surfaceView`	The surface view.

setVideoTextureView

public final void setVideoTextureView(@Nullable TextureView textureView)

Sets the TextureView onto which video will be rendered. The player will track the lifecycle of the surface automatically.

Consider using SurfaceView via setVideoSurfaceView instead of . SurfaceView generally causes lower battery consumption, and has better handling for HDR and secure content. See Choosing a surface type for more information.

The thread that calls the TextureView.SurfaceTextureListener methods must be the thread associated with getApplicationLooper.

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`@Nullable TextureView textureView`	The texture view.

setVolume

public final void setVolume(float volume)

Sets the audio volume, valid values are between 0 (silence) and 1 (unity gain, signal unchanged), inclusive.

This method must only be called if COMMAND_SET_VOLUME is available.

Parameters
`float volume`	Linear output gain to apply to all audio channels.

stop

public final 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

getPlaceholderMediaItemData

@ForOverride
protected SimpleBasePlayer.MediaItemData getPlaceholderMediaItemData(MediaItem mediaItem)

Returns the placeholder MediaItemData used for a new MediaItem added to the playlist.

An implementation only needs to override this method if it can determine a more accurate placeholder state than the default.

Parameters
`MediaItem mediaItem`	The `MediaItem` added to the playlist.

Returns
`SimpleBasePlayer.MediaItemData`	The `MediaItemData` used as placeholder while adding the item to the playlist is in progress.

getPlaceholderState

@ForOverride
protected SimpleBasePlayer.State getPlaceholderState(SimpleBasePlayer.State suggestedPlaceholderState)

Returns the placeholder state used while a player method is handled asynchronously.

The suggestedPlaceholderState already contains the most likely state update, for example setting playWhenReady to true if player.setPlayWhenReady(true) is called, and an implementations only needs to override this method if it can determine a more accurate placeholder state.

Parameters
`SimpleBasePlayer.State suggestedPlaceholderState`	The suggested placeholder `State`, including the most likely outcome of handling all pending asynchronous operations.

Returns
`SimpleBasePlayer.State`	The placeholder `State` to use while asynchronous operations are pending.

getState

@ForOverride
protected abstract SimpleBasePlayer.State getState()

Returns the current State of the player.

The State should include all available commands indicating which player methods are allowed to be called.

Note that this method won't be called while asynchronous handling of player methods is in progress. This means that the implementation doesn't need to handle state changes caused by these asynchronous operations until they are done and can return the currently known state directly. The placeholder state used while these asynchronous operations are in progress can be customized by overriding getPlaceholderState if required.

handleAddMediaItems

@ForOverride
protected ListenableFuture<Object> handleAddMediaItems(int index, List<MediaItem> mediaItems)

Handles calls to addMediaItem and addMediaItems.

Will only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`int index`	The index at which to add the items. The index is in the range 0 <= `index`<= `getMediaItemCount`.
`List<MediaItem> mediaItems`	The media items to add.

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleClearVideoOutput

@ForOverride
protected ListenableFuture<Object> handleClearVideoOutput(@Nullable Object videoOutput)

Handles calls to clear the video output.

Will only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`@Nullable Object videoOutput`	The video output to clear. If null any current output should be cleared. If non-null, the output should only be cleared if it matches the provided argument. This is either a `Surface`, `SurfaceHolder`, `TextureView` or .

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleDecreaseDeviceVolume

@ForOverride
protected ListenableFuture<Object> handleDecreaseDeviceVolume(@C.VolumeFlags int flags)

Handles calls to decreaseDeviceVolume and decreaseDeviceVolume.

Will only be called if COMMAND_ADJUST_DEVICE_VOLUME or 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`.

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleIncreaseDeviceVolume

@ForOverride
protected ListenableFuture<Object> handleIncreaseDeviceVolume(@C.VolumeFlags int flags)

Handles calls to increaseDeviceVolume and increaseDeviceVolume.

Will only be called if COMMAND_ADJUST_DEVICE_VOLUME or 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`.

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleMoveMediaItems

@ForOverride
protected ListenableFuture<Object> handleMoveMediaItems(int fromIndex, int toIndex, int newIndex)

Handles calls to moveMediaItem and moveMediaItems.

Will only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`int fromIndex`	The start index of the items to move. The index is in the range 0 <= `fromIndex`<`getMediaItemCount`.
`int toIndex`	The index of the first item not to be included in the move (exclusive). The index is in the range `fromIndex`<`toIndex`<= `getMediaItemCount`.
`int newIndex`	The new index of the first moved item. The index is in the range `0`<= `newIndex`<`- (toIndex - fromIndex)`.

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handlePrepare

@ForOverride
protected ListenableFuture<Object> handlePrepare()

Handles calls to prepare.

Will only be called if COMMAND_PREPARE is available.

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleRelease

@ForOverride
protected ListenableFuture<Object> handleRelease()

Handles calls to release.

Will only be called if COMMAND_RELEASE is available.

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleRemoveMediaItems

@ForOverride
protected ListenableFuture<Object> handleRemoveMediaItems(int fromIndex, int toIndex)

Handles calls to removeMediaItem and removeMediaItems.

Will only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`int fromIndex`	The index at which to start removing media items. The index is in the range 0 <= `fromIndex`<`getMediaItemCount`.
`int toIndex`	The index of the first item to be kept (exclusive). The index is in the range `fromIndex`<`toIndex`<= `getMediaItemCount`.

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleReplaceMediaItems

@ForOverride
protected ListenableFuture<Object> handleReplaceMediaItems(
    int fromIndex,
    int toIndex,
    List<MediaItem> mediaItems
)

Handles calls to replaceMediaItem and replaceMediaItems.

Will only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`int fromIndex`	The start index of the items to replace. The index is in the range 0 <= `fromIndex`<`getMediaItemCount`.
`int toIndex`	The index of the first item not to be replaced (exclusive). The index is in the range `fromIndex`<`toIndex`<= `getMediaItemCount`.
`List<MediaItem> mediaItems`	The media items to replace the specified range with.

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSeek

@ForOverride
protected ListenableFuture<Object> handleSeek(
    int mediaItemIndex,
    long positionMs,
    @Player.Command int seekCommand
)

Handles calls to seekTo and other seek operations (for example, seekToNext).

Will only be called if the appropriate Player.Command, for example COMMAND_SEEK_TO_MEDIA_ITEM or COMMAND_SEEK_TO_NEXT, is available.

Parameters
`int mediaItemIndex`	The media item index to seek to. 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 position in milliseconds to start playback from, or `TIME_UNSET` to start at the default position in the media item. 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.

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetAudioAttributes

@ForOverride
protected ListenableFuture<Object> handleSetAudioAttributes(
    AudioAttributes audioAttributes,
    boolean handleAudioFocus
)

Handles calls to set the audio attributes.

Will only be called if COMMAND_SET_AUDIO_ATTRIBUTES is available.

Parameters
`AudioAttributes audioAttributes`	The attributes to use for audio playback.
`boolean handleAudioFocus`	True if the player should handle audio focus, false otherwise.

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetDeviceMuted

@ForOverride
protected ListenableFuture<Object> handleSetDeviceMuted(boolean muted, @C.VolumeFlags int flags)

Handles calls to setDeviceMuted and setDeviceMuted.

Will only be called if COMMAND_ADJUST_DEVICE_VOLUME or COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS is available.

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

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetDeviceVolume

@ForOverride
protected ListenableFuture<Object> handleSetDeviceVolume(@IntRange(from = 0) int deviceVolume, int flags)

Handles calls to setDeviceVolume and setDeviceVolume.

Will only be called if COMMAND_SET_DEVICE_VOLUME or COMMAND_SET_DEVICE_VOLUME_WITH_FLAGS is available.

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

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetMediaItems

@ForOverride
protected ListenableFuture<Object> handleSetMediaItems(
    List<MediaItem> mediaItems,
    int startIndex,
    long startPositionMs
)

Handles calls to setMediaItem and setMediaItems.

Will only be called if COMMAND_SET_MEDIA_ITEM or COMMAND_CHANGE_MEDIA_ITEMS is available. If only COMMAND_SET_MEDIA_ITEM is available, the list of media items will always contain exactly one item.

Parameters
`List<MediaItem> mediaItems`	The media items to add.
`int startIndex`	The index at which to start playback from, or `INDEX_UNSET` to start at the default item.
`long startPositionMs`	The position in milliseconds to start playback from, or `TIME_UNSET` to start at the default position in the media item.

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetPlayWhenReady

@ForOverride
protected ListenableFuture<Object> handleSetPlayWhenReady(boolean playWhenReady)

Handles calls to setPlayWhenReady, play and pause.

Will only be called if COMMAND_PLAY_PAUSE is available.

Parameters
`boolean playWhenReady`	The requested `playWhenReady`

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetPlaybackParameters

@ForOverride
protected ListenableFuture<Object> handleSetPlaybackParameters(PlaybackParameters playbackParameters)

Handles calls to setPlaybackParameters or setPlaybackSpeed.

Will only be called if COMMAND_SET_SPEED_AND_PITCH is available.

Parameters
`PlaybackParameters playbackParameters`	The requested `PlaybackParameters`.

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetPlaylistMetadata

@ForOverride
protected ListenableFuture<Object> handleSetPlaylistMetadata(MediaMetadata playlistMetadata)

Handles calls to setPlaylistMetadata.

Will only be called if COMMAND_SET_PLAYLIST_METADATA is available.

Parameters
`MediaMetadata playlistMetadata`	The requested `playlist metadata`.

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetRepeatMode

@ForOverride
protected ListenableFuture<Object> handleSetRepeatMode(@Player.RepeatMode int repeatMode)

Handles calls to setRepeatMode.

Will only be called if COMMAND_SET_REPEAT_MODE is available.

Parameters
`@Player.RepeatMode int repeatMode`	The requested `RepeatMode`.

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetShuffleModeEnabled

@ForOverride
protected ListenableFuture<Object> handleSetShuffleModeEnabled(boolean shuffleModeEnabled)

Handles calls to setShuffleModeEnabled.

Will only be called if COMMAND_SET_SHUFFLE_MODE is available.

Parameters
`boolean shuffleModeEnabled`	Whether shuffle mode was requested to be enabled.

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetTrackSelectionParameters

@ForOverride
protected ListenableFuture<Object> handleSetTrackSelectionParameters(
    TrackSelectionParameters trackSelectionParameters
)

Handles calls to setTrackSelectionParameters.

Will only be called if COMMAND_SET_TRACK_SELECTION_PARAMETERS is available.

Parameters
`TrackSelectionParameters trackSelectionParameters`	The requested `TrackSelectionParameters`.

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetVideoOutput

@ForOverride
protected ListenableFuture<Object> handleSetVideoOutput(Object videoOutput)

Handles calls to set the video output.

Will only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`Object videoOutput`	The requested video output. This is either a `Surface`, , `TextureView` or `SurfaceView`.

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleSetVolume

@ForOverride
protected ListenableFuture<Object> handleSetVolume(@FloatRange(from = 0, to = 1.0) float volume)

Handles calls to setVolume.

Will only be called if COMMAND_SET_VOLUME is available.

Parameters
`@FloatRange(from = 0, to = 1.0) float volume`	The requested audio volume, with 0 being silence and 1 being unity gain (signal unchanged).

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

handleStop

@ForOverride
protected ListenableFuture<Object> handleStop()

Handles calls to stop.

Will only be called if COMMAND_STOP is available.

Returns
`ListenableFuture<Object>`	A `ListenableFuture` indicating the completion of all immediate `State` changes caused by this call.

invalidateState

protected final void invalidateState()

Invalidates the current state.

Triggers a call to getState and informs listeners if the state changed.

Note that this may not have an immediate effect while there are still player methods being handled asynchronously. The state will be invalidated automatically once these pending synchronous operations are finished and there is no need to call this method again.

verifyApplicationThread

protected final void verifyApplicationThread()

Throws an IllegalStateException if the the thread calling this method does not match the Looper thread that was specified upon construction of this instance.

Subclasses can use this method to verify that their own defined methods are also accessed by the correct thread.

SimpleBasePlayer

Summary

Nested types

Public fields

Protected fields

Protected constructors

Public methods

Protected methods

Inherited Constants

Inherited fields

Inherited methods

Public fields

applicationLooper

Protected fields

state

Protected constructors

SimpleBasePlayer

SimpleBasePlayer

Public methods

addListener

addMediaItems

clearVideoSurface

clearVideoSurface

clearVideoSurfaceHolder

clearVideoSurfaceView

clearVideoTextureView

decreaseDeviceVolume

decreaseDeviceVolume

getApplicationLooper

getAudioAttributes

getAvailableCommands

getBufferedPosition

getContentBufferedPosition

getContentPosition

getCurrentAdGroupIndex

getCurrentAdIndexInAdGroup

getCurrentCues

getCurrentMediaItemIndex

getCurrentPeriodIndex

getCurrentPosition

getCurrentTimeline

getCurrentTracks

getDeviceInfo

getDeviceVolume

getDuration

getMaxSeekToPreviousPosition

getMediaMetadata

getPlayWhenReady

getPlaybackParameters

getPlaybackState

getPlaybackSuppressionReason

getPlayerError

getPlaylistMetadata

getRepeatMode

getSeekBackIncrement

getSeekForwardIncrement

getShuffleModeEnabled

getSurfaceSize

getTotalBufferedDuration

getTrackSelectionParameters

getVideoSize

getVolume

increaseDeviceVolume

increaseDeviceVolume

isDeviceMuted

isLoading

isPlayingAd

moveMediaItems

prepare

release

removeListener

removeMediaItems

replaceMediaItems

seekTo

setAudioAttributes

setDeviceMuted

setDeviceMuted

setDeviceVolume

setDeviceVolume

setMediaItems