SimpleExoPlayer


@UnstableApi
class SimpleExoPlayer : BasePlayer, ExoPlayer, ExoPlayer.AudioComponent, ExoPlayer.VideoComponent, ExoPlayer.TextComponent, ExoPlayer.DeviceComponent


Summary

Nested types

This class is deprecated.

Use ExoPlayer.Builder instead.

Protected constructors

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

This function is deprecated.

Use the ExoPlayer.Builder.

Public functions

Unit

Adds an AnalyticsListener to receive analytics events.

Unit

Adds a listener to receive audio offload events.

Unit

Registers a listener to receive all events from the player.

Unit
addMediaItems(index: Int, mediaItems: (Mutable)List<MediaItem!>!)

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

Unit
addMediaSource(mediaSource: MediaSource!)

Adds a media source to the end of the playlist.

Unit
addMediaSource(index: Int, mediaSource: MediaSource!)

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

Unit

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

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

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

Unit

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

Unit

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

Unit

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

Unit

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

Unit

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

Unit

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

Unit

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

Unit

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

PlayerMessage!

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

Unit

This function is deprecated.

Use decreaseDeviceVolume instead.

Unit

Decreases the volume of the device.

AnalyticsCollector!

Returns the AnalyticsCollector used for collecting analytics events.

Looper!

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

AudioAttributes!

Returns the attributes for audio playback.

ExoPlayer.AudioComponent?

This function is deprecated.

Use ExoPlayer, as the AudioComponent methods are defined by that interface.

DecoderCounters?

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

Format?

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

Int

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

Player.Commands!

Returns the player's currently available Commands.

Long

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

Clock!

Returns the Clock used for playback.

Long

If isPlayingAd returns true, returns an estimate of the content position in the current content up to which data is buffered, in milliseconds.

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.

Int

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

Int

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

CueGroup!

Returns the current CueGroup.

Int

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

Int

Returns the index of the period currently being played.

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.

Timeline!

Returns the current Timeline.

TrackGroupArray!

This function is deprecated.

Use getCurrentTracks.

TrackSelectionArray!

This function is deprecated.

Use getCurrentTracks.

Tracks!

Returns the current tracks.

ExoPlayer.DeviceComponent?

This function is deprecated.

Use Player, as the DeviceComponent methods are defined by that interface.

DeviceInfo!

Gets the device information.

Int

Gets the current volume of the device.

Long

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

Long

Returns the maximum position for which seekToPrevious seeks to the previous , in milliseconds.

MediaMetadata!

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

Boolean

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

Boolean

Whether playback will proceed when getPlaybackState == STATE_READY.

Looper!

Returns the Looper associated with the playback thread.

PlaybackParameters!

Returns the currently active playback parameters.

Int

Returns the current playback state of the player.

Int

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

ExoPlaybackException?

Returns the error that caused playback to fail.

MediaMetadata!

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

ExoPlayer.PreloadConfiguration!

Returns the preload configuration.

Renderer!
getRenderer(index: Int)

Returns the renderer at the given index.

Int

Returns the number of renderers.

Int

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

Int

Returns the current RepeatMode used for playback.

Long

Returns the seekBack increment.

Long

Returns the seekForward increment.

SeekParameters!

Returns the currently active SeekParameters of the player.

Boolean

Returns whether shuffling of media items is enabled.

Boolean

Returns whether skipping silences in the audio stream is enabled.

Size!

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

ExoPlayer.TextComponent?

This function is deprecated.

Use Player, as the TextComponent methods are defined by that interface.

Long

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

TrackSelectionParameters!

Returns the parameters constraining the track selection.

TrackSelector!

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

Int

Returns the C.VideoChangeFrameRateStrategy.

ExoPlayer.VideoComponent?

This function is deprecated.

Use ExoPlayer, as the VideoComponent methods are defined by that interface.

DecoderCounters?

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

Format?

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

Int

Returns the C.VideoScalingMode.

VideoSize!

Gets the size of the video.

Float

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

Unit

This function is deprecated.

Use increaseDeviceVolume instead.

Unit

Increases the volume of the device.

Boolean

Gets whether the device is muted or not.

Boolean

Whether the player is currently loading the source.

Boolean

Returns whether the player is currently playing an ad.

Boolean

Returns whether release has been called on the player.

Boolean

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

Boolean

Returns whether tunneling is enabled for the currently selected tracks.

Unit
moveMediaItems(fromIndex: Int, toIndex: Int, newIndex: Int)

Moves the media item range to the new index.

Unit

Prepares the player.

Unit
prepare(mediaSource: MediaSource!)

This function is deprecated.

Use setMediaSource and prepare instead.

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

This function is deprecated.

Use setMediaSource and prepare instead.

Unit

Releases the player.

Unit

Removes an AnalyticsListener.

Unit

Removes a listener of audio offload events.

Unit

Unregister a listener registered through addListener.

Unit
removeMediaItems(fromIndex: Int, toIndex: Int)

Removes a range of media items from the playlist.

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

Replaces the media items at the given range of the playlist.

Unit
@VisibleForTesting(otherwise = 4)
seekTo(
    mediaItemIndex: Int,
    positionMs: Long,
    @Player.Command seekCommand: Int,
    isRepeatingCurrentItem: Boolean
)

Seeks to a position in the specified MediaItem.

Unit
setAudioAttributes(
    audioAttributes: AudioAttributes!,
    handleAudioFocus: Boolean
)

Sets the attributes for audio playback, used by the underlying audio track.

Unit
setAudioSessionId(audioSessionId: Int)

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

Unit

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

Unit

Sets a listener of camera motion events.

Unit

This function is deprecated.

Use setDeviceMuted instead.

Unit

Sets the mute state of the device.

Unit

This function is deprecated.

Use setDeviceVolume instead.

Unit
setDeviceVolume(volume: Int, @C.VolumeFlags flags: Int)

Sets the volume of the device with volume flags.

Unit
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
setImageOutput(imageOutput: ImageOutput?)

Sets the ImageOutput where rendered images will be forwarded.

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
setMediaSource(mediaSource: MediaSource!)

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

Unit
setMediaSource(mediaSource: MediaSource!, resetPosition: Boolean)

Clears the playlist and adds the specified MediaSource.

Unit
setMediaSource(mediaSource: MediaSource!, startPositionMs: Long)

Clears the playlist and adds the specified MediaSource.

Unit

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

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

Clears the playlist and adds the specified MediaSources.

Unit
setMediaSources(
    mediaSources: (Mutable)List<MediaSource!>!,
    startMediaItemIndex: Int,
    startPositionMs: Long
)

Clears the playlist and adds the specified MediaSources.

Unit
setPauseAtEndOfMediaItems(pauseAtEndOfMediaItems: Boolean)

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

Unit
setPlayWhenReady(playWhenReady: Boolean)

Sets whether playback should proceed when getPlaybackState == STATE_READY.

Unit

Attempts to set the playback parameters.

Unit

Sets the playlist MediaMetadata.

Unit
@RequiresApi(value = 23)
setPreferredAudioDevice(audioDeviceInfo: AudioDeviceInfo?)

Sets the preferred audio device.

Unit

Sets the preload configuration to configure playlist preloading.

Unit

Sets the C.Priority for this player.

Unit

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

Unit

Sets the RepeatMode to be used for playback.

Unit

Sets the parameters that control how seek operations are performed.

Unit
setShuffleModeEnabled(shuffleModeEnabled: Boolean)

Sets whether shuffling of media items is enabled.

Unit
setShuffleOrder(shuffleOrder: ShuffleOrder!)

Sets the shuffle order.

Unit
setSkipSilenceEnabled(skipSilenceEnabled: Boolean)

Sets whether skipping silences in the audio stream is enabled.

Unit

Sets the parameters constraining the track selection.

Unit
setVideoChangeFrameRateStrategy(
    @C.VideoChangeFrameRateStrategy videoChangeFrameRateStrategy: Int
)

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

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

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

Unit

Sets a listener to receive video frame metadata events.

Unit

Sets the C.VideoScalingMode.

Unit

Sets the Surface onto which video will be rendered.

Unit

Sets the SurfaceHolder that holds the Surface onto which video will be rendered.

Unit

Sets the SurfaceView onto which video will be rendered.

Unit

Sets the TextureView onto which video will be rendered.

Unit
setVolume(volume: Float)

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

Unit

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

Unit

Stops playback without resetting the playlist.

Inherited Constants

From androidx.media3.exoplayer.ExoPlayer
const Long

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

const Long

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

From androidx.media3.common.Player
const Int

This property is deprecated.

Use COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS instead.

const Int

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

const Int

Command to change the media items in the playlist.

const Int

Command to get the player current AudioAttributes.

const Int

Command to get information about the currently playing MediaItem.

const Int

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

const Int

This property is deprecated.

Use COMMAND_GET_METADATA instead.

const Int

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

const Int

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

const Int

Command to get the information about the current timeline.

const Int

Command to get details of the current track selection.

const Int

Command to get the player volume.

const Int

Represents an invalid Command.

const Int

Command to start, pause or resume playback.

const Int

Command to prepare the player.

const Int

Command to release the player.

const Int

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

const Int

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

const Int

Command to seek anywhere inside the current MediaItem.

const Int

This property is deprecated.

Use COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM instead.

const Int

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

const Int

Command to seek anywhere in any MediaItem.

const Int

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

const Int

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

const Int

This property is deprecated.

Use COMMAND_SEEK_TO_NEXT_MEDIA_ITEM instead.

const Int

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

const Int

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

const Int

This property is deprecated.

Use COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM instead.

const Int

This property is deprecated.

Use COMMAND_SEEK_TO_MEDIA_ITEM instead.

const Int

Command to set the player's audio attributes.

const Int

This property is deprecated.

Use COMMAND_SET_DEVICE_VOLUME_WITH_FLAGS instead.

const Int

Command to set the device volume with volume flags.

const Int

Command to set a MediaItem.

const Int

This property is deprecated.

Use COMMAND_SET_PLAYLIST_METADATA instead.

const Int

Command to set the playlist metadata.

const Int

Command to set the repeat mode.

const Int

Command to enable shuffling.

const Int

Command to set the playback speed and pitch.

const Int

Command to set the player's track selection parameters.

const Int

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

const Int

Command to set the player volume.

const Int

Command to stop playback.

const Int

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

const Int

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

const Int

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

const Int

Seek within the current period or to another period.

const Int

Seek adjustment due to being unable to seek to the requested position or because the seek was permitted to be inexact.

const Int

Discontinuity introduced by a skipped silence.

const Int

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

const Int

getAudioAttributes changed.

const Int

The audio session id was set.

const Int

isCommandAvailable changed for at least one Command.

const Int

getCurrentCues changed.

const Int

getDeviceInfo changed.

const Int

getDeviceVolume changed.

const Int

isLoading ()} changed.

const Int

isPlaying changed.

const Int

getMaxSeekToPreviousPosition changed.

const Int

getCurrentMediaItem changed or the player started repeating the current item.

const Int

getMediaMetadata changed.

const Int

Metadata associated with the current playback time changed.

const Int

getPlaybackParameters changed.

const Int

getPlaybackState changed.

const Int

getPlaybackSuppressionReason changed.

const Int

getPlayerError changed.

const Int

getPlaylistMetadata changed.

const Int

getPlayWhenReady changed.

const Int

A position discontinuity occurred.

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

const Int

getRepeatMode changed.

const Int

getSeekBackIncrement changed.

const Int

getSeekForwardIncrement changed.

const Int

getShuffleModeEnabled changed.

const Int

Skipping silences in the audio stream is enabled or disabled.

const Int

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

const Int

getCurrentTimeline changed.

const Int

getCurrentTracks changed.

const Int

getTrackSelectionParameters changed.

const Int

getVideoSize changed.

const Int

getVolume changed.

const Int

Playback has automatically transitioned to the next media item.

const Int

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

const Int

The media item has been repeated.

const Int

A seek to another media item has occurred.

const Int

Playback is not suppressed.

const Int

Playback is suppressed due to transient audio focus loss.

const 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).

const Int

This property is deprecated.

Use PLAYBACK_SUPPRESSION_REASON_UNSUITABLE_AUDIO_OUTPUT instead.

const Int

Playback has been paused to avoid becoming noisy.

const Int

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

const Int

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

const Int

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

const Int

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

const Int

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

const Int

Repeats the entire timeline infinitely.

const Int

Normal playback without repetition.

const Int

Repeats the currently playing MediaItem infinitely during ongoing playback.

const Int

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

const Int

The player has finished playing the media.

const Int

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

const Int

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

const Int

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

const Int

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

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

Boolean

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

Unit

Clears the playlist.

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.

Long

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

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.

Any?

Returns the current manifest.

MediaItem?

Returns the currently playing MediaItem.

Int

This function is deprecated.

Use getCurrentMediaItemIndex instead.

MediaItem!

Returns the MediaItem at the given index.

Int

Returns the number of media items in the playlist.

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.

Int

This function is deprecated.

Use getNextMediaItemIndex instead.

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.

Int

This function is deprecated.

Use getPreviousMediaItemIndex instead.

Boolean

This function is deprecated.

Use hasNextMediaItem instead.

Boolean

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

Boolean

This function is deprecated.

Use hasNextMediaItem instead.

Boolean

Returns whether a previous media item exists, which may depend on the current repeat mode and whether shuffle mode is enabled.

Boolean

Returns whether the provided Command is available.

Boolean

Returns whether the current MediaItem is dynamic (may change when the Timeline is updated), or false if the Timeline is empty.

Boolean

Returns whether the current MediaItem is live, or false if the Timeline is empty.

Boolean

Returns whether the current MediaItem is seekable, or false if the is empty.

Boolean

This function is deprecated.

Use isCurrentMediaItemDynamic instead.

Boolean

This function is deprecated.

Use isCurrentMediaItemLive instead.

Boolean

This function is deprecated.

Use isCurrentMediaItemSeekable instead.

Boolean

Returns whether the player is playing, i.e. getCurrentPosition is advancing.

Unit
moveMediaItem(currentIndex: Int, newIndex: Int)

Moves the media item at the current index to the new index.

Unit

This function is deprecated.

Use seekToNextMediaItem instead.

Unit

Pauses playback.

Unit

Resumes playback as soon as getPlaybackState == STATE_READY.

Unit

Removes the media item at the given index of the playlist.

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

Replaces the media item at the given index of the playlist.

Unit

Seeks back in the current MediaItem by getSeekBackIncrement milliseconds.

Unit

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

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

Seeks to a later position in the current or next MediaItem (if available).

Unit

Seeks to the default position of the next MediaItem, which may depend on the current repeat mode and whether shuffle mode is enabled.

Unit

This function is deprecated.

Use seekToNextMediaItem instead.

Unit

Seeks to an earlier position in the current or previous MediaItem (if available).

Unit

Seeks to the default position of the previous MediaItem, which may depend on the current repeat mode and whether shuffle mode is enabled.

Unit

This function is deprecated.

Use seekToPreviousMediaItem instead.

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

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

Unit

Changes the rate at which playback occurs.

From androidx.media3.common.Player
abstract Unit
setPlaybackSpeed(speed: @FloatRange(from = 0, fromInclusive = false) Float)

Changes the rate at which playback occurs.

Protected constructors

SimpleExoPlayer

protected SimpleExoPlayer(builder: SimpleExoPlayer.Builder!)
Parameters
builder: SimpleExoPlayer.Builder!

The Builder to obtain all construction parameters.

SimpleExoPlayer

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

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

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.

addListener

fun addListener(listener: Player.Listener!): Unit

Registers a listener to receive all events from the player.

The listener's methods will be called on the thread associated with getApplicationLooper.

This method can be called from any thread.

Parameters
listener: Player.Listener!

The listener to register.

addMediaItems

fun addMediaItems(index: Int, mediaItems: (Mutable)List<MediaItem!>!): Unit

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

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
index: Int

The index at which to add the media items. If the index is larger than the size of the playlist, the media items are added to the end of the playlist.

mediaItems: (Mutable)List<MediaItem!>!

The media items to add.

addMediaSource

fun addMediaSource(mediaSource: MediaSource!): Unit

Adds a media source to the end of the playlist.

Parameters
mediaSource: MediaSource!

The MediaSource to add.

addMediaSource

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

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

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

fun clearAuxEffectInfo(): Unit

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

clearCameraMotionListener

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

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.

clearVideoSurface

fun clearVideoSurface(): Unit

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

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

clearVideoSurface

fun clearVideoSurface(surface: Surface?): Unit

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

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
surface: Surface?

The surface to clear.

clearVideoSurfaceHolder

fun clearVideoSurfaceHolder(surfaceHolder: SurfaceHolder?): Unit

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

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
surfaceHolder: SurfaceHolder?

The surface holder to clear.

clearVideoSurfaceView

fun clearVideoSurfaceView(surfaceView: SurfaceView?): Unit

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

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
surfaceView: SurfaceView?

The texture view to clear.

clearVideoTextureView

fun clearVideoTextureView(textureView: TextureView?): Unit

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

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
textureView: TextureView?

The texture view to clear.

createMessage

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.

decreaseDeviceVolume

fun decreaseDeviceVolume(): Unit

decreaseDeviceVolume

fun decreaseDeviceVolume(@C.VolumeFlags flags: Int): Unit

Decreases the volume of the device.

The getDeviceVolume device volume cannot be decreased below minVolume.

Note that this method affects the device volume. To change the volume of the current stream only, use setVolume.

This method must only be called if COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS is available.

Parameters
@C.VolumeFlags flags: Int

Either 0 or a bitwise combination of one or more C.VolumeFlags.

getAnalyticsCollector

fun getAnalyticsCollector(): AnalyticsCollector!

Returns the AnalyticsCollector used for collecting analytics events.

getApplicationLooper

fun getApplicationLooper(): Looper!

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

This method can be called from any thread.

getAudioAttributes

fun getAudioAttributes(): AudioAttributes!

Returns the attributes for audio playback.

This method must only be called if COMMAND_GET_AUDIO_ATTRIBUTES is available.

getAudioComponent

fun getAudioComponent(): ExoPlayer.AudioComponent?

getAudioDecoderCounters

fun getAudioDecoderCounters(): DecoderCounters?

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

getAudioFormat

fun getAudioFormat(): Format?

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

getAudioSessionId

fun getAudioSessionId(): Int

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

getAvailableCommands

fun getAvailableCommands(): Player.Commands!

Returns the player's currently available Commands.

The returned Commands are not updated when available commands change. Use onAvailableCommandsChanged to get an update when the available commands change.

Returns
Player.Commands!

The currently available Commands.

getBufferedPosition

fun getBufferedPosition(): Long

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

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getClock

fun getClock(): Clock!

Returns the Clock used for playback.

This method can be called from any thread.

getContentBufferedPosition

fun getContentBufferedPosition(): Long

If isPlayingAd returns true, returns an estimate of the content position in the current content up to which data is buffered, in milliseconds. If there is no ad playing, the returned position is the same as that returned by getBufferedPosition.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getContentPosition

fun getContentPosition(): 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. If there is no ad playing, the returned position is the same as that returned by getCurrentPosition.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getCurrentAdGroupIndex

fun getCurrentAdGroupIndex(): Int

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

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getCurrentAdIndexInAdGroup

fun getCurrentAdIndexInAdGroup(): Int

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

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getCurrentCues

fun getCurrentCues(): CueGroup!

Returns the current CueGroup.

This method must only be called if COMMAND_GET_TEXT is available.

See also
onCues

getCurrentMediaItemIndex

fun getCurrentMediaItemIndex(): Int

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

This method must only be called if COMMAND_GET_TIMELINE is available.

getCurrentPeriodIndex

fun getCurrentPeriodIndex(): Int

Returns the index of the period currently being played.

This method must only be called if COMMAND_GET_TIMELINE is available.

getCurrentPosition

fun getCurrentPosition(): 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.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getCurrentTimeline

fun getCurrentTimeline(): Timeline!

Returns the current Timeline. Never null, but may be empty.

This method must only be called if COMMAND_GET_TIMELINE is available.

getCurrentTrackGroups

fun getCurrentTrackGroups(): TrackGroupArray!

getCurrentTrackSelections

fun getCurrentTrackSelections(): TrackSelectionArray!

getCurrentTracks

fun getCurrentTracks(): Tracks!

Returns the current tracks.

This method must only be called if COMMAND_GET_TRACKS is available.

See also
onTracksChanged

getDeviceComponent

fun getDeviceComponent(): ExoPlayer.DeviceComponent?

getDeviceInfo

fun getDeviceInfo(): DeviceInfo!

Gets the device information.

getDeviceVolume

fun getDeviceVolume(): Int

Gets the current volume of the device.

For devices with local playback, the volume returned by this method varies according to the current stream type. The stream type is determined by usage which can be converted to stream type with getStreamTypeForAudioUsage.

For devices with remote playback, the volume of the remote device is returned.

Note that this method returns the volume of the device. To check the current stream volume, use getVolume.

This method must only be called if COMMAND_GET_DEVICE_VOLUME is available.

getDuration

fun getDuration(): Long

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

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getMaxSeekToPreviousPosition

fun getMaxSeekToPreviousPosition(): Long

Returns the maximum position for which seekToPrevious seeks to the previous , in milliseconds.

Returns
Long

The maximum seek to previous position, in milliseconds.

getMediaMetadata

fun getMediaMetadata(): MediaMetadata!

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

This MediaMetadata is a combination of the MediaItem metadata, the static metadata in the media's Format, and any timed metadata that has been parsed from the media and output via onMetadata. If a field is populated in the mediaMetadata, it will be prioritised above the same field coming from static or timed metadata.

This method must only be called if COMMAND_GET_METADATA is available.

getPauseAtEndOfMediaItems

fun getPauseAtEndOfMediaItems(): Boolean

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

getPlayWhenReady

fun getPlayWhenReady(): Boolean

Whether playback will proceed when getPlaybackState == STATE_READY.

Returns
Boolean

Whether playback will proceed when ready.

getPlaybackLooper

fun getPlaybackLooper(): Looper!

Returns the Looper associated with the playback thread.

This method may be called from any thread.

getPlaybackParameters

fun getPlaybackParameters(): PlaybackParameters!

Returns the currently active playback parameters.

getPlaybackState

@Player.State
fun getPlaybackState(): Int

Returns the current playback state of the player.

Returns
Int

The current playback state.

getPlaybackSuppressionReason

@Player.PlaybackSuppressionReason
fun getPlaybackSuppressionReason(): Int

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

Returns
Int

The current PlaybackSuppressionReason.

getPlayerError

fun getPlayerError(): ExoPlaybackException?

Returns the error that caused playback to fail. This is the same error that will have been reported via onPlayerError at the time of failure. It can be queried using this method until the player is re-prepared.

Note that this method will always return null if getPlaybackState is not STATE_IDLE.

Returns
ExoPlaybackException?

The error, or null.

See also
onPlayerError

getPlaylistMetadata

fun getPlaylistMetadata(): MediaMetadata!

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

This method must only be called if COMMAND_GET_METADATA is available.

getPreloadConfiguration

fun getPreloadConfiguration(): ExoPlayer.PreloadConfiguration!

Returns the preload configuration.

getRenderer

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

fun getRendererCount(): Int

Returns the number of renderers.

getRendererType

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

getRepeatMode

@Player.RepeatMode
fun getRepeatMode(): Int

Returns the current RepeatMode used for playback.

Returns
Int

The current repeat mode.

getSeekBackIncrement

fun getSeekBackIncrement(): Long

Returns the seekBack increment.

Returns
Long

The seek back increment, in milliseconds.

getSeekForwardIncrement

fun getSeekForwardIncrement(): Long

Returns the seekForward increment.

Returns
Long

The seek forward increment, in milliseconds.

getSeekParameters

fun getSeekParameters(): SeekParameters!

Returns the currently active SeekParameters of the player.

getShuffleModeEnabled

fun getShuffleModeEnabled(): Boolean

Returns whether shuffling of media items is enabled.

getSkipSilenceEnabled

fun getSkipSilenceEnabled(): Boolean

Returns whether skipping silences in the audio stream is enabled.

getSurfaceSize

fun getSurfaceSize(): Size!

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

getTextComponent

fun getTextComponent(): ExoPlayer.TextComponent?

getTotalBufferedDuration

fun getTotalBufferedDuration(): Long

Returns an estimate of the total buffered duration from the current position, in milliseconds. This includes pre-buffered data for subsequent ads and media items.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getTrackSelectionParameters

fun getTrackSelectionParameters(): TrackSelectionParameters!

Returns the parameters constraining the track selection.

getTrackSelector

fun getTrackSelector(): TrackSelector!

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

getVideoComponent

fun getVideoComponent(): ExoPlayer.VideoComponent?

getVideoDecoderCounters

fun getVideoDecoderCounters(): DecoderCounters?

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

getVideoFormat

fun getVideoFormat(): Format?

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

getVideoScalingMode

@C.VideoScalingMode
fun getVideoScalingMode(): Int

Returns the C.VideoScalingMode.

getVideoSize

fun getVideoSize(): VideoSize!

Gets the size of the video.

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

getVolume

fun getVolume(): Float

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

This method must only be called if COMMAND_GET_VOLUME is available.

Returns
Float

The linear gain applied to all audio channels.

See also
onVolumeChanged

increaseDeviceVolume

fun increaseDeviceVolume(): Unit

increaseDeviceVolume

fun increaseDeviceVolume(@C.VolumeFlags flags: Int): Unit

Increases the volume of the device.

The getDeviceVolume device volume cannot be increased above maxVolume, if defined.

Note that this method affects the device volume. To change the volume of the current stream only, use setVolume.

This method must only be called if COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS is available.

Parameters
@C.VolumeFlags flags: Int

Either 0 or a bitwise combination of one or more C.VolumeFlags.

isDeviceMuted

fun isDeviceMuted(): Boolean

Gets whether the device is muted or not.

Note that this method returns the mute state of the device. To check if the current stream is muted, use getVolume() == 0.

This method must only be called if COMMAND_GET_DEVICE_VOLUME is available.

isLoading

fun isLoading(): Boolean

Whether the player is currently loading the source.

Returns
Boolean

Whether the player is currently loading the source.

isPlayingAd

fun isPlayingAd(): Boolean

Returns whether the player is currently playing an ad.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

isReleased

fun isReleased(): Boolean

Returns whether release has been called on the player.

This method is allowed to be called after release.

isSleepingForOffload

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.

isTunnelingEnabled

fun isTunnelingEnabled(): Boolean

Returns whether tunneling is enabled for the currently selected tracks.

See also
onTracksChanged

moveMediaItems

fun moveMediaItems(fromIndex: Int, toIndex: Int, newIndex: Int): Unit

Moves the media item range to the new index.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
fromIndex: Int

The start of the range to move. If the index is larger than the size of the playlist, the request is ignored.

toIndex: Int

The first item not to be included in the range (exclusive). If the index is larger than the size of the playlist, items up to the end of the playlist are moved.

newIndex: Int

The new index of the first media item of the range. If the new index is larger than the size of the remaining playlist after removing the range, the range is moved to the end of the playlist.

prepare

fun prepare(): Unit

Prepares the player.

This method must only be called if COMMAND_PREPARE is available.

This will move the player out of idle state and the player will start loading media and acquire resources needed for playback.

prepare

fun prepare(mediaSource: MediaSource!): Unit

prepare

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

removeAnalyticsListener

fun removeAnalyticsListener(listener: AnalyticsListener!): Unit

Removes an AnalyticsListener.

Parameters
listener: AnalyticsListener!

The listener to be removed.

removeAudioOffloadListener

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

Removes a listener of audio offload events.

Parameters
listener: ExoPlayer.AudioOffloadListener!

The listener to unregister.

removeListener

fun removeListener(listener: Player.Listener!): Unit

Unregister a listener registered through addListener. The listener will no longer receive events.

Parameters
listener: Player.Listener!

The listener to unregister.

removeMediaItems

fun removeMediaItems(fromIndex: Int, toIndex: Int): Unit

Removes a range of media items from the playlist.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
fromIndex: Int

The index at which to start removing media items. If the index is larger than the size of the playlist, the request is ignored.

toIndex: Int

The index of the first item to be kept (exclusive). If the index is larger than the size of the playlist, media items up to the end of the playlist are removed.

replaceMediaItems

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

Note that it is possible to replace a range with an arbitrary number of new items, so that the number of removed items defined by fromIndex and toIndex does not have to match the number of added items defined by mediaItems. As result, it may also change the index of subsequent items not touched by this operation.

Parameters
fromIndex: Int

The start of the range. If the index is larger than the size of the playlist, the request is ignored.

toIndex: Int

The first item not to be included in the range (exclusive). If the index is larger than the size of the playlist, items up to the end of the playlist are replaced.

mediaItems: (Mutable)List<MediaItem!>!

The media items to replace the range with.

seekTo

@VisibleForTesting(otherwise = 4)
fun seekTo(
    mediaItemIndex: Int,
    positionMs: Long,
    @Player.Command seekCommand: Int,
    isRepeatingCurrentItem: Boolean
): Unit

Seeks to a position in the specified MediaItem.

Parameters
mediaItemIndex: Int

The index of the MediaItem. If the original seek operation did not directly specify an index, this is the most likely implied index based on the available player state. If the implied action is to do nothing, this will be INDEX_UNSET.

positionMs: Long

The seek position in the specified MediaItem in milliseconds, or TIME_UNSET to seek to the media item's default position. If the original seek operation did not directly specify a position, this is the most likely implied position based on the available player state.

@Player.Command seekCommand: Int

The Player.Command used to trigger the seek.

isRepeatingCurrentItem: Boolean

Whether this seeks repeats the current item.

setAudioAttributes

fun setAudioAttributes(
    audioAttributes: AudioAttributes!,
    handleAudioFocus: Boolean
): Unit

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

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

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

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

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

This method must only be called if COMMAND_SET_AUDIO_ATTRIBUTES is available.

Parameters
audioAttributes: AudioAttributes!

The attributes to use for audio playback.

handleAudioFocus: Boolean

True if the player should handle audio focus, false otherwise.

setAudioSessionId

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

Parameters
audioSessionId: Int

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

setAuxEffectInfo

fun setAuxEffectInfo(auxEffectInfo: AuxEffectInfo!): Unit

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

setCameraMotionListener

fun setCameraMotionListener(listener: CameraMotionListener!): Unit

Sets a listener of camera motion events.

Parameters
listener: CameraMotionListener!

The listener.

setDeviceMuted

fun setDeviceMuted(muted: Boolean): Unit

setDeviceMuted

fun setDeviceMuted(muted: Boolean, @C.VolumeFlags flags: Int): Unit

Sets the mute state of the device.

Note that this method affects the device volume. To mute just the current stream, use setVolume(0) instead.

This method must only be called if COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS is available.

Parameters
muted: Boolean

Whether to set the device to be muted or not

@C.VolumeFlags flags: Int

Either 0 or a bitwise combination of one or more C.VolumeFlags.

setDeviceVolume

fun setDeviceVolume(volume: Int): Unit

setDeviceVolume

fun setDeviceVolume(volume: Int, @C.VolumeFlags flags: Int): Unit

Sets the volume of the device with volume flags.

Note that this method affects the device volume. To change the volume of the current stream only, use setVolume.

This method must only be called if COMMAND_SET_DEVICE_VOLUME_WITH_FLAGS is available.

Parameters
volume: Int

The volume to set.

@C.VolumeFlags flags: Int

Either 0 or a bitwise combination of one or more C.VolumeFlags.

setForegroundMode

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

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.

setMediaItems

fun setMediaItems(
    mediaItems: (Mutable)List<MediaItem!>!,
    resetPosition: Boolean
): Unit

Clears the playlist and adds the specified media items.

To replace a span of media items (possibly seamlessly) without clearing the playlist, use replaceMediaItems.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
mediaItems: (Mutable)List<MediaItem!>!

The new media items.

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.

setMediaItems

fun setMediaItems(
    mediaItems: (Mutable)List<MediaItem!>!,
    startIndex: Int,
    startPositionMs: Long
): Unit

Clears the playlist and adds the specified media items.

To replace a span of media items (possibly seamlessly) without clearing the playlist, use replaceMediaItems.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
mediaItems: (Mutable)List<MediaItem!>!

The new media items.

startIndex: Int

The MediaItem 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 MediaItem is used. In any case, if startIndex is set to INDEX_UNSET, this parameter is ignored and the position is not reset at all.

Throws
androidx.media3.common.IllegalSeekPositionException

If the provided startIndex is not within the bounds of the list of media items.

setMediaSource

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

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

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

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

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

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

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.

setPlayWhenReady

fun setPlayWhenReady(playWhenReady: Boolean): Unit

Sets whether playback should proceed when getPlaybackState == STATE_READY.

If the player is already in the ready state then this method pauses and resumes playback.

This method must only be called if COMMAND_PLAY_PAUSE is available.

Parameters
playWhenReady: Boolean

Whether playback should proceed when ready.

setPlaybackParameters

fun setPlaybackParameters(playbackParameters: PlaybackParameters!): Unit

Attempts to set the playback parameters. Passing DEFAULT resets the player to the default, which means there is no speed or pitch adjustment.

Playback parameters changes may cause the player to buffer. onPlaybackParametersChanged will be called whenever the currently active playback parameters change.

This method must only be called if COMMAND_SET_SPEED_AND_PITCH is available.

Parameters
playbackParameters: PlaybackParameters!

The playback parameters.

setPlaylistMetadata

fun setPlaylistMetadata(mediaMetadata: MediaMetadata!): Unit

Sets the playlist MediaMetadata.

This method must only be called if COMMAND_SET_PLAYLIST_METADATA is available.

setPreferredAudioDevice

@RequiresApi(value = 23)
fun setPreferredAudioDevice(audioDeviceInfo: AudioDeviceInfo?): Unit

Sets the preferred audio device.

Parameters
audioDeviceInfo: AudioDeviceInfo?

The preferred audio device, or null to restore the default.

setPreloadConfiguration

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

Sets the preload configuration to configure playlist preloading.

Parameters
preloadConfiguration: ExoPlayer.PreloadConfiguration!

The preload configuration.

setPriority

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

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.

setRepeatMode

fun setRepeatMode(@Player.RepeatMode repeatMode: Int): Unit

Sets the RepeatMode to be used for playback.

This method must only be called if COMMAND_SET_REPEAT_MODE is available.

Parameters
@Player.RepeatMode repeatMode: Int

The repeat mode.

setSeekParameters

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.

setShuffleModeEnabled

fun setShuffleModeEnabled(shuffleModeEnabled: Boolean): Unit

Sets whether shuffling of media items is enabled.

This method must only be called if COMMAND_SET_SHUFFLE_MODE is available.

Parameters
shuffleModeEnabled: Boolean

Whether shuffling is enabled.

setShuffleOrder

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

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.

setTrackSelectionParameters

fun setTrackSelectionParameters(parameters: TrackSelectionParameters!): Unit

Sets the parameters constraining the track selection.

Unsupported parameters will be silently ignored.

Use getTrackSelectionParameters to retrieve the current parameters. For example, the following snippet restricts video to SD whilst keep other track selection parameters unchanged:

player.setTrackSelectionParameters(
  player.getTrackSelectionParameters()
        .buildUpon()
        .setMaxVideoSizeSd()
        .build())

This method must only be called if COMMAND_SET_TRACK_SELECTION_PARAMETERS is available.

setVideoChangeFrameRateStrategy

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

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.

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

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

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.

setVideoSurface

fun setVideoSurface(surface: Surface?): Unit

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

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

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
surface: Surface?

The Surface.

setVideoSurfaceHolder

fun setVideoSurfaceHolder(surfaceHolder: SurfaceHolder?): Unit

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

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

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
surfaceHolder: SurfaceHolder?

The surface holder.

setVideoSurfaceView

fun setVideoSurfaceView(surfaceView: SurfaceView?): Unit

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

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

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
surfaceView: SurfaceView?

The surface view.

setVideoTextureView

fun setVideoTextureView(textureView: TextureView?): Unit

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

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

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

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
textureView: TextureView?

The texture view.

setVolume

fun setVolume(volume: Float): Unit

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

This method must only be called if COMMAND_SET_VOLUME is available.

Parameters
volume: Float

Linear output gain to apply to all audio channels.

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

stop

fun stop(): Unit

Stops playback without resetting the playlist. Use pause rather than this method if the intention is to pause playback.

Calling this method will cause the playback state to transition to STATE_IDLE and the player will release the loaded media and resources required for playback. The player instance can still be used by calling prepare again, and release must still be called on the player if it's no longer required.

Calling this method does not clear the playlist, reset the playback position or the playback error.

This method must only be called if COMMAND_STOP is available.