public interface ExoPlayer extends Player

Known direct subclasses
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

A listener for audio offload events.

public final class ExoPlayer.Builder

A builder for ExoPlayer instances.

Configuration options for preloading playlist items.

Constants

default static final long

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

default static final long

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

Public methods

abstract void

Adds an AnalyticsListener to receive analytics events.

abstract void

Adds a listener to receive audio offload events.

abstract void

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

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

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

abstract void

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

abstract void

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

abstract PlayerMessage

Creates a message that can be sent to a PlayerMessage.Target.

abstract AnalyticsCollector

Returns the AnalyticsCollector used for collecting analytics events.

abstract @Nullable DecoderCounters

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

abstract @Nullable Format

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

abstract int

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

abstract Clock

Returns the Clock used for playback.

abstract TrackGroupArray

This method is deprecated.

Use getCurrentTracks.

abstract TrackSelectionArray

This method is deprecated.

Use getCurrentTracks.

abstract boolean

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

abstract Looper

Returns the Looper associated with the playback thread.

abstract @Nullable ExoPlaybackException

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

abstract ExoPlayer.PreloadConfiguration

Returns the preload configuration.

abstract Renderer

Returns the renderer at the given index.

abstract int

Returns the number of renderers.

abstract int

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

default @Nullable Renderer

Returns the secondary renderer at the given index.

abstract SeekParameters

Returns the currently active SeekParameters of the player.

abstract boolean

Returns whether skipping silences in the audio stream is enabled.

abstract @Nullable TrackSelector

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

abstract int

Returns the C.VideoChangeFrameRateStrategy.

abstract @Nullable DecoderCounters

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

abstract @Nullable Format

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

abstract int

Returns the C.VideoScalingMode.

abstract boolean

Returns whether release has been called on the player.

abstract boolean

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

abstract boolean

Returns whether tunneling is enabled for the currently selected tracks.

abstract void

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

Releases the player.

abstract void

Removes an AnalyticsListener.

abstract void

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

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

abstract void

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

Sets the ImageOutput where rendered images will be forwarded.

abstract void

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

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

Sets the preferred audio device.

abstract void

Sets the preload configuration to configure playlist preloading.

abstract void

Sets the C.Priority for this player.

abstract void

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

abstract void

Sets the parameters that control how seek operations are performed.

abstract void

Sets the shuffle order.

abstract void
@UnstableApi
setSkipSilenceEnabled(boolean skipSilenceEnabled)

Sets whether skipping silences in the audio stream is enabled.

abstract void

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

abstract void

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

abstract void

Sets a listener to receive video frame metadata events.

abstract void

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

This field is deprecated.

Use COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS instead.

default static final int

Command to increase and decrease the device volume and mute it with volume flags.

default static final int

Command to change the media items in the playlist.

default static final int

Command to get the player current AudioAttributes.

default static final int

Command to get information about the currently playing MediaItem.

default static final int

Command to get the device volume and whether it is muted.

default static final int

This field is deprecated.

Use COMMAND_GET_METADATA instead.

default static final int

Command to get metadata related to the playlist and current MediaItem.

default static final int

Command to get the text that should currently be displayed by the player.

default static final int

Command to get the information about the current timeline.

default static final int

Command to get details of the current track selection.

default static final int

Command to get the player volume.

default static final int

Represents an invalid Command.

default static final int

Command to start, pause or resume playback.

default static final int

Command to prepare the player.

default static final int

Command to release the player.

default static final int

Command to seek back by a fixed increment inside the current MediaItem.

default static final int

Command to seek forward by a fixed increment inside the current MediaItem.

default static final int

Command to seek anywhere inside the current MediaItem.

default static final int

This field is deprecated.

Use COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM instead.

default static final int

Command to seek to the default position of the current MediaItem.

default static final int

Command to seek anywhere in any MediaItem.

default static final int

Command to seek to a later position in the current MediaItem or the default position of the next MediaItem.

default static final int

Command to seek to the default position of the next MediaItem.

default static final int

This field is deprecated.

Use COMMAND_SEEK_TO_NEXT_MEDIA_ITEM instead.

default static final int

Command to seek to an earlier position in the current MediaItem or the default position of the previous MediaItem.

default static final int

Command to seek to the default position of the previous MediaItem.

default static final int

This field is deprecated.

Use COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM instead.

default static final int

This field is deprecated.

Use COMMAND_SEEK_TO_MEDIA_ITEM instead.

default static final int

Command to set the player's audio attributes.

default static final int

This field is deprecated.

Use COMMAND_SET_DEVICE_VOLUME_WITH_FLAGS instead.

default static final int

Command to set the device volume with volume flags.

default static final int

Command to set a MediaItem.

default static final int

This field is deprecated.

Use COMMAND_SET_PLAYLIST_METADATA instead.

default static final int

Command to set the playlist metadata.

default static final int

Command to set the repeat mode.

default static final int

Command to enable shuffling.

default static final int

Command to set the playback speed and pitch.

default static final int

Command to set the player's track selection parameters.

default static final int

Command to set and clear the surface on which to render the video.

default static final int

Command to set the player volume.

default static final int

Command to stop playback.

default static final int

Automatic playback transition from one period in the timeline to the next.

default static final int

Discontinuity introduced internally (e.g. by the source).

default static final int

Discontinuity caused by the removal of the current period from the Timeline.

default static final int

Seek within the current period or to another period.

default static final int

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 introduced by a skipped silence.

default static final int

Discontinuity introduced by a skipped period (for instance a skipped ad).

default static final int

getAudioAttributes changed.

default static final int

The audio session id was set.

default static final int

isCommandAvailable changed for at least one Command.

default static final int

getCurrentCues changed.

default static final int

getDeviceInfo changed.

default static final int

getDeviceVolume changed.

default static final int

isLoading ()} changed.

default static final int

isPlaying changed.

default static final int

getMaxSeekToPreviousPosition changed.

default static final int

getCurrentMediaItem changed or the player started repeating the current item.

default static final int

getMediaMetadata changed.

default static final int

Metadata associated with the current playback time changed.

default static final int

getPlaybackParameters changed.

default static final int

getPlaybackState changed.

default static final int

getPlaybackSuppressionReason changed.

default static final int

getPlayerError changed.

default static final int

getPlaylistMetadata changed.

default static final int

getPlayWhenReady changed.

default static final int

A position discontinuity occurred.

default static final int

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

getRepeatMode changed.

default static final int

getSeekBackIncrement changed.

default static final int

getSeekForwardIncrement changed.

default static final int

getShuffleModeEnabled changed.

default static final int

Skipping silences in the audio stream is enabled or disabled.

default static final int

The size of the surface onto which the video is being rendered changed.

default static final int

getCurrentTimeline changed.

default static final int

getCurrentTracks changed.

default static final int

getTrackSelectionParameters changed.

default static final int

getVideoSize changed.

default static final int

getVolume changed.

default static final int

Playback has automatically transitioned to the next media item.

default static final int

The current media item has changed because of a change in the playlist.

default static final int

The media item has been repeated.

default static final int

A seek to another media item has occurred.

default static final int

Playback is not suppressed.

default static final int

Playback is suppressed due to transient audio focus loss.

default static final int

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

This field is deprecated.

Use PLAYBACK_SUPPRESSION_REASON_UNSUITABLE_AUDIO_OUTPUT instead.

default static final int

Playback has been paused to avoid becoming noisy.

default static final int

Playback has been paused because of a loss of audio focus.

default static final int

Playback has been paused at the end of a media item.

default static final int

Playback has been started or paused because of a remote change.

default static final int

Playback has been paused because playback has been suppressed too long.

default static final int

Playback has been started or paused by a call to setPlayWhenReady.

default static final int

Repeats the entire timeline infinitely.

default static final int

Normal playback without repetition.

default static final int

Repeats the currently playing MediaItem infinitely during ongoing playback.

default static final int

The player is not able to immediately play the media, but is doing work toward being able to do so.

default static final int

The player has finished playing the media.

default static final int

The player is idle, meaning it holds only limited resources.

default static final int

The player is able to immediately play from its current position.

default static final int

Timeline changed as a result of a change of the playlist items or the order of the items.

default static final int

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

Registers a listener to receive all events from the player.

abstract void

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

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

Returns whether the player can be used to advertise a media session.

abstract void

Clears the playlist.

abstract void

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

abstract void

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

abstract void

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

abstract void

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

abstract void

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

abstract void

This method is deprecated.

Use decreaseDeviceVolume instead.

abstract void

Decreases the volume of the device.

abstract Looper

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

abstract AudioAttributes

Returns the attributes for audio playback.

abstract Player.Commands

Returns the player's currently available Commands.

abstract @IntRange(from = 0, to = 100) int

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

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

abstract long

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

If isPlayingAd returns true, returns the duration of the current content in milliseconds, or TIME_UNSET if the duration is not known.

abstract long

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

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

abstract int

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

abstract CueGroup

Returns the current CueGroup.

abstract long

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

Returns the current manifest.

abstract @Nullable MediaItem

Returns the currently playing MediaItem.

abstract int

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

abstract int

Returns the index of the period currently being played.

abstract long

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

Returns the current Timeline.

abstract Tracks

Returns the current tracks.

abstract int

This method is deprecated.

Use getCurrentMediaItemIndex instead.

abstract DeviceInfo

Gets the device information.

abstract @IntRange(from = 0) int

Gets the current volume of the device.

abstract long

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

abstract long

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

Returns the number of media items in the playlist.

abstract MediaMetadata

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

abstract int

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

This method is deprecated.

Use getNextMediaItemIndex instead.

abstract boolean

Whether playback will proceed when getPlaybackState == STATE_READY.

abstract PlaybackParameters

Returns the currently active playback parameters.

abstract int

Returns the current playback state of the player.

abstract int

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

abstract MediaMetadata

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

abstract int

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

This method is deprecated.

Use getPreviousMediaItemIndex instead.

abstract int

Returns the current RepeatMode used for playback.

abstract long

Returns the seekBack increment.

abstract long

Returns the seekForward increment.

abstract boolean

Returns whether shuffling of media items is enabled.

abstract Size

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

abstract long

Returns an estimate of the total buffered duration from the current position, in milliseconds.

abstract TrackSelectionParameters

Returns the parameters constraining the track selection.

abstract VideoSize

Gets the size of the video.

abstract @FloatRange(from = 0, to = 1.0) float

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

abstract boolean

This method is deprecated.

Use hasNextMediaItem instead.

abstract boolean

Returns whether a next MediaItem exists, which may depend on the current repeat mode and whether shuffle mode is enabled.

abstract boolean
@