SimpleExoPlayer

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
public class SimpleExoPlayer extends BasePlayer implements ExoPlayer

java.lang.Object
↳	androidx.media3.common.BasePlayer
	↳	androidx.media3.exoplayer.SimpleExoPlayer

Summary

Nested types
`public final class SimpleExoPlayer.Builder` This class is deprecated. Use `ExoPlayer.Builder` instead.

Nested types

public final class SimpleExoPlayer.Builder

This class is deprecated.

Use ExoPlayer.Builder instead.

Protected constructors
`SimpleExoPlayer(SimpleExoPlayer.Builder builder)`
`SimpleExoPlayer( Context context, RenderersFactory renderersFactory, TrackSelector trackSelector, MediaSource.Factory mediaSourceFactory, LoadControl loadControl, BandwidthMeter bandwidthMeter, AnalyticsCollector analyticsCollector, boolean useLazyPreparation, Clock clock, Looper applicationLooper )` This method is deprecated. Use the `ExoPlayer.Builder`.

Protected constructors

SimpleExoPlayer(SimpleExoPlayer.Builder builder)

SimpleExoPlayer(
    Context context,
    RenderersFactory renderersFactory,
    TrackSelector trackSelector,
    MediaSource.Factory mediaSourceFactory,
    LoadControl loadControl,
    BandwidthMeter bandwidthMeter,
    AnalyticsCollector analyticsCollector,
    boolean useLazyPreparation,
    Clock clock,
    Looper applicationLooper
)

This method is deprecated.

Use the ExoPlayer.Builder.

Public methods
`void`	`addAnalyticsListener(AnalyticsListener listener)` Adds an `AnalyticsListener` to receive analytics events.
`void`	`addAudioCodecParametersChangeListener( CodecParametersChangeListener listener, List<String> keys )` Adds a listener for audio codec parameter changes.
`void`	`addAudioOffloadListener(ExoPlayer.AudioOffloadListener listener)` Adds a listener to receive audio offload events.
`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`	`addMediaSource(MediaSource mediaSource)` Adds a media source to the end of the playlist.
`void`	`addMediaSource(int index, MediaSource mediaSource)` Adds a media source at the given index of the playlist.
`void`	`addMediaSources(List<MediaSource> mediaSources)` Adds a list of media sources to the end of the playlist.
`void`	`addMediaSources(int index, List<MediaSource> mediaSources)` Adds a list of media sources at the given index of the playlist.
`void`	`addVideoCodecParametersChangeListener( CodecParametersChangeListener listener, List<String> keys )` Adds a listener for video codec parameter changes.
`void`	`clearAuxEffectInfo()` Detaches any previously attached auxiliary audio effect from the underlying audio track.
`void`	`clearCameraMotionListener(CameraMotionListener listener)` Clears the listener which receives camera motion events if it matches the one passed.
`void`	`clearVideoFrameMetadataListener(VideoFrameMetadataListener listener)` Clears the listener which receives video frame metadata events if it matches the one passed.
`void`	`clearVideoSurface()` Clears any `Surface`, `SurfaceHolder`, `SurfaceView` or `TextureView` currently set on the player.
`void`	`clearVideoSurface(@Nullable Surface surface)` Clears the `Surface` onto which video is being rendered if it matches the one passed.
`void`	`clearVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)` Clears the `SurfaceHolder` that holds the `Surface` onto which video is being rendered if it matches the one passed.
`void`	`clearVideoSurfaceView(@Nullable SurfaceView surfaceView)` Clears the `SurfaceView` onto which video is being rendered if it matches the one passed.
`void`	`clearVideoTextureView(@Nullable TextureView textureView)` Clears the `TextureView` onto which video is being rendered if it matches the one passed.
`PlayerMessage`	`createMessage(PlayerMessage.Target target)` Creates a message that can be sent to a `PlayerMessage.Target`.
`void`	`decreaseDeviceVolume()` This method is deprecated. Use `decreaseDeviceVolume` instead.
`void`	`decreaseDeviceVolume(@C.VolumeFlags int flags)` Decreases the volume of the device.
`AnalyticsCollector`	`getAnalyticsCollector()` Returns the `AnalyticsCollector` used for collecting analytics events.
`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()` Returns the attributes for audio playback.
`@Nullable DecoderCounters`	`getAudioDecoderCounters()` Returns `DecoderCounters` for audio, or null if no audio is being played.
`@Nullable Format`	`getAudioFormat()` Returns the audio format currently being played, or null if no audio is being played.
`int`	`getAudioSessionId()` Returns the audio session identifier, or `AUDIO_SESSION_ID_UNSET` if not set.
`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.
`Clock`	`getClock()` Returns the `Clock` used for playback.
`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()` Returns the current `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`.
`TrackGroupArray`	`getCurrentTrackGroups()` This method is deprecated. Use `getCurrentTracks`.
`TrackSelectionArray`	`getCurrentTrackSelections()` This method is deprecated. Use `getCurrentTracks`.
`Tracks`	`getCurrentTracks()` Returns the current tracks.
`DeviceInfo`	`getDeviceInfo()` Gets the device information.
`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.
`long`	`getMaxSeekToPreviousPosition()` Returns the maximum position for which `seekToPrevious` seeks to the previous `MediaItem`, in milliseconds.
`MediaMetadata`	`getMediaMetadata()` Returns the current combined `MediaMetadata`, or `EMPTY` if not supported.
`boolean`	`getPauseAtEndOfMediaItems()` Returns whether the player pauses playback at the end of each media item.
`boolean`	`getPlayWhenReady()` Whether playback will proceed when `getPlaybackState` == `STATE_READY`.
`Looper`	`getPlaybackLooper()` Returns the `Looper` associated with the playback thread.
`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 ExoPlaybackException`	`getPlayerError()` Returns the error that caused playback to fail.
`MediaMetadata`	`getPlaylistMetadata()` Returns the playlist `MediaMetadata`, as set by `setPlaylistMetadata`, or `EMPTY` if not supported.
`ExoPlayer.PreloadConfiguration`	`getPreloadConfiguration()` Returns the `preload configuration`.
`Renderer`	`getRenderer(int index)` Returns the renderer at the given index.
`int`	`getRendererCount()` Returns the number of renderers.
`int`	`@C.TrackType getRendererType(int index)` Returns the track type that the renderer at a given index handles.
`int`	`@Player.RepeatMode getRepeatMode()` Returns the current `RepeatMode` used for playback.
`ScrubbingModeParameters`	`getScrubbingModeParameters()` Gets the parameters that control behavior in `scrubbing mode`.
`Renderer`	`getSecondaryRenderer(int index)` Returns the secondary renderer at the given index.
`long`	`getSeekBackIncrement()` Returns the `seekBack` increment.
`long`	`getSeekForwardIncrement()` Returns the `seekForward` increment.
`SeekParameters`	`getSeekParameters()` Returns the currently active `SeekParameters` of the player.
`boolean`	`getShuffleModeEnabled()` Returns whether shuffling of media items is enabled.
`ShuffleOrder`	`getShuffleOrder()` Returns the shuffle order.
`boolean`	`getSkipSilenceEnabled()` Returns whether skipping silences in the audio stream is enabled.
`Size`	`getSurfaceSize()` Gets the size of the surface on which the video is rendered.
`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.
`TrackSelector`	`getTrackSelector()` Returns the track selector that this player uses, or null if track selection is not supported.
`int`	`@C.VideoChangeFrameRateStrategy getVideoChangeFrameRateStrategy()` Returns the `C.VideoChangeFrameRateStrategy`.
`@Nullable DecoderCounters`	`getVideoDecoderCounters()` Returns `DecoderCounters` for video, or null if no video is being played.
`@Nullable Format`	`getVideoFormat()` Returns the video format currently being played, or null if no video is being played.
`int`	`@C.VideoScalingMode getVideoScalingMode()` Returns the `C.VideoScalingMode`.
`VideoSize`	`getVideoSize()` Gets the size of the video.
`float`	`getVolume()` Returns the audio volume, with 0 being silence and 1 being unity gain (signal unchanged).
`void`	`increaseDeviceVolume()` This method is deprecated. Use `increaseDeviceVolume` instead.
`void`	`increaseDeviceVolume(@C.VolumeFlags int flags)` Increases the volume of the device.
`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.
`boolean`	`isReleased()` Returns whether `release` has been called on the player.
`boolean`	`isScrubbingModeEnabled()` Returns whether the player is optimized for scrubbing (many frequent seeks).
`boolean`	`isSleepingForOffload()` Returns whether the player has paused its main loop to save power in offload scheduling mode.
`boolean`	`isTunnelingEnabled()` Returns whether tunneling is enabled for the currently selected tracks.
`void`	`moveMediaItems(int fromIndex, int toIndex, int newIndex)` Moves the media item range to the new index.
`void`	`mute()` Sets the audio volume to 0.
`void`	`prepare()` Prepares the player.
`void`	`prepare(MediaSource mediaSource)` This method is deprecated. Use `setMediaSource` and `prepare` instead.
`void`	`prepare( MediaSource mediaSource, boolean resetPosition, boolean resetState )` This method is deprecated. Use `setMediaSource` and `prepare` instead.
`void`	`release()` Releases the player.
`void`	`removeAnalyticsListener(AnalyticsListener listener)` Removes an `AnalyticsListener`.
`void`	`removeAudioCodecParametersChangeListener( CodecParametersChangeListener listener )` Removes a listener for audio codec parameter changes.
`void`	`removeAudioOffloadListener(ExoPlayer.AudioOffloadListener listener)` Removes a listener of audio offload events.
`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`	`removeVideoCodecParametersChangeListener( CodecParametersChangeListener listener )` Removes a listener for video codec parameter changes.
`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 )` Sets the attributes for audio playback, used by the underlying audio track.
`void`	`setAudioCodecParameters(CodecParameters codecParameters)` Sets a collection of parameters on the underlying audio codecs.
`void`	`setAudioSessionId(int audioSessionId)` Sets the ID of the audio session to attach to the underlying `android.media.AudioTrack`.
`void`	`setAuxEffectInfo(AuxEffectInfo auxEffectInfo)` Sets information on an auxiliary audio effect to attach to the underlying audio track.
`void`	`setCameraMotionListener(CameraMotionListener listener)` Sets a listener of camera motion events.
`void`	`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`	`setDeviceVolume(int volume)` This method is deprecated. Use `setDeviceVolume` instead.
`void`	`setDeviceVolume(int volume, @C.VolumeFlags int flags)` Sets the volume of the device with volume flags.
`void`	`setForegroundMode(boolean foregroundMode)` Sets whether the player is allowed to keep holding limited resources such as video decoders, even when in the idle state.
`void`	`setHandleAudioBecomingNoisy(boolean handleAudioBecomingNoisy)` Sets whether the player should pause automatically when audio is rerouted from a headset to device speakers.
`void`	`setImageOutput(@Nullable ImageOutput imageOutput)` Sets the `ImageOutput` where rendered images will be forwarded.
`void`	`setMaxSeekToPreviousPositionMs(long maxSeekToPreviousPositionMs)` Sets the maximum position for which `seekToPrevious` seeks to the previous `MediaItem`.
`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`	`setMediaSource(MediaSource mediaSource)` Clears the playlist, adds the specified `MediaSource` and resets the position to the default position.
`void`	`setMediaSource(MediaSource mediaSource, boolean resetPosition)` Clears the playlist and adds the specified `MediaSource`.
`void`	`setMediaSource(MediaSource mediaSource, long startPositionMs)` Clears the playlist and adds the specified `MediaSource`.
`void`	`setMediaSources(List<MediaSource> mediaSources)` Clears the playlist, adds the specified `MediaSources` and resets the position to the default position.
`void`	`setMediaSources(List<MediaSource> mediaSources, boolean resetPosition)` Clears the playlist and adds the specified `MediaSources`.
`void`	`setMediaSources( List<MediaSource> mediaSources, int startMediaItemIndex, long startPositionMs )` Clears the playlist and adds the specified `MediaSources`.
`void`	`setPauseAtEndOfMediaItems(boolean pauseAtEndOfMediaItems)` Sets whether to pause playback at the end of each media item.
`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 mediaMetadata)` Sets the playlist `MediaMetadata`.
`void`	`setPreferredAudioDevice(@Nullable AudioDeviceInfo audioDeviceInfo)` Sets the preferred audio device.
`void`	`setPreloadConfiguration( ExoPlayer.PreloadConfiguration preloadConfiguration )` Sets the `preload configuration` to configure playlist preloading.
`void`	`setPriority(@C.Priority int priority)` Sets the `C.Priority` for this player.
`void`	`setPriorityTaskManager( @Nullable PriorityTaskManager priorityTaskManager )` Sets a `PriorityTaskManager`, or null to clear a previously set priority task manager.
`void`	`setRepeatMode(@Player.RepeatMode int repeatMode)` Sets the `RepeatMode` to be used for playback.
`void`	`setScrubbingModeEnabled(boolean scrubbingModeEnabled)` Sets whether to optimize the player for scrubbing (many frequent seeks).
`void`	`setScrubbingModeParameters( ScrubbingModeParameters scrubbingModeParameters )` Sets the parameters that control behavior in `scrubbing mode`.
`void`	`setSeekBackIncrementMs(long seekBackIncrementMs)` Sets the `seekBack` increment.
`void`	`setSeekForwardIncrementMs(long seekForwardIncrementMs)` Sets the `seekForward` increment.
`void`	`setSeekParameters(@Nullable SeekParameters seekParameters)` Sets the parameters that control how seek operations are performed.
`void`	`setShuffleModeEnabled(boolean shuffleModeEnabled)` Sets whether shuffling of media items is enabled.
`void`	`setShuffleOrder(ShuffleOrder shuffleOrder)` Sets the shuffle order.
`void`	`setSkipSilenceEnabled(boolean skipSilenceEnabled)` Sets whether skipping silences in the audio stream is enabled.
`void`	`setTrackSelectionParameters(TrackSelectionParameters parameters)` Sets the parameters constraining the track selection.
`void`	`setVideoChangeFrameRateStrategy( @C.VideoChangeFrameRateStrategy int videoChangeFrameRateStrategy )` Sets a `C.VideoChangeFrameRateStrategy` that will be used by the player when provided with a video output `Surface`.
`void`	`setVideoCodecParameters(CodecParameters codecParameters)` Sets a collection of parameters on the underlying video codecs.
`void`	`setVideoEffects(List<Effect> videoEffects)` Sets a `List` of `video effects` that will be applied to each video frame.
`void`	`setVideoFrameMetadataListener(VideoFrameMetadataListener listener)` Sets a listener to receive video frame metadata events.
`void`	`setVideoScalingMode(@C.VideoScalingMode int videoScalingMode)` Sets the `C.VideoScalingMode`.
`void`	`setVideoSurface(@Nullable Surface surface)` Sets the `Surface` onto which video will be rendered.
`void`	`setVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)` Sets the `SurfaceHolder` that holds the `Surface` onto which video will be rendered.
`void`	`setVideoSurfaceView(@Nullable SurfaceView surfaceView)` Sets the `SurfaceView` onto which video will be rendered.
`void`	`setVideoTextureView(@Nullable TextureView textureView)` Sets the `TextureView` onto which video will be rendered.
`void`	`setVirtualDeviceId(int virtualDeviceId)` Sets the virtual device id to be used for playback.
`void`	`setVolume(float volume)` Sets the audio volume, valid values are between 0 (silence) and 1 (unity gain, signal unchanged), inclusive.
`void`	`setWakeMode(@C.WakeMode int wakeMode)` Sets how the player should keep the device awake for playback when the screen is off.
`void`	`stop()` Stops playback without resetting the playlist.
`void`	`unmute()` If the audio volume is 0, sets the audio volume to a non-zero value decided by the Player to be the most appropriate.

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.exoplayer.ExoPlayer

`static final long`	`@UnstableApi DEFAULT_DETACH_SURFACE_TIMEOUT_MS = 2000` The default timeout for detaching a surface from the player, in milliseconds.
`static final long`	`@UnstableApi DEFAULT_RELEASE_TIMEOUT_MS = 500` The default timeout for calls to `release` and `setForegroundMode`, in milliseconds.
`static final int`	`@UnstableApi DEFAULT_STUCK_BUFFERING_DETECTION_TIMEOUT_MS = 600000` The default timeout for detecting whether playback is stuck buffering, in milliseconds.
`static final int`	`@UnstableApi DEFAULT_STUCK_PLAYING_DETECTION_TIMEOUT_MS` The default timeout for detecting whether playback is stuck playing, in milliseconds.
`static final int`	`@UnstableApi DEFAULT_STUCK_PLAYING_NOT_ENDING_TIMEOUT_MS = 60000` The default timeout for detecting whether playback is stuck playing but not ending, in milliseconds.
`static final int`	`@UnstableApi DEFAULT_STUCK_SUPPRESSED_DETECTION_TIMEOUT_MS = 600000` The default timeout for detecting whether playback is stuck in a suppressed state, in milliseconds.

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 `Timeline` 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.

Protected constructors

SimpleExoPlayer

protected SimpleExoPlayer(SimpleExoPlayer.Builder builder)

Parameters
`SimpleExoPlayer.Builder builder`	The `Builder` to obtain all construction parameters.

SimpleExoPlayer

protected SimpleExoPlayer(
    Context context,
    RenderersFactory renderersFactory,
    TrackSelector trackSelector,
    MediaSource.Factory mediaSourceFactory,
    LoadControl loadControl,
    BandwidthMeter bandwidthMeter,
    AnalyticsCollector analyticsCollector,
    boolean useLazyPreparation,
    Clock clock,
    Looper applicationLooper
)

Public methods

addAnalyticsListener

public void addAnalyticsListener(AnalyticsListener listener)

Adds an AnalyticsListener to receive analytics events.

This method can be called from any thread.

Parameters
`AnalyticsListener listener`	The listener to be added.

addAudioCodecParametersChangeListener

public void addAudioCodecParametersChangeListener(
    CodecParametersChangeListener listener,
    List<String> keys
)

Adds a listener for audio codec parameter changes.

The listener will be called on the application thread. Upon registration, the listener will be immediately called with the last known values for the subscribed keys.

The default MediaCodec based renderers only support this feature on API level 29 and above.

Note: When used with MediaCodec, observing vendor-specific parameter changes requires API level 31 or higher. On API levels 29 and 30, any requested vendor-specific keys will be ignored.

Parameters
`CodecParametersChangeListener listener`	The `CodecParametersChangeListener` to add.
`List<String> keys`	The list of parameter keys to subscribe to.

addAudioOffloadListener

public void addAudioOffloadListener(ExoPlayer.AudioOffloadListener listener)

Adds a listener to receive audio offload events.

This method can be called from any thread.

Parameters
`ExoPlayer.AudioOffloadListener listener`	The listener to register.

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.

addMediaSource

public void addMediaSource(MediaSource mediaSource)

Adds a media source to the end of the playlist.

Parameters
`MediaSource mediaSource`	The `MediaSource` to add.

addMediaSource

public void addMediaSource(int index, MediaSource mediaSource)

Adds a media source at the given index of the playlist.

Parameters
`int index`	The index at which to add the source.
`MediaSource mediaSource`	The `MediaSource` to add.

addMediaSources

public void addMediaSources(List<MediaSource> mediaSources)

Adds a list of media sources to the end of the playlist.

Parameters
`List<MediaSource> mediaSources`	The `MediaSources` to add.

addMediaSources

public void addMediaSources(int index, List<MediaSource> mediaSources)

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

Parameters
`int index`	The index at which to add the media sources.
`List<MediaSource> mediaSources`	The `MediaSources` to add.

addVideoCodecParametersChangeListener

public void addVideoCodecParametersChangeListener(
    CodecParametersChangeListener listener,
    List<String> keys
)

Adds a listener for video codec parameter changes.

The listener will be called on the application thread. Upon registration, the listener will be immediately called with the last known values for the subscribed keys.

The default MediaCodec based renderers only support this feature on API level 29 and above.

Note: When used with MediaCodec, observing vendor-specific parameter changes requires API level 31 or higher. On API levels 29 and 30, any requested vendor-specific keys will be ignored.

Parameters
`CodecParametersChangeListener listener`	The `CodecParametersChangeListener` to add.
`List<String> keys`	The list of parameter keys to subscribe to.

clearAuxEffectInfo

public void clearAuxEffectInfo()

Detaches any previously attached auxiliary audio effect from the underlying audio track.

clearCameraMotionListener

public void clearCameraMotionListener(CameraMotionListener listener)

Clears the listener which receives camera motion events if it matches the one passed. Else does nothing.

Parameters
`CameraMotionListener listener`	The listener to clear.

clearVideoFrameMetadataListener

public void clearVideoFrameMetadataListener(VideoFrameMetadataListener listener)

Clears the listener which receives video frame metadata events if it matches the one passed. Else does nothing.

Parameters
`VideoFrameMetadataListener listener`	The listener to clear.

clearVideoSurface

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

createMessage

public PlayerMessage createMessage(PlayerMessage.Target target)

Creates a message that can be sent to a PlayerMessage.Target. By default, the message will be delivered immediately without blocking on the playback thread. The default getType is 0 and the default getPayload is null. If a position is specified with setPosition, the message will be delivered at this position in the current media item defined by getCurrentMediaItemIndex. Alternatively, the message can be sent at a specific mediaItem using setPosition.

decreaseDeviceVolume

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

getAnalyticsCollector

public AnalyticsCollector getAnalyticsCollector()

Returns the AnalyticsCollector used for collecting analytics events.

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()

Returns the attributes for audio playback.

This method must only be called if COMMAND_GET_AUDIO_ATTRIBUTES is available.

See also
`onAudioAttributesChanged`

getAudioDecoderCounters

public @Nullable DecoderCounters getAudioDecoderCounters()

Returns DecoderCounters for audio, or null if no audio is being played.

getAudioFormat

public @Nullable Format getAudioFormat()

Returns the audio format currently being played, or null if no audio is being played.

getAudioSessionId

public int getAudioSessionId()

Returns the audio session identifier, or AUDIO_SESSION_ID_UNSET if not set.

See also
`onAudioSessionIdChanged`

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.

getClock

public Clock getClock()

Returns the Clock used for playback.

This method can be called from any thread.

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()

Returns the current CueGroup.

This method must only be called if COMMAND_GET_TEXT is available.

See also
`onCues`

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`

getCurrentTrackGroups

public TrackGroupArray getCurrentTrackGroups()

getCurrentTrackSelections

public TrackSelectionArray getCurrentTrackSelections()

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()

Gets the device information.

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.

getMaxSeekToPreviousPosition

public long getMaxSeekToPreviousPosition()

Returns the maximum position for which seekToPrevious seeks to the previous MediaItem, 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`

getPauseAtEndOfMediaItems

public boolean getPauseAtEndOfMediaItems()

Returns whether the player pauses playback at the end of each media item.

See also
`setPauseAtEndOfMediaItems`

getPlayWhenReady

public boolean getPlayWhenReady()

Whether playback will proceed when getPlaybackState == STATE_READY.

Returns
`boolean`	Whether playback will proceed when ready.

See also
`onPlayWhenReadyChanged`

getPlaybackLooper

public Looper getPlaybackLooper()

Returns the Looper associated with the playback thread.

This method may be called from any thread.

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 ExoPlaybackException 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 ExoPlaybackException`	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`

getPreloadConfiguration

public ExoPlayer.PreloadConfiguration getPreloadConfiguration()

Returns the preload configuration.

getRenderer

public Renderer getRenderer(int index)

Returns the renderer at the given index.

Parameters
`int index`	The index of the renderer.

Returns
`Renderer`	The renderer at this index.

getRendererCount

public int getRendererCount()

Returns the number of renderers.

getRendererType

@C.TrackType
public int getRendererType(int index)

Returns the track type that the renderer at a given index handles.

For example, a video renderer will return TRACK_TYPE_VIDEO, an audio renderer will return TRACK_TYPE_AUDIO and a text renderer will return TRACK_TYPE_TEXT.

Parameters
`int index`	The index of the renderer.

Returns
`int`	The `track type` that the renderer handles.

getRepeatMode

@Player.RepeatMode
public int getRepeatMode()

Returns the current RepeatMode used for playback.

Returns
`int`	The current repeat mode.

See also
`onRepeatModeChanged`

getScrubbingModeParameters

public ScrubbingModeParameters getScrubbingModeParameters()

Gets the parameters that control behavior in scrubbing mode.

getSecondaryRenderer

public Renderer getSecondaryRenderer(int index)

Returns the secondary renderer at the given index.

Parameters
`int index`	The index of the secondary renderer.

Returns
`Renderer`	The secondary renderer at this index, or null if there is no secondary renderer at this index.

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`

getSeekParameters

public SeekParameters getSeekParameters()

Returns the currently active SeekParameters of the player.

getShuffleModeEnabled

public boolean getShuffleModeEnabled()

Returns whether shuffling of media items is enabled.

See also
`onShuffleModeEnabledChanged`

getShuffleOrder

public ShuffleOrder getShuffleOrder()

Returns the shuffle order.

The ShuffleOrder returned will have the same length as the current playlist (getMediaItemCount).

getSkipSilenceEnabled

public boolean getSkipSilenceEnabled()

Returns whether skipping silences in the audio stream is enabled.

See also
`onSkipSilenceEnabledChanged`

getSurfaceSize

public Size getSurfaceSize()

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

See also
`onSurfaceSizeChanged`

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`	}

getTrackSelector

public TrackSelector getTrackSelector()

Returns the track selector that this player uses, or null if track selection is not supported.

getVideoChangeFrameRateStrategy

@C.VideoChangeFrameRateStrategy
public int getVideoChangeFrameRateStrategy()

Returns the C.VideoChangeFrameRateStrategy.

getVideoDecoderCounters

public @Nullable DecoderCounters getVideoDecoderCounters()

Returns DecoderCounters for video, or null if no video is being played.

getVideoFormat

public @Nullable Format getVideoFormat()

Returns the video format currently being played, or null if no video is being played.

getVideoScalingMode

@C.VideoScalingMode
public int getVideoScalingMode()

Returns the C.VideoScalingMode.

getVideoSize

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

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.

isReleased

public boolean isReleased()

Returns whether release has been called on the player.

This method is allowed to be called after release.

isScrubbingModeEnabled

public boolean isScrubbingModeEnabled()

Returns whether the player is optimized for scrubbing (many frequent seeks).

See setScrubbingModeEnabled.

isSleepingForOffload

public boolean isSleepingForOffload()

Returns whether the player has paused its main loop to save power in offload scheduling mode.

Offload scheduling mode should save significant power when the phone is playing offload audio with the screen off.

Offload scheduling is only enabled when playing an audio track in offload mode, which requires all the following:

Audio offload rendering is enabled through setAudioOffloadPreferences.
An audio track is playing in a format that the device supports offloading (for example, MP3 or AAC).
The AudioSink is playing with an offload AudioTrack.

See also
`onSleepingForOffloadChanged`

isTunnelingEnabled

public boolean isTunnelingEnabled()

Returns whether tunneling is enabled for the currently selected tracks.

See also
`onTracksChanged`

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.

mute

public void mute()

Sets the audio volume to 0.

This method must only be called if COMMAND_SET_VOLUME is available.

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.

prepare

public void prepare(MediaSource mediaSource)

prepare

public void prepare(
    MediaSource mediaSource,
    boolean resetPosition,
    boolean resetState
)

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.

removeAnalyticsListener

public void removeAnalyticsListener(AnalyticsListener listener)

Removes an AnalyticsListener.

Parameters
`AnalyticsListener listener`	The listener to be removed.

removeAudioCodecParametersChangeListener

public void removeAudioCodecParametersChangeListener(
    CodecParametersChangeListener listener
)

Removes a listener for audio codec parameter changes.

Parameters
`CodecParametersChangeListener listener`	The `CodecParametersChangeListener` to remove.

removeAudioOffloadListener

public void removeAudioOffloadListener(ExoPlayer.AudioOffloadListener listener)

Removes a listener of audio offload events.

Parameters
`ExoPlayer.AudioOffloadListener listener`	The listener to unregister.

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.

removeVideoCodecParametersChangeListener

public void removeVideoCodecParametersChangeListener(
    CodecParametersChangeListener listener
)

Removes a listener for video codec parameter changes.

Parameters
`CodecParametersChangeListener listener`	The `CodecParametersChangeListener` to remove.

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
)

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 audio focus should be handled, the usage must be USAGE_MEDIA or USAGE_GAME. Other usages will throw an IllegalArgumentException.

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.

setAudioCodecParameters

public void setAudioCodecParameters(CodecParameters codecParameters)

Sets a collection of parameters on the underlying audio codecs.

This method is asynchronous. The parameters will be applied to the audio renderers on the playback thread.

The default MediaCodec based renderers only support this feature on API level 29 and above. If an underlying decoder does not support a parameter, it will be ignored.

Parameters
`CodecParameters codecParameters`	The `CodecParameters` to set.

setAudioSessionId

public void setAudioSessionId(int audioSessionId)

Sets the ID of the audio session to attach to the underlying android.media.AudioTrack.

The audio session ID can be generated using generateAudioSessionIdV21.

Parameters
`int audioSessionId`	The audio session ID, or `AUDIO_SESSION_ID_UNSET` if it should be generated by the framework.

setAuxEffectInfo

public void setAuxEffectInfo(AuxEffectInfo auxEffectInfo)

Sets information on an auxiliary audio effect to attach to the underlying audio track.

setCameraMotionListener

public void setCameraMotionListener(CameraMotionListener listener)

Sets a listener of camera motion events.

Parameters
`CameraMotionListener listener`	The listener.

setDeviceMuted

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

public void setDeviceVolume(int volume)

setDeviceVolume

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

setForegroundMode

public void setForegroundMode(boolean foregroundMode)

Sets whether the player is allowed to keep holding limited resources such as video decoders, even when in the idle state. By doing so, the player may be able to reduce latency when starting to play another piece of content for which the same resources are required.

This mode should be used with caution, since holding limited resources may prevent other players of media components from acquiring them. It should only be enabled when both of the following conditions are true:

The application that owns the player is in the foreground.
The player is used in a way that may benefit from foreground mode. For this to be true, the same player instance must be used to play multiple pieces of content, and there must be gaps between the playbacks (i.e. stop is called to halt one playback, and prepare is called some time later to start a new one).

Note that foreground mode is not useful for switching between content without gaps between the playbacks. For this use case stop does not need to be called, and simply calling prepare for the new media will cause limited resources to be retained even if foreground mode is not enabled.

If foreground mode is enabled, it's the application's responsibility to disable it when the conditions described above no longer hold.

Parameters
`boolean foregroundMode`	Whether the player is allowed to keep limited resources even when in the idle state.

setHandleAudioBecomingNoisy

public void setHandleAudioBecomingNoisy(boolean handleAudioBecomingNoisy)

Sets whether the player should pause automatically when audio is rerouted from a headset to device speakers. See the audio becoming noisy documentation for more information.

Parameters
`boolean handleAudioBecomingNoisy`	Whether the player should pause automatically when audio is rerouted from a headset to device speakers.

setImageOutput

public void setImageOutput(@Nullable ImageOutput imageOutput)

Sets the ImageOutput where rendered images will be forwarded.

Parameters
`@Nullable ImageOutput imageOutput`	The `ImageOutput`. May be null to clear a previously set image output.

setMaxSeekToPreviousPositionMs

public void setMaxSeekToPreviousPositionMs(long maxSeekToPreviousPositionMs)

Sets the maximum position for which seekToPrevious seeks to the previous MediaItem.

Parameters
`long maxSeekToPreviousPositionMs`	The maximum position, in milliseconds.

Throws
`java.lang.IllegalArgumentException`	If `maxSeekToPreviousPositionMs` is negative.

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.

setMediaSource

public void setMediaSource(MediaSource mediaSource)

Clears the playlist, adds the specified MediaSource and resets the position to the default position.

Parameters
`MediaSource mediaSource`	The new `MediaSource`.

setMediaSource

public void setMediaSource(MediaSource mediaSource, boolean resetPosition)

Clears the playlist and adds the specified MediaSource.

Parameters
`MediaSource mediaSource`	The new `MediaSource`.
`boolean resetPosition`	Whether the playback position should be reset to the default position. If false, playback will start from the position defined by `getCurrentMediaItemIndex` and `getCurrentPosition`.

setMediaSource

public void setMediaSource(MediaSource mediaSource, long startPositionMs)

Clears the playlist and adds the specified MediaSource.

Parameters
`MediaSource mediaSource`	The new `MediaSource`.
`long startPositionMs`	The position in milliseconds to start playback from. If `TIME_UNSET` is passed, the default position of the given media source is used.

setMediaSources

public void setMediaSources(List<MediaSource> mediaSources)

Clears the playlist, adds the specified MediaSources and resets the position to the default position.

Parameters
`List<MediaSource> mediaSources`	The new `MediaSources`.

setMediaSources

public void setMediaSources(List<MediaSource> mediaSources, boolean resetPosition)

Clears the playlist and adds the specified MediaSources.

Parameters
`List<MediaSource> mediaSources`	The new `MediaSources`.
`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`.

setMediaSources

public void setMediaSources(
    List<MediaSource> mediaSources,
    int startMediaItemIndex,
    long startPositionMs
)

Clears the playlist and adds the specified MediaSources.

Parameters
`List<MediaSource> mediaSources`	The new `MediaSources`.
`int startMediaItemIndex`	The media item 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 media source is used. In any case, if `startMediaItemIndex` is set to `INDEX_UNSET`, this parameter is ignored and the position is not reset at all.

setPauseAtEndOfMediaItems

public void setPauseAtEndOfMediaItems(boolean pauseAtEndOfMediaItems)

Sets whether to pause playback at the end of each media item.

This means the player will pause at the end of each window in the current timeline. Listeners will be informed by a call to onPlayWhenReadyChanged with the reason PLAY_WHEN_READY_CHANGE_REASON_END_OF_MEDIA_ITEM when this happens.

Parameters
`boolean pauseAtEndOfMediaItems`	Whether to pause playback at the end of each media item.

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 mediaMetadata)

Sets the playlist MediaMetadata.

This method must only be called if COMMAND_SET_PLAYLIST_METADATA is available.

setPreferredAudioDevice

public void setPreferredAudioDevice(@Nullable AudioDeviceInfo audioDeviceInfo)

Sets the preferred audio device.

Parameters
`@Nullable AudioDeviceInfo audioDeviceInfo`	The preferred `audio device`, or null to restore the default.

setPreloadConfiguration

public void setPreloadConfiguration(
    ExoPlayer.PreloadConfiguration preloadConfiguration
)

Sets the preload configuration to configure playlist preloading.

Parameters
`ExoPlayer.PreloadConfiguration preloadConfiguration`	The preload configuration.

setPriority

public void setPriority(@C.Priority int priority)

Sets the C.Priority for this player.

The priority may influence resource allocation between multiple players or other components running in the same app.

This priority is used for the PriorityTaskManager, if set.

Parameters
`@C.Priority int priority`	The `C.Priority`.

setPriorityTaskManager

public void setPriorityTaskManager(
    @Nullable PriorityTaskManager priorityTaskManager
)

Sets a PriorityTaskManager, or null to clear a previously set priority task manager.

The priority set via setPriority (or by default) will be set while the player is loading.

Parameters
`@Nullable PriorityTaskManager priorityTaskManager`	The `PriorityTaskManager`, or null to clear a previously set priority task manager.

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.

setScrubbingModeEnabled

public void setScrubbingModeEnabled(boolean scrubbingModeEnabled)

Sets whether to optimize the player for scrubbing (many frequent seeks).

The player may consume more resources in this mode, so it should only be used for short periods of time in response to user interaction (e.g. dragging on a progress bar UI element).

During scrubbing mode playback is suppressed with PLAYBACK_SUPPRESSION_REASON_SCRUBBING.

Parameters
`boolean scrubbingModeEnabled`	Whether scrubbing mode should be enabled.

setScrubbingModeParameters

public void setScrubbingModeParameters(
    ScrubbingModeParameters scrubbingModeParameters
)

Sets the parameters that control behavior in scrubbing mode.

setSeekBackIncrementMs

public void setSeekBackIncrementMs(long seekBackIncrementMs)

Sets the seekBack increment.

Parameters
`long seekBackIncrementMs`	The seek back increment, in milliseconds.

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

setSeekForwardIncrementMs

public void setSeekForwardIncrementMs(long seekForwardIncrementMs)

Sets the seekForward increment.

Parameters
`long seekForwardIncrementMs`	The seek forward increment, in milliseconds.

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

setSeekParameters

public void setSeekParameters(@Nullable SeekParameters seekParameters)

Sets the parameters that control how seek operations are performed.

Parameters
`@Nullable SeekParameters seekParameters`	The seek parameters, or `null` to use the defaults.

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.

setShuffleOrder

public void setShuffleOrder(ShuffleOrder shuffleOrder)

Sets the shuffle order.

The ShuffleOrder passed must have the same length as the current playlist (getMediaItemCount).

Parameters
`ShuffleOrder shuffleOrder`	The shuffle order.

setSkipSilenceEnabled

public void setSkipSilenceEnabled(boolean skipSilenceEnabled)

Sets whether skipping silences in the audio stream is enabled.

Parameters
`boolean skipSilenceEnabled`	Whether skipping silences in the audio stream 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.

setVideoChangeFrameRateStrategy

public void setVideoChangeFrameRateStrategy(
    @C.VideoChangeFrameRateStrategy int videoChangeFrameRateStrategy
)

Sets a C.VideoChangeFrameRateStrategy that will be used by the player when provided with a video output Surface.

The strategy only applies if a MediaCodec-based video Renderer is enabled. Applications wishing to use CHANGE_FRAME_RATE_ALWAYS should set the mode to VIDEO_CHANGE_FRAME_RATE_STRATEGY_OFF to disable calls to setFrameRate from ExoPlayer, and should then call setFrameRate directly from application code.

Parameters
`@C.VideoChangeFrameRateStrategy int videoChangeFrameRateStrategy`	A `C.VideoChangeFrameRateStrategy`.

setVideoCodecParameters

public void setVideoCodecParameters(CodecParameters codecParameters)

Sets a collection of parameters on the underlying video codecs.

This method is asynchronous. The parameters will be applied to the video renderers on the playback thread.

The default MediaCodec based renderers only support this feature on API level 29 and above. If an underlying decoder does not support a parameter, it will be ignored.

Parameters
`CodecParameters codecParameters`	The `CodecParameters` to set.

setVideoEffects

public void setVideoEffects(List<Effect> videoEffects)

Sets a List of video effects that will be applied to each video frame.

If passing a surface to the player directly, the output resolution needs to be signaled by passing a message to the video renderer with type MSG_SET_VIDEO_OUTPUT_RESOLUTION after calling this method. For SurfaceView, TextureView and SurfaceHolder output this happens automatically.

Pass REDRAW to force the effect pipeline to redraw the effects immediately. To accurately interleave redraws, listen to onVideoFrameAboutToBeRendered events.

The following limitations exist for using video effects:

The androidx.media3:media3-effect module must be available on the runtime classpath. androidx.media3:media3-exoplayer does not explicitly depend on the effect module, so apps must make sure it's available themselves. It must be the same version as the rest of the androidx.media3 modules being used by the app.
This feature works only with the default MediaCodecVideoRenderer and not custom or extension video renderers.
This feature does not work with effects that update the frame timestamps.
This feature does not work with DRM-protected content.
This method must be called at least once before calling prepare (in order to set up the effects pipeline). The effects can be changed during playback by subsequent calls to this method after prepare.

Parameters
`List<Effect> videoEffects`	The `List` of `video effects` to apply.

setVideoFrameMetadataListener

public void setVideoFrameMetadataListener(VideoFrameMetadataListener listener)

Sets a listener to receive video frame metadata events.

This method is intended to be called by the same component that sets the Surface onto which video will be rendered. If using ExoPlayer's standard UI components, this method should not be called directly from application code.

Parameters
`VideoFrameMetadataListener listener`	The listener.

setVideoScalingMode

public void setVideoScalingMode(@C.VideoScalingMode int videoScalingMode)

Sets the C.VideoScalingMode.

The scaling mode only applies if a MediaCodec-based video Renderer is enabled and if the output surface is owned by a SurfaceView.

Parameters
`@C.VideoScalingMode int videoScalingMode`	The `C.VideoScalingMode`.

setVideoSurface

public 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 SurfaceHolder 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 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 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 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 TextureView. 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.

setVirtualDeviceId

public void setVirtualDeviceId(int virtualDeviceId)

Sets the virtual device id to be used for playback.

Note that the initial value is obtained from getDeviceId from the Context passed to Builder.

Parameters
`int virtualDeviceId`	The `virtual device id`, or `INDEX_UNSET` if unspecified.

setVolume

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

setWakeMode

public void setWakeMode(@C.WakeMode int wakeMode)

Sets how the player should keep the device awake for playback when the screen is off.

Enabling this feature requires the WAKE_LOCK permission. It should be used together with a foreground android.app.Service for use cases where playback occurs and the screen is off (e.g. background audio playback). It is not useful when the screen will be kept on during playback (e.g. foreground video playback).

When enabled, the locks (android.os.PowerManager.WakeLock / android.net.wifi.WifiManager.WifiLock) will be held whenever the player is in the STATE_READY or STATE_BUFFERING states with playWhenReady = true. The locks held depends on the specified C.WakeMode.

Parameters
`@C.WakeMode int wakeMode`	The `C.WakeMode` option to keep the device awake during playback.

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.

unmute

public void unmute()

If the audio volume is 0, sets the audio volume to a non-zero value decided by the Player to be the most appropriate.

This method must only be called if COMMAND_SET_VOLUME 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.