ExoPlayer

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

public interface ExoPlayer extends Player

Known direct subclasses

SimpleExoPlayer, StubExoPlayer

SimpleExoPlayer

This class is deprecated.

Use ExoPlayer instead.

StubExoPlayer

An abstract ExoPlayer implementation that throws UnsupportedOperationException from every method.

An extensible media player that plays MediaSources. Instances can be obtained from .

Player components

ExoPlayer is designed to make few assumptions about (and hence impose few restrictions on) the type of the media being played, how and where it is stored, and how it is rendered. Rather than implementing the loading and rendering of media directly, ExoPlayer implementations delegate this work to components that are injected when a player is created or when it's prepared for playback. Components common to all ExoPlayer implementations are:

MediaSources that define the media to be played, load the media, and from which the loaded media can be read. MediaSources are created from MediaItems by the MediaSource.Factory injected into the player Builder, or can be added directly by methods like setMediaSource. The library provides a DefaultMediaSourceFactory for progressive media files, DASH, SmoothStreaming and HLS, which also includes functionality for side-loading subtitle files and clipping media.
Renderers that render individual components of the media. The library provides default implementations for common media types (MediaCodecVideoRenderer, MediaCodecAudioRenderer, TextRenderer and MetadataRenderer). A Renderer consumes media from the MediaSource being played. Renderers are injected when the player is created. The number of renderers and their respective track types can be obtained by calling getRendererCount and getRendererType.
A TrackSelector that selects tracks provided by the MediaSource to be consumed by each of the available Renderers. The library provides a default implementation (DefaultTrackSelector) suitable for most use cases. A TrackSelector is injected when the player is created.
A LoadControl that controls when the MediaSource buffers more media, and how much media is buffered. The library provides a default implementation () suitable for most use cases. A LoadControl is injected when the player is created.

An ExoPlayer can be built using the default components provided by the library, but may also be built using custom implementations if non-standard behaviors are required. For example a custom LoadControl could be injected to change the player's buffering strategy, or a custom Renderer could be injected to add support for a video codec not supported natively by Android.

The concept of injecting components that implement pieces of player functionality is present throughout the library. The default component implementations listed above delegate work to further injected components. This allows many sub-components to be individually replaced with custom implementations. For example the default MediaSource implementations require one or more DataSource factories to be injected via their constructors. By providing a custom factory it's possible to load data from a non-standard source, or through a different network stack.

Threading model

The figure below shows ExoPlayer's threading model.

ExoPlayer's threading model

ExoPlayer instances must be accessed from a single application thread unless indicated otherwise. For the vast majority of cases this should be the application's main thread. Using the application's main thread is also a requirement when using ExoPlayer's UI components or the IMA extension. The thread on which an ExoPlayer instance must be accessed can be explicitly specified by passing a Looper when creating the player. If no Looper is specified, then the Looper of the thread that the player is created on is used, or if that thread does not have a Looper, the Looper of the application's main thread is used. In all cases the Looper of the thread from which the player must be accessed can be queried using getApplicationLooper.
Registered listeners are called on the thread associated with getApplicationLooper. Note that this means registered listeners are called on the same thread which must be used to access the player.
An internal playback thread is responsible for playback. Injected player components such as Renderers, MediaSources, TrackSelectors and LoadControls are called by the player on this thread.
When the application performs an operation on the player, for example a seek, a message is delivered to the internal playback thread via a message queue. The internal playback thread consumes messages from the queue and performs the corresponding operations. Similarly, when a playback event occurs on the internal playback thread, a message is delivered to the application thread via a second message queue. The application thread consumes messages from the queue, updating the application visible state and calling corresponding listener methods.
Injected player components may use additional background threads. For example a MediaSource may use background threads to load data. These are implementation specific.

Summary

Nested types
`@UnstableApi public interface ExoPlayer.AudioOffloadListener` A listener for audio offload events.
`public final class ExoPlayer.Builder` A builder for `ExoPlayer` instances.
`@UnstableApi public class ExoPlayer.PreloadConfiguration` Configuration options for preloading playlist items.

Constants
`default static final long`	`@UnstableApi DEFAULT_DETACH_SURFACE_TIMEOUT_MS = 2000` The default timeout for detaching a surface from the player, in milliseconds.
`default static final long`	`@UnstableApi DEFAULT_RELEASE_TIMEOUT_MS = 500` The default timeout for calls to `release` and `setForegroundMode`, in milliseconds.

Public methods
`abstract void`	`addAnalyticsListener(AnalyticsListener listener)` Adds an `AnalyticsListener` to receive analytics events.
`abstract void`	`@UnstableApi addAudioOffloadListener(ExoPlayer.AudioOffloadListener listener)` Adds a listener to receive audio offload events.
`abstract void`	`@UnstableApi addMediaSource(MediaSource mediaSource)` Adds a media source to the end of the playlist.
`abstract void`	`@UnstableApi addMediaSource(int index, MediaSource mediaSource)` Adds a media source at the given index of the playlist.
`abstract void`	`@UnstableApi addMediaSources(List<MediaSource> mediaSources)` Adds a list of media sources to the end of the playlist.
`abstract void`	`@UnstableApi addMediaSources(int index, List<MediaSource> mediaSources)` Adds a list of media sources at the given index of the playlist.
`abstract void`	`@UnstableApi clearAuxEffectInfo()` Detaches any previously attached auxiliary audio effect from the underlying audio track.
`abstract void`	`@UnstableApi clearCameraMotionListener(CameraMotionListener listener)` Clears the listener which receives camera motion events if it matches the one passed.
`abstract void`	`@UnstableApi clearVideoFrameMetadataListener(VideoFrameMetadataListener listener)` Clears the listener which receives video frame metadata events if it matches the one passed.
`abstract PlayerMessage`	`@UnstableApi createMessage(PlayerMessage.Target target)` Creates a message that can be sent to a `PlayerMessage.Target`.
`abstract AnalyticsCollector`	`@UnstableApi getAnalyticsCollector()` Returns the `AnalyticsCollector` used for collecting analytics events.
`abstract @Nullable DecoderCounters`	`@UnstableApi getAudioDecoderCounters()` Returns `DecoderCounters` for audio, or null if no audio is being played.
`abstract @Nullable Format`	`@UnstableApi getAudioFormat()` Returns the audio format currently being played, or null if no audio is being played.
`abstract int`	`@UnstableApi getAudioSessionId()` Returns the audio session identifier, or `AUDIO_SESSION_ID_UNSET` if not set.
`abstract Clock`	`@UnstableApi getClock()` Returns the `Clock` used for playback.
`abstract TrackGroupArray`	`@UnstableApi getCurrentTrackGroups()` This method is deprecated. Use `getCurrentTracks`.
`abstract TrackSelectionArray`	`@UnstableApi getCurrentTrackSelections()` This method is deprecated. Use `getCurrentTracks`.
`abstract boolean`	`@UnstableApi getPauseAtEndOfMediaItems()` Returns whether the player pauses playback at the end of each media item.
`abstract Looper`	`@UnstableApi getPlaybackLooper()` Returns the `Looper` associated with the playback thread.
`abstract @Nullable ExoPlaybackException`	`getPlayerError()` Equivalent to `getPlayerError`, except the exception is guaranteed to be an `ExoPlaybackException`.
`abstract ExoPlayer.PreloadConfiguration`	`@UnstableApi getPreloadConfiguration()` Returns the `preload configuration`.
`abstract Renderer`	`@UnstableApi getRenderer(int index)` Returns the renderer at the given index.
`abstract int`	`@UnstableApi getRendererCount()` Returns the number of renderers.
`abstract int`	`@UnstableApi @C.TrackType getRendererType(int index)` Returns the track type that the renderer at a given index handles.
`abstract ScrubbingModeParameters`	`@UnstableApi getScrubbingModeParameters()` Gets the parameters that control behavior in `scrubbing mode`.
`default @Nullable Renderer`	`@UnstableApi getSecondaryRenderer(int index)` Returns the secondary renderer at the given index.
`abstract SeekParameters`	`@UnstableApi getSeekParameters()` Returns the currently active `SeekParameters` of the player.
`abstract boolean`	`@UnstableApi getSkipSilenceEnabled()` Returns whether skipping silences in the audio stream is enabled.
`abstract @Nullable TrackSelector`	`@UnstableApi getTrackSelector()` Returns the track selector that this player uses, or null if track selection is not supported.
`abstract int`	`@UnstableApi @C.VideoChangeFrameRateStrategy getVideoChangeFrameRateStrategy()` Returns the `C.VideoChangeFrameRateStrategy`.
`abstract @Nullable DecoderCounters`	`@UnstableApi getVideoDecoderCounters()` Returns `DecoderCounters` for video, or null if no video is being played.
`abstract @Nullable Format`	`@UnstableApi getVideoFormat()` Returns the video format currently being played, or null if no video is being played.
`abstract int`	`@UnstableApi @C.VideoScalingMode getVideoScalingMode()` Returns the `C.VideoScalingMode`.
`abstract boolean`	`@UnstableApi isReleased()` Returns whether `release` has been called on the player.
`abstract boolean`	`@UnstableApi isScrubbingModeEnabled()` Returns whether the player is optimized for scrubbing (many frequent seeks).
`abstract boolean`	`@UnstableApi isSleepingForOffload()` Returns whether the player has paused its main loop to save power in offload scheduling mode.
`abstract boolean`	`@UnstableApi isTunnelingEnabled()` Returns whether tunneling is enabled for the currently selected tracks.
`abstract void`	`@UnstableApi prepare(MediaSource mediaSource)` This method is deprecated. Use `setMediaSource` and `prepare` instead.
`abstract void`	`@UnstableApi prepare( MediaSource mediaSource, boolean resetPosition, boolean resetState )` This method is deprecated. Use `setMediaSource` and `prepare` instead.
`abstract void`	`release()` Releases the player.
`abstract void`	`removeAnalyticsListener(AnalyticsListener listener)` Removes an `AnalyticsListener`.
`abstract void`	`@UnstableApi removeAudioOffloadListener(ExoPlayer.AudioOffloadListener listener)` Removes a listener of audio offload events.
`abstract void`	`replaceMediaItem(int index, MediaItem mediaItem)` Replaces the media item at the given index of the playlist.
`abstract void`	`replaceMediaItems( int fromIndex, int toIndex, List<MediaItem> mediaItems )` Replaces the media items at the given range of the playlist.
`abstract void`	`@UnstableApi setAudioSessionId(int audioSessionId)` Sets the ID of the audio session to attach to the underlying `android.media.AudioTrack`.
`abstract void`	`@UnstableApi setAuxEffectInfo(AuxEffectInfo auxEffectInfo)` Sets information on an auxiliary audio effect to attach to the underlying audio track.
`abstract void`	`@UnstableApi setCameraMotionListener(CameraMotionListener listener)` Sets a listener of camera motion events.
`abstract void`	`@UnstableApi setForegroundMode(boolean foregroundMode)` Sets whether the player is allowed to keep holding limited resources such as video decoders, even when in the idle state.
`abstract void`	`setHandleAudioBecomingNoisy(boolean handleAudioBecomingNoisy)` Sets whether the player should pause automatically when audio is rerouted from a headset to device speakers.
`abstract void`	`@UnstableApi setImageOutput(@Nullable ImageOutput imageOutput)` Sets the `ImageOutput` where rendered images will be forwarded.
`abstract void`	`@UnstableApi setMediaSource(MediaSource mediaSource)` Clears the playlist, adds the specified `MediaSource` and resets the position to the default position.
`abstract void`	`@UnstableApi setMediaSource(MediaSource mediaSource, boolean resetPosition)` Clears the playlist and adds the specified `MediaSource`.
`abstract void`	`@UnstableApi setMediaSource(MediaSource mediaSource, long startPositionMs)` Clears the playlist and adds the specified `MediaSource`.
`abstract void`	`@UnstableApi setMediaSources(List<MediaSource> mediaSources)` Clears the playlist, adds the specified `MediaSources` and resets the position to the default position.
`abstract void`	`@UnstableApi setMediaSources(List<MediaSource> mediaSources, boolean resetPosition)` Clears the playlist and adds the specified `MediaSources`.
`abstract void`	`@UnstableApi setMediaSources( List<MediaSource> mediaSources, int startMediaItemIndex, long startPositionMs )` Clears the playlist and adds the specified `MediaSources`.
`abstract void`	`@UnstableApi setPauseAtEndOfMediaItems(boolean pauseAtEndOfMediaItems)` Sets whether to pause playback at the end of each media item.
`abstract void`	`@UnstableApi @RequiresApi(value = 23) setPreferredAudioDevice(@Nullable AudioDeviceInfo audioDeviceInfo)` Sets the preferred audio device.
`abstract void`	`@UnstableApi setPreloadConfiguration( ExoPlayer.PreloadConfiguration preloadConfiguration )` Sets the `preload configuration` to configure playlist preloading.
`abstract void`	`@UnstableApi setPriority(@C.Priority int priority)` Sets the `C.Priority` for this player.
`abstract void`	`@UnstableApi setPriorityTaskManager( @Nullable PriorityTaskManager priorityTaskManager )` Sets a `PriorityTaskManager`, or null to clear a previously set priority task manager.
`abstract void`	`@UnstableApi setScrubbingModeEnabled(boolean scrubbingModeEnabled)` Sets whether to optimize the player for scrubbing (many frequent seeks).
`abstract void`	`@UnstableApi setScrubbingModeParameters( ScrubbingModeParameters scrubbingModeParameters )` Sets the parameters that control behavior in `scrubbing mode`.
`abstract void`	`@UnstableApi setSeekParameters(@Nullable SeekParameters seekParameters)` Sets the parameters that control how seek operations are performed.
`abstract void`	`@UnstableApi setShuffleOrder(ShuffleOrder shuffleOrder)` Sets the shuffle order.
`abstract void`	`@UnstableApi setSkipSilenceEnabled(boolean skipSilenceEnabled)` Sets whether skipping silences in the audio stream is enabled.
`abstract void`	`@UnstableApi setVideoChangeFrameRateStrategy( @C.VideoChangeFrameRateStrategy int videoChangeFrameRateStrategy )` Sets a `C.VideoChangeFrameRateStrategy` that will be used by the player when provided with a video output `Surface`.
`abstract void`	`@UnstableApi setVideoEffects(List<Effect> videoEffects)` Sets a `List` of `video effects` that will be applied to each video frame.
`abstract void`	`@UnstableApi setVideoFrameMetadataListener(VideoFrameMetadataListener listener)` Sets a listener to receive video frame metadata events.
`abstract void`	`@UnstableApi setVideoScalingMode(@C.VideoScalingMode int videoScalingMode)` Sets the `C.VideoScalingMode`.
`abstract void`	`setWakeMode(@C.WakeMode int wakeMode)` Sets how the player should keep the device awake for playback when the screen is off.

Inherited Constants

From androidx.media3.common.Player

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

From androidx.media3.common.Player

`abstract void`	`addListener(Player.Listener listener)` Registers a listener to receive all events from the player.
`abstract void`	`addMediaItem(MediaItem mediaItem)` Adds a media item to the end of the playlist.
`abstract void`	`addMediaItem(int index, MediaItem mediaItem)` Adds a media item at the given index of the playlist.
`abstract void`	`addMediaItems(List<MediaItem> mediaItems)` Adds a list of media items to the end of the playlist.
`abstract void`	`addMediaItems(int index, List<MediaItem> mediaItems)` Adds a list of media items at the given index of the playlist.
`abstract boolean`	`canAdvertiseSession()` Returns whether the player can be used to advertise a media session.
`abstract void`	`clearMediaItems()` Clears the playlist.
`abstract void`	`clearVideoSurface()` Clears any `Surface`, `SurfaceHolder`, `SurfaceView` or `TextureView` currently set on the player.
`abstract void`	`clearVideoSurface(@Nullable Surface surface)` Clears the `Surface` onto which video is being rendered if it matches the one passed.
`abstract void`	`clearVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)` Clears the `SurfaceHolder` that holds the `Surface` onto which video is being rendered if it matches the one passed.
`abstract void`	`clearVideoSurfaceView(@Nullable SurfaceView surfaceView)` Clears the `SurfaceView` onto which video is being rendered if it matches the one passed.
`abstract void`	`clearVideoTextureView(@Nullable TextureView textureView)` Clears the `TextureView` onto which video is being rendered if it matches the one passed.
`abstract void`	`decreaseDeviceVolume()` This method is deprecated. Use `decreaseDeviceVolume` instead.
`abstract void`	`decreaseDeviceVolume(@C.VolumeFlags int flags)` Decreases the volume of the device.
`abstract Looper`	`getApplicationLooper()` Returns the `Looper` associated with the application thread that's used to access the player and on which player events are received.
`abstract AudioAttributes`	`getAudioAttributes()` Returns the attributes for audio playback.
`abstract Player.Commands`	`getAvailableCommands()` Returns the player's currently available `Commands`.
`abstract @IntRange(from = 0, to = 100) 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.
`abstract long`	`getBufferedPosition()` Returns an estimate of the position in the current content or ad up to which data is buffered, in milliseconds.
`abstract 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.
`abstract long`	`getContentDuration()` If `isPlayingAd` returns `true`, returns the duration of the current content in milliseconds, or `TIME_UNSET` if the duration is not known.
`abstract 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.
`abstract int`	`getCurrentAdGroupIndex()` If `isPlayingAd` returns true, returns the index of the ad group in the period currently being played.
`abstract int`	`getCurrentAdIndexInAdGroup()` If `isPlayingAd` returns true, returns the index of the ad in its ad group.
`abstract CueGroup`	`getCurrentCues()` Returns the current `CueGroup`.
`abstract 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.
`abstract @Nullable Object`	`@UnstableApi getCurrentManifest()` Returns the current manifest.
`abstract @Nullable MediaItem`	`getCurrentMediaItem()` Returns the currently playing `MediaItem`.
`abstract int`	`getCurrentMediaItemIndex()` Returns the index of the current `MediaItem` in the `timeline`, or the prospective index if the `current timeline` is empty.
`abstract int`	`getCurrentPeriodIndex()` Returns the index of the period currently being played.
`abstract 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.
`abstract Timeline`	`getCurrentTimeline()` Returns the current `Timeline`.
`abstract Tracks`	`getCurrentTracks()` Returns the current tracks.
`abstract int`	`@UnstableApi getCurrentWindowIndex()` This method is deprecated. Use `getCurrentMediaItemIndex` instead.
`abstract DeviceInfo`	`getDeviceInfo()` Gets the device information.
`abstract @IntRange(from = 0) int`	`getDeviceVolume()` Gets the current volume of the device.
`abstract long`	`getDuration()` Returns the duration of the current content or ad in milliseconds, or `TIME_UNSET` if the duration is not known.
`abstract long`	`getMaxSeekToPreviousPosition()` Returns the maximum position for which `seekToPrevious` seeks to the previous , in milliseconds.
`abstract MediaItem`	`getMediaItemAt(int index)` Returns the `MediaItem` at the given index.
`abstract int`	`getMediaItemCount()` Returns the number of `media items` in the playlist.
`abstract MediaMetadata`	`getMediaMetadata()` Returns the current combined `MediaMetadata`, or `EMPTY` if not supported.
`abstract 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.
`abstract int`	`@UnstableApi getNextWindowIndex()` This method is deprecated. Use `getNextMediaItemIndex` instead.
`abstract boolean`	`getPlayWhenReady()` Whether playback will proceed when `getPlaybackState` == `STATE_READY`.
`abstract PlaybackParameters`	`getPlaybackParameters()` Returns the currently active playback parameters.
`abstract int`	`@Player.State getPlaybackState()` Returns the current `playback state` of the player.
`abstract 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.
`abstract MediaMetadata`	`getPlaylistMetadata()` Returns the playlist `MediaMetadata`, as set by `setPlaylistMetadata`, or `EMPTY` if not supported.
`abstract 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.
`abstract int`	`@UnstableApi getPreviousWindowIndex()` This method is deprecated. Use `getPreviousMediaItemIndex` instead.
`abstract int`	`@Player.RepeatMode getRepeatMode()` Returns the current `RepeatMode` used for playback.
`abstract long`	`getSeekBackIncrement()` Returns the `seekBack` increment.
`abstract long`	`getSeekForwardIncrement()` Returns the `seekForward` increment.
`abstract boolean`	`getShuffleModeEnabled()` Returns whether shuffling of media items is enabled.
`abstract Size`	`@UnstableApi getSurfaceSize()` Gets the size of the surface on which the video is rendered.
`abstract long`	`getTotalBufferedDuration()` Returns an estimate of the total buffered duration from the current position, in milliseconds.
`abstract TrackSelectionParameters`	`getTrackSelectionParameters()` Returns the parameters constraining the track selection.
`abstract VideoSize`	`getVideoSize()` Gets the size of the video.
`abstract @FloatRange(from = 0, to = 1.0) float`	`getVolume()` Returns the audio volume, with 0 being silence and 1 being unity gain (signal unchanged).
`abstract boolean`	`hasNextMediaItem()` Returns whether a next `MediaItem` exists, which may depend on the current repeat mode and whether shuffle mode is enabled.
`abstract boolean`	`hasPreviousMediaItem()` Returns whether a previous media item exists, which may depend on the current repeat mode and whether shuffle mode is enabled.
`abstract void`	`increaseDeviceVolume()` This method is deprecated. Use `increaseDeviceVolume` instead.
`abstract void`	`increaseDeviceVolume(@C.VolumeFlags int flags)` Increases the volume of the device.
`abstract boolean`	`isCommandAvailable(@Player.Command int command)` Returns whether the provided `Command` is available.
`abstract boolean`	`isCurrentMediaItemDynamic()` Returns whether the current `MediaItem` is dynamic (may change when the `Timeline` is updated), or `false` if the `Timeline` is empty.
`abstract boolean`	`isCurrentMediaItemLive()` Returns whether the current `MediaItem` is live, or `false` if the `Timeline` is empty.
`abstract boolean`	`isCurrentMediaItemSeekable()` Returns whether the current `MediaItem` is seekable, or `false` if the is empty.
`abstract boolean`	`@UnstableApi isCurrentWindowDynamic()` This method is deprecated. Use `isCurrentMediaItemDynamic` instead.
`abstract boolean`	`@UnstableApi isCurrentWindowLive()` This method is deprecated. Use `isCurrentMediaItemLive` instead.
`abstract boolean`	`@UnstableApi isCurrentWindowSeekable()` This method is deprecated. Use `isCurrentMediaItemSeekable` instead.
`abstract boolean`	`isDeviceMuted()` Gets whether the device is muted or not.
`abstract boolean`	`isLoading()` Whether the player is currently loading the source.
`abstract boolean`	`isPlaying()` Returns whether the player is playing, i.e. `getCurrentPosition` is advancing.
`abstract boolean`	`isPlayingAd()` Returns whether the player is currently playing an ad.
`abstract void`	`moveMediaItem(int currentIndex, int newIndex)` Moves the media item at the current index to the new index.
`abstract void`	`moveMediaItems(int fromIndex, int toIndex, int newIndex)` Moves the media item range to the new index.
`abstract void`	`pause()` Pauses playback.
`abstract void`	`play()` Resumes playback as soon as `getPlaybackState` == `STATE_READY`.
`abstract void`	`prepare()` Prepares the player.
`abstract void`	`removeListener(Player.Listener listener)` Unregister a listener registered through `addListener`.
`abstract void`	`removeMediaItem(int index)` Removes the media item at the given index of the playlist.
`abstract void`	`removeMediaItems(int fromIndex, int toIndex)` Removes a range of media items from the playlist.
`abstract void`	`seekBack()` Seeks back in the current `MediaItem` by `getSeekBackIncrement` milliseconds.
`abstract void`	`seekForward()` Seeks forward in the current `MediaItem` by `getSeekForwardIncrement` milliseconds.
`abstract void`	`seekTo(long positionMs)` Seeks to a position specified in milliseconds in the current `MediaItem`.
`abstract void`	`seekTo(int mediaItemIndex, long positionMs)` Seeks to a position specified in milliseconds in the specified `MediaItem`.
`abstract void`	`seekToDefaultPosition()` Seeks to the default position associated with the current `MediaItem`.
`abstract void`	`seekToDefaultPosition(int mediaItemIndex)` Seeks to the default position associated with the specified `MediaItem`.
`abstract void`	`seekToNext()` Seeks to a later position in the current or next `MediaItem` (if available).
`abstract 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.
`abstract void`	`seekToPrevious()` Seeks to an earlier position in the current or previous `MediaItem` (if available).
`abstract 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.
`abstract void`	`setAudioAttributes( AudioAttributes audioAttributes, boolean handleAudioFocus )` Sets the attributes for audio playback, used by the underlying audio track.
`abstract void`	`setDeviceMuted(boolean muted)` This method is deprecated. Use `setDeviceMuted` instead.
`abstract void`	`setDeviceMuted(boolean muted, @C.VolumeFlags int flags)` Sets the mute state of the device.
`abstract void`	`setDeviceVolume(@IntRange(from = 0) int volume)` This method is deprecated. Use `setDeviceVolume` instead.
`abstract void`	`setDeviceVolume(@IntRange(from = 0) int volume, @C.VolumeFlags int flags)` Sets the volume of the device with volume flags.
`abstract void`	`setMediaItem(MediaItem mediaItem)` Clears the playlist, adds the specified `MediaItem` and resets the position to the default position.
`abstract void`	`setMediaItem(MediaItem mediaItem, boolean resetPosition)` Clears the playlist and adds the specified `MediaItem`.
`abstract void`	`setMediaItem(MediaItem mediaItem, long startPositionMs)` Clears the playlist and adds the specified `MediaItem`.
`abstract void`	`setMediaItems(List<MediaItem> mediaItems)` Clears the playlist, adds the specified `media items` and resets the position to the default position.
`abstract void`	`setMediaItems(List<MediaItem> mediaItems, boolean resetPosition)` Clears the playlist and adds the specified `media items`.
`abstract void`	`setMediaItems( List<MediaItem> mediaItems, int startIndex, long startPositionMs )` Clears the playlist and adds the specified `media items`.
`abstract void`	`setPlayWhenReady(boolean playWhenReady)` Sets whether playback should proceed when `getPlaybackState` == `STATE_READY`.
`abstract void`	`setPlaybackParameters(PlaybackParameters playbackParameters)` Attempts to set the playback parameters.
`abstract void`	`setPlaybackSpeed(@FloatRange(from = 0, fromInclusive = false) float speed)` Changes the rate at which playback occurs.
`abstract void`	`setPlaylistMetadata(MediaMetadata mediaMetadata)` Sets the playlist `MediaMetadata`.
`abstract void`	`setRepeatMode(@Player.RepeatMode int repeatMode)` Sets the `RepeatMode` to be used for playback.
`abstract void`	`setShuffleModeEnabled(boolean shuffleModeEnabled)` Sets whether shuffling of media items is enabled.
`abstract void`	`setTrackSelectionParameters(TrackSelectionParameters parameters)` Sets the parameters constraining the track selection.
`abstract void`	`setVideoSurface(@Nullable Surface surface)` Sets the `Surface` onto which video will be rendered.
`abstract void`	`setVideoSurfaceHolder(@Nullable SurfaceHolder surfaceHolder)` Sets the `SurfaceHolder` that holds the `Surface` onto which video will be rendered.
`abstract void`	`setVideoSurfaceView(@Nullable SurfaceView surfaceView)` Sets the `SurfaceView` onto which video will be rendered.
`abstract void`	`setVideoTextureView(@Nullable TextureView textureView)` Sets the `TextureView` onto which video will be rendered.
`abstract void`	`setVolume(@FloatRange(from = 0, to = 1.0) float volume)` Sets the audio volume, valid values are between 0 (silence) and 1 (unity gain, signal unchanged), inclusive.
`abstract void`	`stop()` Stops playback without resetting the playlist.

Constants

DEFAULT_DETACH_SURFACE_TIMEOUT_MS

@UnstableApi
default static final long DEFAULT_DETACH_SURFACE_TIMEOUT_MS = 2000

The default timeout for detaching a surface from the player, in milliseconds.

DEFAULT_RELEASE_TIMEOUT_MS

@UnstableApi
default static final long DEFAULT_RELEASE_TIMEOUT_MS = 500

The default timeout for calls to release and setForegroundMode, in milliseconds.

Public methods

addAnalyticsListener

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

addAudioOffloadListener

@UnstableApi
abstract 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.

addMediaSource

@UnstableApi
abstract void addMediaSource(MediaSource mediaSource)

Adds a media source to the end of the playlist.

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

addMediaSource

@UnstableApi
abstract 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

@UnstableApi
abstract 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

@UnstableApi
abstract 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.

clearAuxEffectInfo

@UnstableApi
abstract void clearAuxEffectInfo()

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

clearCameraMotionListener

@UnstableApi
abstract 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

@UnstableApi
abstract 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.

createMessage

@UnstableApi
abstract 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.

getAnalyticsCollector

@UnstableApi
abstract AnalyticsCollector getAnalyticsCollector()

Returns the AnalyticsCollector used for collecting analytics events.

getAudioDecoderCounters

@UnstableApi
abstract @Nullable DecoderCounters getAudioDecoderCounters()

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

getAudioFormat

@UnstableApi
abstract @Nullable Format getAudioFormat()

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

getAudioSessionId

@UnstableApi
abstract int getAudioSessionId()

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

See also
`onAudioSessionIdChanged`

getClock

@UnstableApi
abstract Clock getClock()

Returns the Clock used for playback.

This method can be called from any thread.

getCurrentTrackGroups

@UnstableApi
abstract TrackGroupArray getCurrentTrackGroups()

Returns the available track groups.

See also
`onTracksChanged`

getCurrentTrackSelections

@UnstableApi
abstract TrackSelectionArray getCurrentTrackSelections()

Returns the current track selections for each renderer, which may include null elements if some renderers do not have any selected tracks.

See also
`onTracksChanged`

getPauseAtEndOfMediaItems

@UnstableApi
abstract boolean getPauseAtEndOfMediaItems()

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

See also
`setPauseAtEndOfMediaItems`

getPlaybackLooper

@UnstableApi
abstract Looper getPlaybackLooper()

Returns the Looper associated with the playback thread.

This method may be called from any thread.

getPlayerError

abstract @Nullable ExoPlaybackException getPlayerError()

Equivalent to getPlayerError, except the exception is guaranteed to be an ExoPlaybackException.

getPreloadConfiguration

@UnstableApi
abstract ExoPlayer.PreloadConfiguration getPreloadConfiguration()

Returns the preload configuration.

getRenderer

@UnstableApi
abstract 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

@UnstableApi
abstract int getRendererCount()

Returns the number of renderers.

getRendererType

@UnstableApi
@C.TrackType
abstract 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.

getScrubbingModeParameters

@UnstableApi
abstract ScrubbingModeParameters getScrubbingModeParameters()

Gets the parameters that control behavior in scrubbing mode.

getSecondaryRenderer

@UnstableApi
default @Nullable Renderer getSecondaryRenderer(int index)

Returns the secondary renderer at the given index.

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

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

getSeekParameters

@UnstableApi
abstract SeekParameters getSeekParameters()

Returns the currently active SeekParameters of the player.

getSkipSilenceEnabled

@UnstableApi
abstract boolean getSkipSilenceEnabled()

Returns whether skipping silences in the audio stream is enabled.

See also
`onSkipSilenceEnabledChanged`

getTrackSelector

@UnstableApi
abstract @Nullable TrackSelector getTrackSelector()

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

getVideoChangeFrameRateStrategy

@UnstableApi
@C.VideoChangeFrameRateStrategy
abstract int getVideoChangeFrameRateStrategy()

Returns the C.VideoChangeFrameRateStrategy.

getVideoDecoderCounters

@UnstableApi
abstract @Nullable DecoderCounters getVideoDecoderCounters()

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

getVideoFormat

@UnstableApi
abstract @Nullable Format getVideoFormat()

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

getVideoScalingMode

@UnstableApi
@C.VideoScalingMode
abstract int getVideoScalingMode()

Returns the C.VideoScalingMode.

isReleased

@UnstableApi
abstract boolean isReleased()

Returns whether release has been called on the player.

This method is allowed to be called after release.

isScrubbingModeEnabled

@UnstableApi
abstract boolean isScrubbingModeEnabled()

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

See setScrubbingModeEnabled.

isSleepingForOffload

@UnstableApi
abstract 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

@UnstableApi
abstract boolean isTunnelingEnabled()

Returns whether tunneling is enabled for the currently selected tracks.

See also
`onTracksChanged`

prepare

@UnstableApi
abstract void prepare(MediaSource mediaSource)

prepare

@UnstableApi
abstract void prepare(
    MediaSource mediaSource,
    boolean resetPosition,
    boolean resetState
)

release

abstract 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 * #getAvailableCommands() available.

The exception to the above rule is isReleased which can be called on a released player.

removeAnalyticsListener

abstract void removeAnalyticsListener(AnalyticsListener listener)

Removes an AnalyticsListener.

Parameters
`AnalyticsListener listener`	The listener to be removed.

removeAudioOffloadListener

@UnstableApi
abstract void removeAudioOffloadListener(ExoPlayer.AudioOffloadListener listener)

Removes a listener of audio offload events.

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

replaceMediaItem

abstract void replaceMediaItem(int index, MediaItem mediaItem)

Replaces the media item at the given index 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 * #getAvailableCommands() available.

ExoPlayer will keep the existing MediaSource for this MediaItem if supported by the MediaSource. If the current item is replaced, this will also not interrupt the ongoing playback.

replaceMediaItems

abstract 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 * #getAvailableCommands() 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.

ExoPlayer will keep the existing MediaSource instances for the new MediaItems if supported by all of these instances. If the current item is replaced, this will also not interrupt the ongoing playback.

setAudioSessionId

@UnstableApi
abstract 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 for API 21+.

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

setAuxEffectInfo

@UnstableApi
abstract void setAuxEffectInfo(AuxEffectInfo auxEffectInfo)

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

setCameraMotionListener

@UnstableApi
abstract void setCameraMotionListener(CameraMotionListener listener)

Sets a listener of camera motion events.

Parameters
`CameraMotionListener listener`	The listener.

setForegroundMode

@UnstableApi
abstract 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

abstract 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

@UnstableApi
abstract 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.

setMediaSource

@UnstableApi
abstract 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

@UnstableApi
abstract 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

@UnstableApi
abstract 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

@UnstableApi
abstract 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

@UnstableApi
abstract 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

@UnstableApi
abstract 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

@UnstableApi
abstract 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.

setPreferredAudioDevice

@UnstableApi
@RequiresApi(value = 23)
abstract 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

@UnstableApi
abstract void setPreloadConfiguration(
    ExoPlayer.PreloadConfiguration preloadConfiguration
)

Sets the preload configuration to configure playlist preloading.

Parameters
`ExoPlayer.PreloadConfiguration preloadConfiguration`	The preload configuration.

setPriority

@UnstableApi
abstract 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

@UnstableApi
abstract 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.

setScrubbingModeEnabled

@UnstableApi
abstract 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

@UnstableApi
abstract void setScrubbingModeParameters(
    ScrubbingModeParameters scrubbingModeParameters
)

Sets the parameters that control behavior in scrubbing mode.

setSeekParameters

@UnstableApi
abstract 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.

setShuffleOrder

@UnstableApi
abstract 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

@UnstableApi
abstract 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.

setVideoChangeFrameRateStrategy

@UnstableApi
abstract 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`.

setVideoEffects

@UnstableApi
abstract 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

@UnstableApi
abstract 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

@UnstableApi
abstract 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`.

setWakeMode

abstract 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 / ) 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.

ExoPlayer

Player components

Threading model

Summary

Nested types

Constants

Public methods

Inherited Constants

Inherited methods

Constants

DEFAULT_DETACH_SURFACE_TIMEOUT_MS

DEFAULT_RELEASE_TIMEOUT_MS

Public methods

addAnalyticsListener

addAudioOffloadListener

addMediaSource

addMediaSource

addMediaSources

addMediaSources

clearAuxEffectInfo

clearCameraMotionListener

clearVideoFrameMetadataListener

createMessage

getAnalyticsCollector

getAudioDecoderCounters

getAudioFormat

getAudioSessionId

getClock

getCurrentTrackGroups

getCurrentTrackSelections

getPauseAtEndOfMediaItems

getPlaybackLooper

getPlayerError

getPreloadConfiguration

getRenderer

getRendererCount

getRendererType

getScrubbingModeParameters

getSecondaryRenderer

getSeekParameters

getSkipSilenceEnabled

getTrackSelector

getVideoChangeFrameRateStrategy

getVideoDecoderCounters

getVideoFormat

getVideoScalingMode

isReleased

isScrubbingModeEnabled

isSleepingForOffload

isTunnelingEnabled

prepare

prepare

release

removeAnalyticsListener

removeAudioOffloadListener

replaceMediaItem

replaceMediaItems

setAudioSessionId

setAuxEffectInfo

setCameraMotionListener

setForegroundMode

setHandleAudioBecomingNoisy

setImageOutput

setMediaSource

setMediaSource

setMediaSource

setMediaSources

setMediaSources

setMediaSources

setPauseAtEndOfMediaItems

setPreferredAudioDevice

setPreloadConfiguration

setPriority

setPriorityTaskManager

setScrubbingModeEnabled

setScrubbingModeParameters

setSeekParameters

setShuffleOrder

setSkipSilenceEnabled

setVideoChangeFrameRateStrategy