SimpleExoPlayer

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
class SimpleExoPlayer : BasePlayer, ExoPlayer

kotlin.Any
↳	androidx.media3.common.BasePlayer
	↳	androidx.media3.exoplayer.SimpleExoPlayer

Summary

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

Nested types

class SimpleExoPlayer.Builder

This class is deprecated.

Use ExoPlayer.Builder instead.

Protected constructors
`SimpleExoPlayer(builder: SimpleExoPlayer.Builder!)`
`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`.

Protected constructors

SimpleExoPlayer(builder: SimpleExoPlayer.Builder!)

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`	`addAnalyticsListener(listener: AnalyticsListener!)` Adds an `AnalyticsListener` to receive analytics events.
`Unit`	`addAudioOffloadListener(listener: ExoPlayer.AudioOffloadListener!)` Adds a listener to receive audio offload events.
`Unit`	`addListener(listener: Player.Listener!)` 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`	`addMediaSources(mediaSources: (Mutable)List<MediaSource!>!)` 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`	`clearAuxEffectInfo()` Detaches any previously attached auxiliary audio effect from the underlying audio track.
`Unit`	`clearCameraMotionListener(listener: CameraMotionListener!)` Clears the listener which receives camera motion events if it matches the one passed.
`Unit`	`clearVideoFrameMetadataListener(listener: VideoFrameMetadataListener!)` Clears the listener which receives video frame metadata events if it matches the one passed.
`Unit`	`clearVideoSurface()` Clears any `Surface`, `SurfaceHolder`, `SurfaceView` or `TextureView` currently set on the player.
`Unit`	`clearVideoSurface(surface: Surface?)` Clears the `Surface` onto which video is being rendered if it matches the one passed.
`Unit`	`clearVideoSurfaceHolder(surfaceHolder: SurfaceHolder?)` Clears the `SurfaceHolder` that holds the `Surface` onto which video is being rendered if it matches the one passed.
`Unit`	`clearVideoSurfaceView(surfaceView: SurfaceView?)` Clears the `SurfaceView` onto which video is being rendered if it matches the one passed.
`Unit`	`clearVideoTextureView(textureView: TextureView?)` Clears the `TextureView` onto which video is being rendered if it matches the one passed.
`PlayerMessage!`	`createMessage(target: PlayerMessage.Target!)` Creates a message that can be sent to a `PlayerMessage.Target`.
`Unit`	`decreaseDeviceVolume()` This function is deprecated. Use `decreaseDeviceVolume` instead.
`Unit`	`decreaseDeviceVolume(@C.VolumeFlags flags: Int)` Decreases the volume of the device.
`AnalyticsCollector!`	`getAnalyticsCollector()` Returns the `AnalyticsCollector` used for collecting analytics events.
`Looper!`	`getApplicationLooper()` Returns the `Looper` associated with the application thread that's used to access the player and on which player events are received.
`AudioAttributes!`	`getAudioAttributes()` Returns the attributes for audio playback.
`DecoderCounters?`	`getAudioDecoderCounters()` Returns `DecoderCounters` for audio, or null if no audio is being played.
`Format?`	`getAudioFormat()` Returns the audio format currently being played, or null if no audio is being played.
`Int`	`getAudioSessionId()` Returns the audio session identifier, or `AUDIO_SESSION_ID_UNSET` if not set.
`Player.Commands!`	`getAvailableCommands()` Returns the player's currently available `Commands`.
`Long`	`getBufferedPosition()` Returns an estimate of the position in the current content or ad up to which data is buffered, in milliseconds.
`Clock!`	`getClock()` Returns the `Clock` used for playback.
`Long`	`getContentBufferedPosition()` If `isPlayingAd` returns `true`, returns an estimate of the content position in the current content up to which data is buffered, in milliseconds.
`Long`	`getContentPosition()` If `isPlayingAd` returns `true`, returns the content position that will be played once all ads in the ad group have finished playing, in milliseconds.
`Int`	`getCurrentAdGroupIndex()` If `isPlayingAd` returns true, returns the index of the ad group in the period currently being played.
`Int`	`getCurrentAdIndexInAdGroup()` If `isPlayingAd` returns true, returns the index of the ad in its ad group.
`CueGroup!`	`getCurrentCues()` Returns the current `CueGroup`.
`Int`	`getCurrentMediaItemIndex()` Returns the index of the current `MediaItem` in the `timeline`, or the prospective index if the `current timeline` is empty.
`Int`	`getCurrentPeriodIndex()` Returns the index of the period currently being played.
`Long`	`getCurrentPosition()` Returns the playback position in the current content or ad, in milliseconds, or the prospective position in milliseconds if the `current timeline` is empty.
`Timeline!`	`getCurrentTimeline()` Returns the current `Timeline`.
`TrackGroupArray!`	`getCurrentTrackGroups()` This function is deprecated. Use `getCurrentTracks`.
`TrackSelectionArray!`	`getCurrentTrackSelections()` This function is deprecated. Use `getCurrentTracks`.
`Tracks!`	`getCurrentTracks()` Returns the current tracks.
`DeviceInfo!`	`getDeviceInfo()` Gets the device information.
`Int`	`getDeviceVolume()` Gets the current volume of the device.
`Long`	`getDuration()` Returns the duration of the current content or ad in milliseconds, or `TIME_UNSET` if the duration is not known.
`Long`	`getMaxSeekToPreviousPosition()` Returns the maximum position for which `seekToPrevious` seeks to the previous `MediaItem`, in milliseconds.
`MediaMetadata!`	`getMediaMetadata()` Returns the current combined `MediaMetadata`, or `EMPTY` if not supported.
`Boolean`	`getPauseAtEndOfMediaItems()` Returns whether the player pauses playback at the end of each media item.
`Boolean`	`getPlayWhenReady()` Whether playback will proceed when `getPlaybackState` == `STATE_READY`.
`Looper!`	`getPlaybackLooper()` Returns the `Looper` associated with the playback thread.
`PlaybackParameters!`	`getPlaybackParameters()` Returns the currently active playback parameters.
`Int`	`@Player.State getPlaybackState()` Returns the current `playback state` of the player.
`Int`	`@Player.PlaybackSuppressionReason getPlaybackSuppressionReason()` Returns the reason why playback is suppressed even though `getPlayWhenReady` is `true`, or `PLAYBACK_SUPPRESSION_REASON_NONE` if playback is not suppressed.
`ExoPlaybackException?`	`getPlayerError()` Returns the error that caused playback to fail.
`MediaMetadata!`	`getPlaylistMetadata()` Returns the playlist `MediaMetadata`, as set by `setPlaylistMetadata`, or `EMPTY` if not supported.
`ExoPlayer.PreloadConfiguration!`	`getPreloadConfiguration()` Returns the `preload configuration`.
`Renderer!`	`getRenderer(index: Int)` Returns the renderer at the given index.
`Int`	`getRendererCount()` Returns the number of renderers.
`Int`	`@C.TrackType getRendererType(index: Int)` Returns the track type that the renderer at a given index handles.
`Int`	`@Player.RepeatMode getRepeatMode()` Returns the current `RepeatMode` used for playback.
`ScrubbingModeParameters!`	`getScrubbingModeParameters()` Gets the parameters that control behavior in `scrubbing mode`.
`Renderer!`	`getSecondaryRenderer(index: Int)` Returns the secondary renderer at the given index.
`Long`	`getSeekBackIncrement()` Returns the `seekBack` increment.
`Long`	`getSeekForwardIncrement()` Returns the `seekForward` increment.
`SeekParameters!`	`getSeekParameters()` Returns the currently active `SeekParameters` of the player.
`Boolean`	`getShuffleModeEnabled()` Returns whether shuffling of media items is enabled.
`ShuffleOrder!`	`getShuffleOrder()` Returns the shuffle order.
`Boolean`	`getSkipSilenceEnabled()` Returns whether skipping silences in the audio stream is enabled.
`Size!`	`getSurfaceSize()` Gets the size of the surface on which the video is rendered.
`Long`	`getTotalBufferedDuration()` Returns an estimate of the total buffered duration from the current position, in milliseconds.
`TrackSelectionParameters!`	`getTrackSelectionParameters()` Returns the parameters constraining the track selection.
`TrackSelector!`	`getTrackSelector()` Returns the track selector that this player uses, or null if track selection is not supported.
`Int`	`@C.VideoChangeFrameRateStrategy getVideoChangeFrameRateStrategy()` Returns the `C.VideoChangeFrameRateStrategy`.
`DecoderCounters?`	`getVideoDecoderCounters()` Returns `DecoderCounters` for video, or null if no video is being played.
`Format?`	`getVideoFormat()` Returns the video format currently being played, or null if no video is being played.
`Int`	`@C.VideoScalingMode getVideoScalingMode()` Returns the `C.VideoScalingMode`.
`VideoSize!`	`getVideoSize()` Gets the size of the video.
`Float`	`getVolume()` Returns the audio volume, with 0 being silence and 1 being unity gain (signal unchanged).
`Unit`	`increaseDeviceVolume()` This function is deprecated. Use `increaseDeviceVolume` instead.
`Unit`	`increaseDeviceVolume(@C.VolumeFlags flags: Int)` Increases the volume of the device.
`Boolean`	`isDeviceMuted()` Gets whether the device is muted or not.
`Boolean`	`isLoading()` Whether the player is currently loading the source.
`Boolean`	`isPlayingAd()` Returns whether the player is currently playing an ad.
`Boolean`	`isReleased()` Returns whether `release` has been called on the player.
`Boolean`	`isScrubbingModeEnabled()` Returns whether the player is optimized for scrubbing (many frequent seeks).
`Boolean`	`isSleepingForOffload()` Returns whether the player has paused its main loop to save power in offload scheduling mode.
`Boolean`	`isTunnelingEnabled()` Returns whether tunneling is enabled for the currently selected tracks.
`Unit`	`moveMediaItems(fromIndex: Int, toIndex: Int, newIndex: Int)` Moves the media item range to the new index.
`Unit`	`mute()` Sets the audio volume to 0.
`Unit`	`prepare()` 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`	`release()` Releases the player.
`Unit`	`removeAnalyticsListener(listener: AnalyticsListener!)` Removes an `AnalyticsListener`.
`Unit`	`removeAudioOffloadListener(listener: ExoPlayer.AudioOffloadListener!)` Removes a listener of audio offload events.
`Unit`	`removeListener(listener: Player.Listener!)` 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`	`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`	`setAuxEffectInfo(auxEffectInfo: AuxEffectInfo!)` Sets information on an auxiliary audio effect to attach to the underlying audio track.
`Unit`	`setCameraMotionListener(listener: CameraMotionListener!)` Sets a listener of camera motion events.
`Unit`	`setDeviceMuted(muted: Boolean)` This function is deprecated. Use `setDeviceMuted` instead.
`Unit`	`setDeviceMuted(muted: Boolean, @C.VolumeFlags flags: Int)` Sets the mute state of the device.
`Unit`	`setDeviceVolume(volume: Int)` 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`	`setMaxSeekToPreviousPositionMs(maxSeekToPreviousPositionMs: Long)` Sets the maximum position for which `seekToPrevious` seeks to the previous `MediaItem`.
`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`	`setMediaSources(mediaSources: (Mutable)List<MediaSource!>!)` 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`	`setPlaybackParameters(playbackParameters: PlaybackParameters!)` Attempts to set the playback parameters.
`Unit`	`setPlaylistMetadata(mediaMetadata: MediaMetadata!)` Sets the playlist `MediaMetadata`.
`Unit`	`setPreferredAudioDevice(audioDeviceInfo: AudioDeviceInfo?)` Sets the preferred audio device.
`Unit`	`setPreloadConfiguration( preloadConfiguration: ExoPlayer.PreloadConfiguration! )` Sets the `preload configuration` to configure playlist preloading.
`Unit`	`setPriority(@C.Priority priority: Int)` Sets the `C.Priority` for this player.
`Unit`	`setPriorityTaskManager(priorityTaskManager: PriorityTaskManager?)` Sets a `PriorityTaskManager`, or null to clear a previously set priority task manager.
`Unit`	`setRepeatMode(@Player.RepeatMode repeatMode: Int)` Sets the `RepeatMode` to be used for playback.
`Unit`	`setScrubbingModeEnabled(scrubbingModeEnabled: Boolean)` Sets whether to optimize the player for scrubbing (many frequent seeks).
`Unit`	`setScrubbingModeParameters( scrubbingModeParameters: ScrubbingModeParameters! )` Sets the parameters that control behavior in `scrubbing mode`.
`Unit`	`setSeekBackIncrementMs(seekBackIncrementMs: Long)` Sets the `seekBack` increment.
`Unit`	`setSeekForwardIncrementMs(seekForwardIncrementMs: Long)` Sets the `seekForward` increment.
`Unit`	`setSeekParameters(seekParameters: SeekParameters?)` 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`	`setTrackSelectionParameters(parameters: TrackSelectionParameters!)` 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`	`setVideoFrameMetadataListener(listener: VideoFrameMetadataListener!)` Sets a listener to receive video frame metadata events.
`Unit`	`setVideoScalingMode(@C.VideoScalingMode videoScalingMode: Int)` Sets the `C.VideoScalingMode`.
`Unit`	`setVideoSurface(surface: Surface?)` Sets the `Surface` onto which video will be rendered.
`Unit`	`setVideoSurfaceHolder(surfaceHolder: SurfaceHolder?)` Sets the `SurfaceHolder` that holds the `Surface` onto which video will be rendered.
`Unit`	`setVideoSurfaceView(surfaceView: SurfaceView?)` Sets the `SurfaceView` onto which video will be rendered.
`Unit`	`setVideoTextureView(textureView: TextureView?)` Sets the `TextureView` onto which video will be rendered.
`Unit`	`setVirtualDeviceId(virtualDeviceId: Int)` Sets the virtual device id to be used for playback.
`Unit`	`setVolume(volume: Float)` Sets the audio volume, valid values are between 0 (silence) and 1 (unity gain, signal unchanged), inclusive.
`Unit`	`setWakeMode(@C.WakeMode wakeMode: Int)` Sets how the player should keep the device awake for playback when the screen is off.
`Unit`	`stop()` Stops playback without resetting the playlist.
`Unit`	`unmute()` If the audio volume is 0, sets the audio volume to a non-zero value decided by the Player to be the most appropriate.

Protected functions
`Unit`	`seekTo( mediaItemIndex: Int, positionMs: Long, @Player.Command seekCommand: Int, isRepeatingCurrentItem: Boolean )` Seeks to a position in the specified `MediaItem`.

Inherited Constants

From androidx.media3.exoplayer.ExoPlayer

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

From androidx.media3.common.Player

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

Inherited functions

From androidx.media3.common.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`	`addMediaItems(mediaItems: (Mutable)List<MediaItem!>!)` Adds a list of media items to the end of the playlist.
`Boolean`	`canAdvertiseSession()` Returns whether the player can be used to advertise a media session.
`Unit`	`clearMediaItems()` Clears the playlist.
`Int`	`getBufferedPercentage()` Returns an estimate of the percentage in the current content or ad up to which data is buffered, or 0 if no estimate is available.
`Long`	`getContentDuration()` If `isPlayingAd` returns `true`, returns the duration of the current content in milliseconds, or `TIME_UNSET` if the duration is not known.
`Long`	`getCurrentLiveOffset()` Returns the offset of the current playback position from the live edge in milliseconds, or `TIME_UNSET` if the current `MediaItemisn't live` or the offset is unknown.
`Any?`	`getCurrentManifest()` Returns the current manifest.
`MediaItem?`	`getCurrentMediaItem()` Returns the currently playing `MediaItem`.
`Int`	`getCurrentWindowIndex()` This function is deprecated. Use `getCurrentMediaItemIndex` instead.
`MediaItem!`	`getMediaItemAt(index: Int)` Returns the `MediaItem` at the given index.
`Int`	`getMediaItemCount()` Returns the number of `media items` in the playlist.
`Int`	`getNextMediaItemIndex()` Returns the index of the `MediaItem` that will be played if `seekToNextMediaItem` is called, which may depend on the current repeat mode and whether shuffle mode is enabled.
`Int`	`getNextWindowIndex()` This function is deprecated. Use `getNextMediaItemIndex` instead.
`Int`	`getPreviousMediaItemIndex()` Returns the index of the `MediaItem` that will be played if `seekToPreviousMediaItem` is called, which may depend on the current repeat mode and whether shuffle mode is enabled.
`Int`	`getPreviousWindowIndex()` This function is deprecated. Use `getPreviousMediaItemIndex` instead.
`Boolean`	`hasNextMediaItem()` Returns whether a next `MediaItem` exists, which may depend on the current repeat mode and whether shuffle mode is enabled.
`Boolean`	`hasPreviousMediaItem()` Returns whether a previous media item exists, which may depend on the current repeat mode and whether shuffle mode is enabled.
`Boolean`	`isCommandAvailable(@Player.Command command: Int)` Returns whether the provided `Command` is available.
`Boolean`	`isCurrentMediaItemDynamic()` Returns whether the current `MediaItem` is dynamic (may change when the `Timeline` is updated), or `false` if the `Timeline` is empty.
`Boolean`	`isCurrentMediaItemLive()` Returns whether the current `MediaItem` is live, or `false` if the `Timeline` is empty.
`Boolean`	`isCurrentMediaItemSeekable()` Returns whether the current `MediaItem` is seekable, or `false` if the `Timeline` is empty.
`Boolean`	`isCurrentWindowDynamic()` This function is deprecated. Use `isCurrentMediaItemDynamic` instead.
`Boolean`	`isCurrentWindowLive()` This function is deprecated. Use `isCurrentMediaItemLive` instead.
`Boolean`	`isCurrentWindowSeekable()` This function is deprecated. Use `isCurrentMediaItemSeekable` instead.
`Boolean`	`isPlaying()` 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`	`pause()` Pauses playback.
`Unit`	`play()` Resumes playback as soon as `getPlaybackState` == `STATE_READY`.
`Unit`	`removeMediaItem(index: Int)` 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`	`seekBack()` Seeks back in the current `MediaItem` by `getSeekBackIncrement` milliseconds.
`Unit`	`seekForward()` Seeks forward in the current `MediaItem` by `getSeekForwardIncrement` milliseconds.
`Unit`	`seekTo(positionMs: Long)` Seeks to a position specified in milliseconds in the current `MediaItem`.
`Unit`	`seekTo(mediaItemIndex: Int, positionMs: Long)` Seeks to a position specified in milliseconds in the specified `MediaItem`.
`Unit`	`seekToDefaultPosition()` Seeks to the default position associated with the current `MediaItem`.
`Unit`	`seekToDefaultPosition(mediaItemIndex: Int)` Seeks to the default position associated with the specified `MediaItem`.
`Unit`	`seekToNext()` Seeks to a later position in the current or next `MediaItem` (if available).
`Unit`	`seekToNextMediaItem()` Seeks to the default position of the next `MediaItem`, which may depend on the current repeat mode and whether shuffle mode is enabled.
`Unit`	`seekToPrevious()` Seeks to an earlier position in the current or previous `MediaItem` (if available).
`Unit`	`seekToPreviousMediaItem()` Seeks to the default position of the previous `MediaItem`, which may depend on the current repeat mode and whether shuffle mode is enabled.
`Unit`	`setMediaItem(mediaItem: MediaItem!)` Clears the playlist, adds the specified `MediaItem` and resets the position to the default position.
`Unit`	`setMediaItem(mediaItem: MediaItem!, resetPosition: Boolean)` Clears the playlist and adds the specified `MediaItem`.
`Unit`	`setMediaItem(mediaItem: MediaItem!, startPositionMs: Long)` Clears the playlist and adds the specified `MediaItem`.
`Unit`	`setMediaItems(mediaItems: (Mutable)List<MediaItem!>!)` Clears the playlist, adds the specified `media items` and resets the position to the default position.
`Unit`	`setPlaybackSpeed(speed: Float)` 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.

Inherited properties

From androidx.media3.common.BasePlayer

Timeline.Window!

window

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.

See also
`onAudioAttributesChanged`

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.

See also
`onAudioSessionIdChanged`

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

See also
`onAvailableCommandsChanged`

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.

See also
`onTimelineChanged`

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`

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

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

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

This method must only be called if COMMAND_GET_DEVICE_VOLUME is available.

See also
`onDeviceVolumeChanged`

getDuration

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 MediaItem, in milliseconds.

Returns
`Long`	The maximum seek to previous position, in milliseconds.

See also
`onMaxSeekToPreviousPositionChanged`

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.

See also
`onMediaMetadataChanged`

getPauseAtEndOfMediaItems

fun getPauseAtEndOfMediaItems(): Boolean

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

See also
`setPauseAtEndOfMediaItems`

getPlayWhenReady

fun getPlayWhenReady(): Boolean

Whether playback will proceed when getPlaybackState == STATE_READY.

Returns
`Boolean`	Whether playback will proceed when ready.

See also
`onPlayWhenReadyChanged`

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.

See also
`onPlaybackParametersChanged`

getPlaybackState

@Player.State
fun getPlaybackState(): Int

Returns the current playback state of the player.

Returns
`Int`	The current `playback state`.

See also
`onPlaybackStateChanged`

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

See also
`onPlaybackSuppressionReasonChanged`

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.

See also
`onPlaylistMetadataChanged`

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.

See also
`onRepeatModeChanged`

getScrubbingModeParameters

fun getScrubbingModeParameters(): ScrubbingModeParameters!

Gets the parameters that control behavior in scrubbing mode.

getSecondaryRenderer

fun getSecondaryRenderer(index: Int): Renderer!

Returns the secondary renderer at the given index.

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

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

getSeekBackIncrement

fun getSeekBackIncrement(): Long

Returns the seekBack increment.

Returns
`Long`	The seek back increment, in milliseconds.

See also
`onSeekBackIncrementChanged`

getSeekForwardIncrement

fun getSeekForwardIncrement(): Long

Returns the seekForward increment.

Returns
`Long`	The seek forward increment, in milliseconds.

See also
`onSeekForwardIncrementChanged`

getSeekParameters

fun getSeekParameters(): SeekParameters!

Returns the currently active SeekParameters of the player.

getShuffleModeEnabled

fun getShuffleModeEnabled(): Boolean

Returns whether shuffling of media items is enabled.

See also
`onShuffleModeEnabledChanged`

getShuffleOrder

fun getShuffleOrder(): ShuffleOrder!

Returns the shuffle order.

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

getSkipSilenceEnabled

fun getSkipSilenceEnabled(): Boolean

Returns whether skipping silences in the audio stream is enabled.

See also
`onSkipSilenceEnabledChanged`

getSurfaceSize

fun getSurfaceSize(): Size!

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

See also
`onSurfaceSizeChanged`

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.

See also
`onTrackSelectionParametersChanged`	}

getTrackSelector

fun getTrackSelector(): TrackSelector!

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

getVideoChangeFrameRateStrategy

@C.VideoChangeFrameRateStrategy
fun getVideoChangeFrameRateStrategy(): Int

Returns the C.VideoChangeFrameRateStrategy.

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.

See also
`onVideoSizeChanged`

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.

See also
`onDeviceVolumeChanged`

isLoading

fun isLoading(): Boolean

Whether the player is currently loading the source.

Returns
`Boolean`	Whether the player is currently loading the source.

See also
`onIsLoadingChanged`

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.

isScrubbingModeEnabled

fun isScrubbingModeEnabled(): Boolean

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

See setScrubbingModeEnabled.

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.

See also
`onSleepingForOffloadChanged`

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.

mute

fun mute(): Unit

Sets the audio volume to 0.

This method must only be called if COMMAND_SET_VOLUME is available.

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.

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

This method must only be called if COMMAND_SET_AUDIO_ATTRIBUTES is available.

Parameters
`audioAttributes: AudioAttributes!`	The attributes to use for audio playback.
`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.

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.

setMaxSeekToPreviousPositionMs

fun setMaxSeekToPreviousPositionMs(maxSeekToPreviousPositionMs: Long): Unit

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

Parameters
`maxSeekToPreviousPositionMs: Long`	The maximum position, in milliseconds.

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

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

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.

setScrubbingModeEnabled

fun setScrubbingModeEnabled(scrubbingModeEnabled: Boolean): Unit

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

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

During scrubbing mode playback is suppressed with PLAYBACK_SUPPRESSION_REASON_SCRUBBING.

Parameters
`scrubbingModeEnabled: Boolean`	Whether scrubbing mode should be enabled.

setScrubbingModeParameters

fun setScrubbingModeParameters(
    scrubbingModeParameters: ScrubbingModeParameters!
): Unit

Sets the parameters that control behavior in scrubbing mode.

setSeekBackIncrementMs

fun setSeekBackIncrementMs(seekBackIncrementMs: Long): Unit

Sets the seekBack increment.

Parameters
`seekBackIncrementMs: Long`	The seek back increment, in milliseconds.

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

setSeekForwardIncrementMs

fun setSeekForwardIncrementMs(seekForwardIncrementMs: Long): Unit

Sets the seekForward increment.

Parameters
`seekForwardIncrementMs: Long`	The seek forward increment, in milliseconds.

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

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.

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

The following limitations exist for using video effects:

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

Parameters
`videoEffects: (Mutable)List<Effect!>!`	The `List` of `video effects` to apply.

setVideoFrameMetadataListener

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 SurfaceHolder then it's recommended to use setVideoSurfaceView, setVideoTextureView or setVideoSurfaceHolder rather than this method, since passing the holder allows the player to track the lifecycle of the surface automatically.

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`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 TextureView. SurfaceView generally causes lower battery consumption, and has better handling for HDR and secure content. See Choosing a surface type for more information.

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

This method must only be called if COMMAND_SET_VIDEO_SURFACE is available.

Parameters
`textureView: TextureView?`	The texture view.

setVirtualDeviceId

fun setVirtualDeviceId(virtualDeviceId: Int): Unit

Sets the virtual device id to be used for playback.

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

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

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 / android.net.wifi.WifiManager.WifiLock) will be held whenever the player is in the STATE_READY or STATE_BUFFERING states with playWhenReady = true. The locks held depends on the specified C.WakeMode.

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

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.

unmute

fun unmute(): Unit

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

This method must only be called if COMMAND_SET_VOLUME is available.

Protected functions

seekTo

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