ExoPlayer

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

interface ExoPlayer : 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 Builder.

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 (DefaultLoadControl) 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 interface ExoPlayer.AudioOffloadListener` A listener for audio offload events.
`class ExoPlayer.Builder` A builder for `ExoPlayer` instances.
`@UnstableApi class ExoPlayer.PreloadConfiguration` Configuration options for preloading playlist items.

Constants
`const Long`	`@UnstableApi DEFAULT_DETACH_SURFACE_TIMEOUT_MS = 2000` The default timeout for detaching a surface from the player, in milliseconds.
`const Long`	`@UnstableApi DEFAULT_RELEASE_TIMEOUT_MS = 500` The default timeout for calls to `release` and `setForegroundMode`, in milliseconds.
`const Int`	`@UnstableApi DEFAULT_STUCK_BUFFERING_DETECTION_TIMEOUT_MS = 600000` The default timeout for detecting whether playback is stuck buffering, in milliseconds.
`const Int`	`@UnstableApi DEFAULT_STUCK_PLAYING_DETECTION_TIMEOUT_MS` The default timeout for detecting whether playback is stuck playing, in milliseconds.
`const 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.
`const Int`	`@UnstableApi DEFAULT_STUCK_SUPPRESSED_DETECTION_TIMEOUT_MS = 600000` The default timeout for detecting whether playback is stuck in a suppressed state, in milliseconds.

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

Inherited Constants

From androidx.media3.common.Player

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

From androidx.media3.common.Player

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

Constants

DEFAULT_DETACH_SURFACE_TIMEOUT_MS

@UnstableApi
const val DEFAULT_DETACH_SURFACE_TIMEOUT_MS = 2000: Long

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

DEFAULT_RELEASE_TIMEOUT_MS

@UnstableApi
const val DEFAULT_RELEASE_TIMEOUT_MS = 500: Long

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

DEFAULT_STUCK_BUFFERING_DETECTION_TIMEOUT_MS

@UnstableApi
const val DEFAULT_STUCK_BUFFERING_DETECTION_TIMEOUT_MS = 600000: Int

The default timeout for detecting whether playback is stuck buffering, in milliseconds.

DEFAULT_STUCK_PLAYING_DETECTION_TIMEOUT_MS

@UnstableApi
const val DEFAULT_STUCK_PLAYING_DETECTION_TIMEOUT_MS: Int

The default timeout for detecting whether playback is stuck playing, in milliseconds.

DEFAULT_STUCK_PLAYING_NOT_ENDING_TIMEOUT_MS

@UnstableApi
const val DEFAULT_STUCK_PLAYING_NOT_ENDING_TIMEOUT_MS = 60000: Int

The default timeout for detecting whether playback is stuck playing but not ending, in milliseconds.

DEFAULT_STUCK_SUPPRESSED_DETECTION_TIMEOUT_MS

@UnstableApi
const val DEFAULT_STUCK_SUPPRESSED_DETECTION_TIMEOUT_MS = 600000: Int

The default timeout for detecting whether playback is stuck in a suppressed state, in milliseconds.

Public functions

addAnalyticsListener

fun addAnalyticsListener(listener: AnalyticsListener!): Unit

Adds an AnalyticsListener to receive analytics events.

This method can be called from any thread.

Parameters
`listener: AnalyticsListener!`	The listener to be added.

addAudioOffloadListener

@UnstableApi
fun addAudioOffloadListener(listener: ExoPlayer.AudioOffloadListener!): Unit

Adds a listener to receive audio offload events.

This method can be called from any thread.

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

addMediaSource

@UnstableApi
fun addMediaSource(mediaSource: MediaSource!): Unit

Adds a media source to the end of the playlist.

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

addMediaSource

@UnstableApi
fun addMediaSource(index: Int, mediaSource: MediaSource!): Unit

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

Parameters
`index: Int`	The index at which to add the source.
`mediaSource: MediaSource!`	The `MediaSource` to add.

addMediaSources

@UnstableApi
fun addMediaSources(mediaSources: (Mutable)List<MediaSource!>!): Unit

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

Parameters
`mediaSources: (Mutable)List<MediaSource!>!`	The `MediaSources` to add.

addMediaSources

@UnstableApi
fun addMediaSources(index: Int, mediaSources: (Mutable)List<MediaSource!>!): Unit

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

Parameters
`index: Int`	The index at which to add the media sources.
`mediaSources: (Mutable)List<MediaSource!>!`	The `MediaSources` to add.

clearAuxEffectInfo

@UnstableApi
fun clearAuxEffectInfo(): Unit

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

clearCameraMotionListener

@UnstableApi
fun clearCameraMotionListener(listener: CameraMotionListener!): Unit

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

Parameters
`listener: CameraMotionListener!`	The listener to clear.

clearVideoFrameMetadataListener

@UnstableApi
fun clearVideoFrameMetadataListener(listener: VideoFrameMetadataListener!): Unit

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

Parameters
`listener: VideoFrameMetadataListener!`	The listener to clear.

createMessage

@UnstableApi
fun createMessage(target: PlayerMessage.Target!): PlayerMessage!

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
fun getAnalyticsCollector(): AnalyticsCollector!

Returns the AnalyticsCollector used for collecting analytics events.

getAudioDecoderCounters

@UnstableApi
fun getAudioDecoderCounters(): DecoderCounters?

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

getAudioFormat

@UnstableApi
fun getAudioFormat(): Format?

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

getClock

@UnstableApi
fun getClock(): Clock!

Returns the Clock used for playback.

This method can be called from any thread.

getCurrentTrackGroups

@UnstableApi
fun getCurrentTrackGroups(): TrackGroupArray!

Returns the available track groups.

See also
`onTracksChanged`

getCurrentTrackSelections

@UnstableApi
fun getCurrentTrackSelections(): TrackSelectionArray!

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
fun getPauseAtEndOfMediaItems(): Boolean

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

See also
`setPauseAtEndOfMediaItems`

getPlaybackLooper

@UnstableApi
fun getPlaybackLooper(): Looper!

Returns the Looper associated with the playback thread.

This method may be called from any thread.

getPlayerError

fun getPlayerError(): ExoPlaybackException?

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

getPreloadConfiguration

@UnstableApi
fun getPreloadConfiguration(): ExoPlayer.PreloadConfiguration!

Returns the preload configuration.

getRenderer

@UnstableApi
fun getRenderer(index: Int): Renderer!

Returns the renderer at the given index.

Parameters
`index: Int`	The index of the renderer.

Returns
`Renderer!`	The renderer at this index.

getRendererCount

@UnstableApi
fun getRendererCount(): Int

Returns the number of renderers.

getRendererType

@UnstableApi
@C.TrackType
fun getRendererType(index: Int): Int

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
`index: Int`	The index of the renderer.

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

getScrubbingModeParameters

@UnstableApi
fun getScrubbingModeParameters(): ScrubbingModeParameters!

Gets the parameters that control behavior in scrubbing mode.

getSecondaryRenderer

@UnstableApi
fun getSecondaryRenderer(index: Int): Renderer?

Returns the secondary renderer at the given index.

Parameters
`index: Int`	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.

getSeekParameters

@UnstableApi
fun getSeekParameters(): SeekParameters!

Returns the currently active SeekParameters of the player.

getShuffleOrder

@UnstableApi
fun getShuffleOrder(): ShuffleOrder!

Returns the shuffle order.

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

getSkipSilenceEnabled

@UnstableApi
fun getSkipSilenceEnabled(): Boolean

Returns whether skipping silences in the audio stream is enabled.

See also
`onSkipSilenceEnabledChanged`

getTrackSelector

@UnstableApi
fun getTrackSelector(): TrackSelector?

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

getVideoChangeFrameRateStrategy

@UnstableApi
@C.VideoChangeFrameRateStrategy
fun getVideoChangeFrameRateStrategy(): Int

Returns the C.VideoChangeFrameRateStrategy.

getVideoDecoderCounters

@UnstableApi
fun getVideoDecoderCounters(): DecoderCounters?

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

getVideoFormat

@UnstableApi
fun getVideoFormat(): Format?

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

getVideoScalingMode

@UnstableApi
@C.VideoScalingMode
fun getVideoScalingMode(): Int

Returns the C.VideoScalingMode.

isReleased

@UnstableApi
fun isReleased(): Boolean

Returns whether release has been called on the player.

This method is allowed to be called after release.

isScrubbingModeEnabled

@UnstableApi
fun isScrubbingModeEnabled(): Boolean

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

See setScrubbingModeEnabled.

isSleepingForOffload

@UnstableApi
fun isSleepingForOffload(): Boolean

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
fun isTunnelingEnabled(): Boolean

Returns whether tunneling is enabled for the currently selected tracks.

See also
`onTracksChanged`

prepare

@UnstableApi
fun prepare(mediaSource: MediaSource!): Unit

prepare

@UnstableApi
fun prepare(
    mediaSource: MediaSource!,
    resetPosition: Boolean,
    resetState: Boolean
): Unit

release

fun release(): Unit

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

fun removeAnalyticsListener(listener: AnalyticsListener!): Unit

Removes an AnalyticsListener.

Parameters
`listener: AnalyticsListener!`	The listener to be removed.

removeAudioOffloadListener

@UnstableApi
fun removeAudioOffloadListener(listener: ExoPlayer.AudioOffloadListener!): Unit

Removes a listener of audio offload events.

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

replaceMediaItem

fun replaceMediaItem(index: Int, mediaItem: MediaItem!): Unit

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

fun replaceMediaItems(
    fromIndex: Int,
    toIndex: Int,
    mediaItems: (Mutable)List<MediaItem!>!
): Unit

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 MediaSource instances. If the current item is replaced, this will also not interrupt the ongoing playback.

setAudioSessionId

@UnstableApi
fun setAudioSessionId(audioSessionId: Int): Unit

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
`audioSessionId: Int`	The audio session ID, or `AUDIO_SESSION_ID_UNSET` if it should be generated by the framework.

setAuxEffectInfo

@UnstableApi
fun setAuxEffectInfo(auxEffectInfo: AuxEffectInfo!): Unit

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

setCameraMotionListener

@UnstableApi
fun setCameraMotionListener(listener: CameraMotionListener!): Unit

Sets a listener of camera motion events.

Parameters
`listener: CameraMotionListener!`	The listener.

setForegroundMode

@UnstableApi
fun setForegroundMode(foregroundMode: Boolean): Unit

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
`foregroundMode: Boolean`	Whether the player is allowed to keep limited resources even when in the idle state.

setHandleAudioBecomingNoisy

fun setHandleAudioBecomingNoisy(handleAudioBecomingNoisy: Boolean): Unit

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
`handleAudioBecomingNoisy: Boolean`	Whether the player should pause automatically when audio is rerouted from a headset to device speakers.

setImageOutput

@UnstableApi
fun setImageOutput(imageOutput: ImageOutput?): Unit

Sets the ImageOutput where rendered images will be forwarded.

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

setMaxSeekToPreviousPositionMs

@UnstableApi
fun setMaxSeekToPreviousPositionMs(
    maxSeekToPreviousPositionMs: @IntRange(from = 0) Long
): Unit

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

Parameters
`maxSeekToPreviousPositionMs: @IntRange(from = 0) Long`	The maximum position, in milliseconds.

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

setMediaSource

@UnstableApi
fun setMediaSource(mediaSource: MediaSource!): Unit

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

Parameters
`mediaSource: MediaSource!`	The new `MediaSource`.

setMediaSource

@UnstableApi
fun setMediaSource(mediaSource: MediaSource!, resetPosition: Boolean): Unit

Clears the playlist and adds the specified MediaSource.

Parameters
`mediaSource: MediaSource!`	The new `MediaSource`.
`resetPosition: Boolean`	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
fun setMediaSource(mediaSource: MediaSource!, startPositionMs: Long): Unit

Clears the playlist and adds the specified MediaSource.

Parameters
`mediaSource: MediaSource!`	The new `MediaSource`.
`startPositionMs: Long`	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
fun setMediaSources(mediaSources: (Mutable)List<MediaSource!>!): Unit

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

Parameters
`mediaSources: (Mutable)List<MediaSource!>!`	The new `MediaSources`.

setMediaSources

@UnstableApi
fun setMediaSources(
    mediaSources: (Mutable)List<MediaSource!>!,
    resetPosition: Boolean
): Unit

Clears the playlist and adds the specified MediaSources.

Parameters
`mediaSources: (Mutable)List<MediaSource!>!`	The new `MediaSources`.
`resetPosition: Boolean`	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
fun setMediaSources(
    mediaSources: (Mutable)List<MediaSource!>!,
    startMediaItemIndex: Int,
    startPositionMs: Long
): Unit

Clears the playlist and adds the specified MediaSources.

Parameters
`mediaSources: (Mutable)List<MediaSource!>!`	The new `MediaSources`.
`startMediaItemIndex: Int`	The media item index to start playback from. If `INDEX_UNSET` is passed, the current position is not reset.
`startPositionMs: Long`	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
fun setPauseAtEndOfMediaItems(pauseAtEndOfMediaItems: Boolean): Unit

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
`pauseAtEndOfMediaItems: Boolean`	Whether to pause playback at the end of each media item.

setPreferredAudioDevice

@UnstableApi
fun setPreferredAudioDevice(audioDeviceInfo: AudioDeviceInfo?): Unit

Sets the preferred audio device.

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

setPreloadConfiguration

@UnstableApi
fun setPreloadConfiguration(
    preloadConfiguration: ExoPlayer.PreloadConfiguration!
): Unit

Sets the preload configuration to configure playlist preloading.

Parameters
`preloadConfiguration: ExoPlayer.PreloadConfiguration!`	The preload configuration.

setPriority

@UnstableApi
fun setPriority(@C.Priority priority: Int): Unit

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 priority: Int`	The `C.Priority`.

setPriorityTaskManager

@UnstableApi
fun setPriorityTaskManager(priorityTaskManager: PriorityTaskManager?): Unit

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
`priorityTaskManager: PriorityTaskManager?`	The `PriorityTaskManager`, or null to clear a previously set priority task manager.

setScrubbingModeEnabled

@UnstableApi
fun setScrubbingModeEnabled(scrubbingModeEnabled: Boolean): Unit

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
`scrubbingModeEnabled: Boolean`	Whether scrubbing mode should be enabled.

setScrubbingModeParameters

@UnstableApi
fun setScrubbingModeParameters(
    scrubbingModeParameters: ScrubbingModeParameters!
): Unit

Sets the parameters that control behavior in scrubbing mode.

setSeekBackIncrementMs

@UnstableApi
fun setSeekBackIncrementMs(seekBackIncrementMs: @IntRange(from = 1) Long): Unit

Sets the seekBack increment.

Parameters
`seekBackIncrementMs: @IntRange(from = 1) Long`	The seek back increment, in milliseconds.

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

setSeekForwardIncrementMs

@UnstableApi
fun setSeekForwardIncrementMs(seekForwardIncrementMs: @IntRange(from = 1) Long): Unit

Sets the seekForward increment.

Parameters
`seekForwardIncrementMs: @IntRange(from = 1) Long`	The seek forward increment, in milliseconds.

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

setSeekParameters

@UnstableApi
fun setSeekParameters(seekParameters: SeekParameters?): Unit

Sets the parameters that control how seek operations are performed.

Parameters
`seekParameters: SeekParameters?`	The seek parameters, or `null` to use the defaults.

setShuffleOrder

@UnstableApi
fun setShuffleOrder(shuffleOrder: ShuffleOrder!): Unit

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
fun setSkipSilenceEnabled(skipSilenceEnabled: Boolean): Unit

Sets whether skipping silences in the audio stream is enabled.

Parameters
`skipSilenceEnabled: Boolean`	Whether skipping silences in the audio stream is enabled.

setVideoChangeFrameRateStrategy

@UnstableApi
fun setVideoChangeFrameRateStrategy(
    @C.VideoChangeFrameRateStrategy videoChangeFrameRateStrategy: Int
): Unit

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 videoChangeFrameRateStrategy: Int`	A `C.VideoChangeFrameRateStrategy`.

setVideoEffects

@UnstableApi
fun setVideoEffects(videoEffects: (Mutable)List<Effect!>!): Unit

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
`videoEffects: (Mutable)List<Effect!>!`	The `List` of `video effects` to apply.

setVideoFrameMetadataListener

@UnstableApi
fun setVideoFrameMetadataListener(listener: VideoFrameMetadataListener!): Unit

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
`listener: VideoFrameMetadataListener!`	The listener.

setVideoScalingMode

@UnstableApi
fun setVideoScalingMode(@C.VideoScalingMode videoScalingMode: Int): Unit

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 videoScalingMode: Int`	The `C.VideoScalingMode`.

setVirtualDeviceId

@UnstableApi
fun setVirtualDeviceId(virtualDeviceId: Int): Unit

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
`virtualDeviceId: Int`	The `virtual device id`, or `INDEX_UNSET` if unspecified.

setWakeMode

fun setWakeMode(@C.WakeMode wakeMode: Int): Unit

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 wakeMode: Int`	The `C.WakeMode` option to keep the device awake during playback.

ExoPlayer

Player components

Threading model

Summary

Nested types

Constants

Public functions

Inherited Constants

Inherited functions

Constants

DEFAULT_DETACH_SURFACE_TIMEOUT_MS

DEFAULT_RELEASE_TIMEOUT_MS

DEFAULT_STUCK_BUFFERING_DETECTION_TIMEOUT_MS

DEFAULT_STUCK_PLAYING_DETECTION_TIMEOUT_MS

DEFAULT_STUCK_PLAYING_NOT_ENDING_TIMEOUT_MS

DEFAULT_STUCK_SUPPRESSED_DETECTION_TIMEOUT_MS

Public functions

addAnalyticsListener

addAudioOffloadListener

addMediaSource

addMediaSource

addMediaSources

addMediaSources

clearAuxEffectInfo

clearCameraMotionListener

clearVideoFrameMetadataListener

createMessage

getAnalyticsCollector

getAudioDecoderCounters

getAudioFormat

getClock

getCurrentTrackGroups

getCurrentTrackSelections

getPauseAtEndOfMediaItems

getPlaybackLooper

getPlayerError

getPreloadConfiguration

getRenderer

getRendererCount

getRendererType

getScrubbingModeParameters

getSecondaryRenderer

getSeekParameters

getShuffleOrder

getSkipSilenceEnabled

getTrackSelector

getVideoChangeFrameRateStrategy

getVideoDecoderCounters

getVideoFormat

getVideoScalingMode

isReleased

isScrubbingModeEnabled

isSleepingForOffload

isTunnelingEnabled

prepare

prepare

release

removeAnalyticsListener

removeAudioOffloadListener

replaceMediaItem

replaceMediaItems

setAudioSessionId

setAuxEffectInfo

setCameraMotionListener

setForegroundMode

setHandleAudioBecomingNoisy

setImageOutput

setMaxSeekToPreviousPositionMs

setMediaSource

setMediaSource

setMediaSource

setMediaSources

setMediaSources

setMediaSources

setPauseAtEndOfMediaItems

setPreferredAudioDevice

setPreloadConfiguration

setPriority

setPriorityTaskManager

setScrubbingModeEnabled