MediaController

Artifact: androidx.media3:media3-session

Kotlin |Java

@DoNotMock
class MediaController : Player

Known direct subclasses

MediaBrowser

MediaBrowser

Browses media content offered by a MediaLibraryService in addition to the functions.

A controller that interacts with a MediaSession, a MediaSessionService hosting a MediaSession, or a MediaLibraryService hosting a . The MediaSession typically resides in a remote process like another app but may be in the same process as this controller. It implements and the player commands are sent to the underlying Player of the connected . It also has session-specific commands that can be handled by .

Topics covered here:

Controller Lifecycle
Threading Model
Package Visibility Filter
Backward Compatibility with legacy media sessions

Controller Lifecycle

When a controller is created with the SessionToken for a MediaSession (i.e. session token type is TYPE_SESSION), the controller will connect to the specific session.

When a controller is created with the SessionToken for a MediaSessionService (i.e. session token type is TYPE_SESSION_SERVICE or TYPE_LIBRARY_SERVICE), the controller binds to the service for connecting to a MediaSession in it. MediaSessionService will provide a session to connect.

When you're done, use releaseFuture or release to clean up resources. This also helps the session service to be destroyed when there's no controller associated with it. Releasing the controller will still deliver all pending commands sent to the session and only unbind from the session service once these commands have been handled, or after a timeout of RELEASE_UNBIND_TIMEOUT_MS.

Threading Model

Methods of this class should be called from the application thread associated with the application looper. Otherwise, IllegalStateException will be thrown. Also, the methods of Player.Listener and Listener will be called from the application thread.

Package Visibility Filter

The app targeting API level 30 or higher must include a <queries> element in their manifest to connect to a service component of another app like MediaSessionService, MediaLibraryService, or androidx.media.MediaBrowserServiceCompat). See the following example and this guide for more information.

<!-- As intent actions -->
<intent>
  <action android:name="androidx.media3.session.MediaSessionService" />
</intent>
<intent>
  <action android:name="androidx.media3.session.MediaLibraryService" />
</intent>
<intent>
  <action android:name="android.media.browse.MediaBrowserService" />
</intent>
<!-- Or, as a package name -->
<package android:name="package_name_of_the_other_app" />

Backward Compatibility with legacy media sessions

In addition to MediaSession, the controller also supports connecting to a legacy media session - framework session and AndroidX session compat.

To request legacy sessions to play media, use one of the setMediaItem methods and set either mediaId, mediaUri or searchQuery. Once the controller is prepared, the controller triggers one of the following callbacks depending on the provided information and the value of getPlayWhenReady:

Other playlist change methods, like addMediaItem or removeMediaItem, trigger the onAddQueueItem and onRemoveQueueItem onRemoveQueueItem} callbacks. Check getAvailableCommands to see if playlist modifications are supported by the legacy session.

Summary

Nested types
`class MediaController.Builder` A builder for `MediaController`.
`interface MediaController.Listener` A listener for events and incoming commands from `MediaSession`.

Constants
`const String!`	`@UnstableApi KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG = "androidx.media3.session.MediaNotificationManager"` Key to mark the connection hints of the media notification controller.
`const Long`	`@UnstableApi RELEASE_UNBIND_TIMEOUT_MS = 30000` The timeout for handling pending commands after calling `release`.

Public functions
`Unit`	`addListener(listener: Player.Listener!)` Registers a listener to receive all events from the player.
`Unit`	`addMediaItem(mediaItem: MediaItem!)` Adds a media item to the end of the playlist.
`Unit`	`addMediaItem(index: Int, mediaItem: MediaItem!)` Adds a media item at the given index of the playlist.
`Unit`	`addMediaItems(mediaItems: (Mutable)List<MediaItem!>!)` Adds a list of media items to the end of the playlist.
`Unit`	`addMediaItems(index: Int, mediaItems: (Mutable)List<MediaItem!>!)` Adds a list of media items at the given index of the playlist.
`Boolean`	`canAdvertiseSession()` Returns whether the player can be used to advertise a media session.
`Unit`	`clearMediaItems()` Clears the playlist.
`Unit`	`clearVideoSurface()` Clears any `Surface`, `SurfaceHolder`, `SurfaceView` or `TextureView` currently set on the player.
`Unit`	`clearVideoSurface(surface: Surface?)` Clears the `Surface` onto which video is being rendered if it matches the one passed.
`Unit`	`clearVideoSurfaceHolder(surfaceHolder: SurfaceHolder?)` Clears the `SurfaceHolder` that holds the `Surface` onto which video is being rendered if it matches the one passed.
`Unit`	`clearVideoSurfaceView(surfaceView: SurfaceView?)` Clears the `SurfaceView` onto which video is being rendered if it matches the one passed.
`Unit`	`clearVideoTextureView(textureView: TextureView?)` Clears the `TextureView` onto which video is being rendered if it matches the one passed.
`Unit`	`decreaseDeviceVolume()` This function is deprecated. Use `decreaseDeviceVolume` instead.
`Unit`	`decreaseDeviceVolume(@C.VolumeFlags flags: Int)` Decreases the volume of the device.
`Looper!`	`getApplicationLooper()` Returns the `Looper` associated with the application thread that's used to access the player and on which player events are received.
`AudioAttributes!`	`getAudioAttributes()` Returns the attributes for audio playback.
`Player.Commands!`	`getAvailableCommands()` Returns the player's currently available `Commands`.
`SessionCommands!`	`getAvailableSessionCommands()` Returns the current available session commands from `onAvailableSessionCommandsChanged`, or `EMPTY` if it is not connected.
`@IntRange(from = 0, to = 100) Int`	`getBufferedPercentage()` Returns an estimate of the percentage in the current content or ad up to which data is buffered, or 0 if no estimate is available.
`Long`	`getBufferedPosition()` Returns an estimate of the position in the current content or ad up to which data is buffered, in milliseconds.
`SessionToken?`	`getConnectedToken()` Returns the `SessionToken` of the connected session, or `null` if it is not connected.
`Long`	`getContentBufferedPosition()` If #isPlayingAd() returns true}, returns an estimate of the content position in the current content up to which data is buffered, in milliseconds.
`Long`	`getContentDuration()` If #isPlayingAd() returns true}, returns the duration of the current content in milliseconds, or C#TIME_UNSET if the duration is not known.
`Long`	`getContentPosition()` If #isPlayingAd() returns true}, returns the content position that will be played once all ads in the ad group have finished playing, in milliseconds.
`Int`	`getCurrentAdGroupIndex()` If `isPlayingAd` returns true, returns the index of the ad group in the period currently being played.
`Int`	`getCurrentAdIndexInAdGroup()` If `isPlayingAd` returns true, returns the index of the ad in its ad group.
`CueGroup!`	`getCurrentCues()` Returns the current `CueGroup`.
`Long`	`getCurrentLiveOffset()` Returns the offset of the current playback position from the live edge in milliseconds, or `TIME_UNSET` if the current `MediaItemisn't live` or the offset is unknown.
`Any?`	`@UnstableApi getCurrentManifest()` Returns `null`.
`MediaItem?`	`getCurrentMediaItem()` Returns the currently playing `MediaItem`.
`Int`	`getCurrentMediaItemIndex()` Returns the index of the current `MediaItem` in the `timeline`, or the prospective index if the `current timeline` is empty.
`Int`	`getCurrentPeriodIndex()` Returns the index of the period currently being played.
`Long`	`getCurrentPosition()` Returns the playback position in the current content or ad, in milliseconds, or the prospective position in milliseconds if the `current timeline` is empty.
`Timeline!`	`getCurrentTimeline()` Returns the current .
`Tracks!`	`getCurrentTracks()` Returns the current tracks.
`Int`	`@UnstableApi getCurrentWindowIndex()` This function is deprecated. Use `getCurrentMediaItemIndex` instead.
`ImmutableList<CommandButton!>!`	`@UnstableApi getCustomLayout()` Returns the custom layout.
`DeviceInfo!`	`getDeviceInfo()` Gets the device information.
`@IntRange(from = 0) Int`	`getDeviceVolume()` Gets the current volume of the device.
`Long`	`getDuration()` Returns the duration of the current content or ad in milliseconds, or `TIME_UNSET` if the duration is not known.
`Long`	`getMaxSeekToPreviousPosition()` Returns the maximum position for which #seekToPrevious() seeks to the previous * , in milliseconds.
`MediaItem!`	`getMediaItemAt(index: Int)` Returns the `MediaItem` at the given index.
`Int`	`getMediaItemCount()` Returns the number of `media items` in the playlist.
`MediaMetadata!`	`getMediaMetadata()` Returns the current combined `MediaMetadata`, or `EMPTY` if not supported.
`Int`	`getNextMediaItemIndex()` Returns the index of the that will be played if * #seekToNextMediaItem() is called, which may depend on the current repeat mode and whether shuffle mode is enabled.
`Int`	`@UnstableApi getNextWindowIndex()` This function is deprecated. Use `getNextMediaItemIndex` instead.
`Boolean`	`getPlayWhenReady()` Whether playback will proceed when `getPlaybackState` == `STATE_READY`.
`PlaybackParameters!`	`getPlaybackParameters()` Returns the currently active playback parameters.
`Int`	`@Player.State getPlaybackState()` Returns the current `playback state` of the player.
`Int`	`@Player.PlaybackSuppressionReason getPlaybackSuppressionReason()` Returns the reason why playback is suppressed even though `getPlayWhenReady` is `true`, or `PLAYBACK_SUPPRESSION_REASON_NONE` if playback is not suppressed.
`PlaybackException?`	`getPlayerError()` Returns the error that caused playback to fail.
`MediaMetadata!`	`getPlaylistMetadata()` Returns the playlist `MediaMetadata`, as set by `setPlaylistMetadata`, or `EMPTY` if not supported.
`Int`	`getPreviousMediaItemIndex()` Returns the index of the that will be played if * #seekToPreviousMediaItem() is called, which may depend on the current repeat mode and whether shuffle mode is enabled.
`Int`	`@UnstableApi getPreviousWindowIndex()` This function is deprecated. Use `getPreviousMediaItemIndex` instead.
`Int`	`@Player.RepeatMode getRepeatMode()` Returns the current `RepeatMode` used for playback.
`Long`	`getSeekBackIncrement()` Returns the #seekBack() increment.
`Long`	`getSeekForwardIncrement()` Returns the #seekForward() increment.
`PendingIntent?`	`getSessionActivity()` Returns an intent for launching UI associated with the session if exists, or `null`.
`Bundle!`	`@UnstableApi getSessionExtras()` Returns the session extras.
`Boolean`	`getShuffleModeEnabled()` Returns whether shuffling of media items is enabled.
`Size!`	`@UnstableApi getSurfaceSize()` Gets the size of the surface on which the video is rendered.
`Long`	`getTotalBufferedDuration()` Returns an estimate of the total buffered duration from the current position, in milliseconds.
`TrackSelectionParameters!`	`getTrackSelectionParameters()` Returns the parameters constraining the track selection.
`VideoSize!`	`getVideoSize()` Gets the size of the video.
`@FloatRange(from = 0, to = 1) Float`	`getVolume()` Returns the audio volume, with 0 being silence and 1 being unity gain (signal unchanged).
`Boolean`	`@UnstableApi hasNext()` This function is deprecated. Use `hasNextMediaItem` instead.
`Boolean`	`hasNextMediaItem()` Returns whether a next `MediaItem` exists, which may depend on the current repeat mode and whether shuffle mode is enabled.
`Boolean`	`@UnstableApi hasNextWindow()` This function is deprecated. Use `hasNextMediaItem` instead.
`Boolean`	`@UnstableApi hasPrevious()` This function is deprecated. Use `hasPreviousMediaItem` instead.
`Boolean`	`hasPreviousMediaItem()` Returns whether a previous media item exists, which may depend on the current repeat mode and whether shuffle mode is enabled.
`Boolean`	`@UnstableApi hasPreviousWindow()` This function is deprecated. Use `hasPreviousMediaItem` instead.
`Unit`	`increaseDeviceVolume()` This function is deprecated. Use `increaseDeviceVolume` instead.
`Unit`	`increaseDeviceVolume(@C.VolumeFlags flags: Int)` Increases the volume of the device.
`Boolean`	`isCommandAvailable(@Player.Command command: Int)` Returns whether the provided `Command` is available.
`Boolean`	`isConnected()` Returns whether this controller is connected to a `MediaSession` or not.
`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 is empty.
`Boolean`	`@UnstableApi isCurrentWindowDynamic()` This function is deprecated. Use `isCurrentMediaItemDynamic` instead.
`Boolean`	`@UnstableApi isCurrentWindowLive()` This function is deprecated. Use `isCurrentMediaItemLive` instead.
`Boolean`	`@UnstableApi isCurrentWindowSeekable()` This function is deprecated. Use `isCurrentMediaItemSeekable` instead.
`Boolean`	`isDeviceMuted()` Gets whether the device is muted or not.
`Boolean`	`isLoading()` Whether the player is currently loading the source.
`Boolean`	`isPlaying()` Returns whether the player is playing, i.e. `getCurrentPosition` is advancing.
`Boolean`	`isPlayingAd()` Returns whether the player is currently playing an ad.
`Boolean`	`isSessionCommandAvailable( @SessionCommand.CommandCode sessionCommandCode: Int )` Returns whether the `SessionCommand.CommandCode` is available.
`Boolean`	`isSessionCommandAvailable(sessionCommand: SessionCommand!)` Returns whether the `SessionCommand` is available.
`Unit`	`moveMediaItem(currentIndex: Int, newIndex: Int)` Moves the media item at the current index to the new index.
`Unit`	`moveMediaItems(fromIndex: Int, toIndex: Int, newIndex: Int)` Moves the media item range to the new index.
`Unit`	`@UnstableApi next()` This function is deprecated. Use `seekToNextMediaItem` instead.
`Unit`	`pause()` Pauses playback.
`Unit`	`play()` Resumes playback as soon as `getPlaybackState` == `STATE_READY`.
`Unit`	`prepare()` Prepares the player.
`Unit`	`@UnstableApi previous()` This function is deprecated. Use `seekToPreviousMediaItem` instead.
`Unit`	`release()` Releases the connection between `MediaController` and `MediaSession`.
`java-static Unit`	`releaseFuture(controllerFuture: Future<MediaController!>!)` Releases the future controller returned by `buildAsync`.
`Unit`	`removeListener(listener: Player.Listener!)` Unregister a listener registered through `addListener`.
`Unit`	`removeMediaItem(index: Int)` Removes the media item at the given index of the playlist.
`Unit`	`removeMediaItems(fromIndex: Int, toIndex: Int)` Removes a range of media items from the playlist.
`Unit`	`replaceMediaItem(index: Int, mediaItem: MediaItem!)` Replaces the media item at the given index of the playlist.
`Unit`	`replaceMediaItems( fromIndex: Int, toIndex: Int, mediaItems: (Mutable)List<MediaItem!>! )` Replaces the media items at the given range of the playlist.
`Unit`	`seekBack()` Seeks back in the current by #getSeekBackIncrement() milliseconds.
`Unit`	`seekForward()` Seeks forward in the current 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 (if available).
`Unit`	`seekToNextMediaItem()` Seeks to the default position of the next , which may depend on the current repeat mode and whether shuffle mode is enabled.
`Unit`	`@UnstableApi seekToNextWindow()` This function is deprecated. Use `seekToNextMediaItem` instead.
`Unit`	`seekToPrevious()` Seeks to an earlier position in the current or previous (if available).
`Unit`	`seekToPreviousMediaItem()` Seeks to the default position of the previous , which may depend on the current repeat mode and whether shuffle mode is enabled.
`Unit`	`@UnstableApi seekToPreviousWindow()` This function is deprecated. Use `seekToPreviousMediaItem` instead.
`ListenableFuture<SessionResult!>!`	`sendCustomCommand(command: SessionCommand!, args: Bundle!)` Sends a custom command to the session.
`Unit`	`setAudioAttributes( audioAttributes: AudioAttributes!, handleAudioFocus: Boolean )` Sets the attributes for audio playback, used by the underlying audio track.
`Unit`	`setDeviceMuted(muted: Boolean)` This function is deprecated. Use `setDeviceMuted` instead.
`Unit`	`setDeviceMuted(muted: Boolean, @C.VolumeFlags flags: Int)` Sets the mute state of the device.
`Unit`	`setDeviceVolume(volume: @IntRange(from = 0) Int)` This function is deprecated. Use `setDeviceVolume` instead.
`Unit`	`setDeviceVolume(volume: @IntRange(from = 0) Int, @C.VolumeFlags flags: Int)` Sets the volume of the device with volume flags.
`Unit`	`setMediaItem(mediaItem: MediaItem!)` Clears the playlist, adds the specified `MediaItem` and resets the position to the default position.
`Unit`	`setMediaItem(mediaItem: MediaItem!, resetPosition: Boolean)` Clears the playlist and adds the specified `MediaItem`.
`Unit`	`setMediaItem(mediaItem: MediaItem!, startPositionMs: Long)` Clears the playlist and adds the specified `MediaItem`.
`Unit`	`setMediaItems(mediaItems: (Mutable)List<MediaItem!>!)` Clears the playlist, adds the specified `media items` and resets the position to the default position.
`Unit`	`setMediaItems( mediaItems: (Mutable)List<MediaItem!>!, resetPosition: Boolean )` Clears the playlist and adds the specified `media items`.
`Unit`	`setMediaItems( mediaItems: (Mutable)List<MediaItem!>!, startIndex: Int, startPositionMs: Long )` Clears the playlist and adds the specified `media items`.
`Unit`	`setPlayWhenReady(playWhenReady: Boolean)` Sets whether playback should proceed when `getPlaybackState` == `STATE_READY`.
`Unit`	`setPlaybackParameters(playbackParameters: PlaybackParameters!)` Attempts to set the playback parameters.
`Unit`	`setPlaybackSpeed(speed: Float)` Changes the rate at which playback occurs.
`Unit`	`setPlaylistMetadata(playlistMetadata: MediaMetadata!)` Sets the playlist `MediaMetadata`.
`ListenableFuture<SessionResult!>!`	`setRating(rating: Rating!)` Requests that the connected `MediaSession` rates the current media item.
`ListenableFuture<SessionResult!>!`	`setRating(mediaId: String!, rating: Rating!)` Requests that the connected `MediaSession` rates the media.
`Unit`	`setRepeatMode(@Player.RepeatMode repeatMode: Int)` Sets the `RepeatMode` to be used for playback.
`Unit`	`setShuffleModeEnabled(shuffleModeEnabled: Boolean)` Sets whether shuffling of media items is enabled.
`Unit`	`setTrackSelectionParameters(parameters: TrackSelectionParameters!)` Sets the parameters constraining the track selection.
`Unit`	`setVideoSurface(surface: Surface?)` Sets the `Surface` onto which video will be rendered.
`Unit`	`setVideoSurfaceHolder(surfaceHolder: SurfaceHolder?)` Sets the `SurfaceHolder` that holds the `Surface` onto which video will be rendered.
`Unit`	`setVideoSurfaceView(surfaceView: SurfaceView?)` Sets the `SurfaceView` onto which video will be rendered.
`Unit`	`setVideoTextureView(textureView: TextureView?)` Sets the `TextureView` onto which video will be rendered.
`Unit`	`setVolume(volume: @FloatRange(from = 0, to = 1) Float)` Sets the audio volume, valid values are between 0 (silence) and 1 (unity gain, signal unchanged), inclusive.
`Unit`	`stop()` Stops playback without resetting the playlist.

Inherited Constants

From androidx.media3.common.Player

`const Int`	`COMMAND_ADJUST_DEVICE_VOLUME = 26` This property is deprecated. Use `COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS` instead.
`const Int`	`COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS = 34` Command to increase and decrease the device volume and mute it with volume flags.
`const Int`	`COMMAND_CHANGE_MEDIA_ITEMS = 20` Command to change the `media items` in the playlist.
`const Int`	`COMMAND_GET_AUDIO_ATTRIBUTES = 21` Command to get the player current `AudioAttributes`.
`const Int`	`COMMAND_GET_CURRENT_MEDIA_ITEM = 16` Command to get information about the currently playing `MediaItem`.
`const Int`	`COMMAND_GET_DEVICE_VOLUME = 23` Command to get the device volume and whether it is muted.
`const Int`	`COMMAND_GET_MEDIA_ITEMS_METADATA = 18` This property is deprecated. Use `COMMAND_GET_METADATA` instead.
`const Int`	`COMMAND_GET_METADATA = 18` Command to get metadata related to the playlist and current `MediaItem`.
`const Int`	`COMMAND_GET_TEXT = 28` Command to get the text that should currently be displayed by the player.
`const Int`	`COMMAND_GET_TIMELINE = 17` Command to get the information about the current timeline.
`const Int`	`COMMAND_GET_TRACKS = 30` Command to get details of the current track selection.
`const Int`	`COMMAND_GET_VOLUME = 22` Command to get the player volume.
`const Int`	`COMMAND_INVALID = -1` Represents an invalid `Command`.
`const Int`	`COMMAND_PLAY_PAUSE = 1` Command to start, pause or resume playback.
`const Int`	`COMMAND_PREPARE = 2` Command to prepare the player.
`const Int`	`COMMAND_RELEASE = 32` Command to release the player.
`const Int`	`COMMAND_SEEK_BACK = 11` Command to seek back by a fixed increment inside the current `MediaItem`.
`const Int`	`COMMAND_SEEK_FORWARD = 12` Command to seek forward by a fixed increment inside the current `MediaItem`.
`const Int`	`COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM = 5` Command to seek anywhere inside the current `MediaItem`.
`const Int`	`@UnstableApi COMMAND_SEEK_IN_CURRENT_WINDOW = 5` This property is deprecated. Use `COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM` instead.
`const Int`	`COMMAND_SEEK_TO_DEFAULT_POSITION = 4` Command to seek to the default position of the current `MediaItem`.
`const Int`	`COMMAND_SEEK_TO_MEDIA_ITEM = 10` Command to seek anywhere in any `MediaItem`.
`const Int`	`COMMAND_SEEK_TO_NEXT = 9` Command to seek to a later position in the current `MediaItem` or the default position of the next `MediaItem`.
`const Int`	`COMMAND_SEEK_TO_NEXT_MEDIA_ITEM = 8` Command to seek to the default position of the next `MediaItem`.
`const Int`	`@UnstableApi COMMAND_SEEK_TO_NEXT_WINDOW = 8` This property is deprecated. Use `COMMAND_SEEK_TO_NEXT_MEDIA_ITEM` instead.
`const Int`	`COMMAND_SEEK_TO_PREVIOUS = 7` Command to seek to an earlier position in the current `MediaItem` or the default position of the previous `MediaItem`.
`const Int`	`COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM = 6` Command to seek to the default position of the previous `MediaItem`.
`const Int`	`@UnstableApi COMMAND_SEEK_TO_PREVIOUS_WINDOW = 6` This property is deprecated. Use `COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM` instead.
`const Int`	`@UnstableApi COMMAND_SEEK_TO_WINDOW = 10` This property is deprecated. Use `COMMAND_SEEK_TO_MEDIA_ITEM` instead.
`const Int`	`COMMAND_SET_AUDIO_ATTRIBUTES = 35` Command to set the player's audio attributes.
`const Int`	`COMMAND_SET_DEVICE_VOLUME = 25` This property is deprecated. Use `COMMAND_SET_DEVICE_VOLUME_WITH_FLAGS` instead.
`const Int`	`COMMAND_SET_DEVICE_VOLUME_WITH_FLAGS = 33` Command to set the device volume with volume flags.
`const Int`	`COMMAND_SET_MEDIA_ITEM = 31` Command to set a `MediaItem`.
`const Int`	`COMMAND_SET_MEDIA_ITEMS_METADATA = 19` This property is deprecated. Use `COMMAND_SET_PLAYLIST_METADATA` instead.
`const Int`	`COMMAND_SET_PLAYLIST_METADATA = 19` Command to set the playlist metadata.
`const Int`	`COMMAND_SET_REPEAT_MODE = 15` Command to set the repeat mode.
`const Int`	`COMMAND_SET_SHUFFLE_MODE = 14` Command to enable shuffling.
`const Int`	`COMMAND_SET_SPEED_AND_PITCH = 13` Command to set the playback speed and pitch.
`const Int`	`COMMAND_SET_TRACK_SELECTION_PARAMETERS = 29` Command to set the player's track selection parameters.
`const Int`	`COMMAND_SET_VIDEO_SURFACE = 27` Command to set and clear the surface on which to render the video.
`const Int`	`COMMAND_SET_VOLUME = 24` Command to set the player volume.
`const Int`	`COMMAND_STOP = 3` Command to stop playback.
`const Int`	`DISCONTINUITY_REASON_AUTO_TRANSITION = 0` Automatic playback transition from one period in the timeline to the next.
`const Int`	`DISCONTINUITY_REASON_INTERNAL = 5` Discontinuity introduced internally (e.g. by the source).
`const Int`	`DISCONTINUITY_REASON_REMOVE = 4` Discontinuity caused by the removal of the current period from the `Timeline`.
`const Int`	`DISCONTINUITY_REASON_SEEK = 1` Seek within the current period or to another period.
`const Int`	`DISCONTINUITY_REASON_SEEK_ADJUSTMENT = 2` Seek adjustment due to being unable to seek to the requested position or because the seek was permitted to be inexact.
`const Int`	`DISCONTINUITY_REASON_SILENCE_SKIP = 6` Discontinuity introduced by a skipped silence.
`const Int`	`DISCONTINUITY_REASON_SKIP = 3` Discontinuity introduced by a skipped period (for instance a skipped ad).
`const Int`	`EVENT_AUDIO_ATTRIBUTES_CHANGED = 20` `getAudioAttributes` changed.
`const Int`	`EVENT_AUDIO_SESSION_ID = 21` The audio session id was set.
`const Int`	`EVENT_AVAILABLE_COMMANDS_CHANGED = 13` `isCommandAvailable` changed for at least one `Command`.
`const Int`	`EVENT_CUES = 27` `getCurrentCues` changed.
`const Int`	`EVENT_DEVICE_INFO_CHANGED = 29` `getDeviceInfo` changed.
`const Int`	`EVENT_DEVICE_VOLUME_CHANGED = 30` `getDeviceVolume` 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_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).

Constants

KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG

@UnstableApi
const val KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG = "androidx.media3.session.MediaNotificationManager": String!

Key to mark the connection hints of the media notification controller.

For a controller to be recognized by the session as the media notification controller, this key needs to be used to set a boolean flag in the connection hints to true. Only an internal controller that has the same package name as the session can be used as a media notification controller.

When using a session within a MediaSessionService or MediaLibraryService, the service connects a media notification controller automatically. Apps can do this for standalone session to configure the platform session in the same way.

RELEASE_UNBIND_TIMEOUT_MS

@UnstableApi
const val RELEASE_UNBIND_TIMEOUT_MS = 30000: Long

The timeout for handling pending commands after calling release. If the timeout is reached, the controller is unbound from the session service even if commands are still pending.

Public functions

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.

addMediaItem

fun addMediaItem(mediaItem: MediaItem!): Unit

Adds a media item to the end of the playlist.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`mediaItem: MediaItem!`	The `MediaItem` to add.

addMediaItem

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

Adds a media item 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 item. If the index is larger than the size of the playlist, the media item is added to the end of the playlist.
`mediaItem: MediaItem!`	The `MediaItem` to add.

addMediaItems

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

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

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`mediaItems: (Mutable)List<MediaItem!>!`	The `media items` to add.

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.

canAdvertiseSession

fun canAdvertiseSession(): Boolean

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

The MediaController returns false.

clearMediaItems

fun clearMediaItems(): Unit

Clears the playlist.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

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.

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

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.

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`

getAvailableSessionCommands

fun getAvailableSessionCommands(): SessionCommands!

Returns the current available session commands from onAvailableSessionCommandsChanged, or EMPTY if it is not connected.

Returns
`SessionCommands!`	The available session commands.

getBufferedPercentage

fun getBufferedPercentage(): @IntRange(from = 0, to = 100) Int

Returns an estimate of the percentage in the current content or ad up to which data is buffered, or 0 if no estimate is available.

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.

getConnectedToken

fun getConnectedToken(): SessionToken?

Returns the SessionToken of the connected session, or null if it is not connected.

This may differ from the SessionToken from the constructor. For example, if the controller is created with the token for MediaSessionService, this will return a token for the MediaSession in the service.

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

Interoperability: When connected to , it's the same as getBufferedPosition because content buffered position isn't available.

getContentDuration

fun getContentDuration(): Long

If #isPlayingAd() returns true}, returns the duration of the current content in milliseconds, or C#TIME_UNSET if the duration is not known. If there is no ad playing, the returned duration is the same as that returned by #getDuration().

This method must only be called if #COMMAND_GET_CURRENT_MEDIA_ITEM is * #getAvailableCommands() available.

Interoperability: When connected to , it's the same as getDuration to match the behavior with getContentPosition and getContentBufferedPosition.

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

Interoperability: When connected to , it's the same as getCurrentPosition because content position isn't 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.

getCurrentLiveOffset

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

The offset is calculated as currentTime - playbackPosition, so should usually be positive.

Note that this offset may rely on an accurate local time, so this method may return an incorrect value if the difference between system clock and server clock is unknown.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

getCurrentManifest

@UnstableApi
fun getCurrentManifest(): Any?

Returns null.

getCurrentMediaItem

fun getCurrentMediaItem(): MediaItem?

Returns the currently playing MediaItem. May be null if the timeline is empty.

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

See also
`onMediaItemTransition`

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 . Never null, but may be empty.

This method must only be called if #COMMAND_GET_TIMELINE is * #getAvailableCommands() available.

Caveat: Some methods of the Timeline such as getPeriodByUid, getIndexOfPeriod, and getUidOfPeriod will throw UnsupportedOperationException because of the limitation of restoring the instance sent from session as described in CREATOR.

getCurrentTracks

fun getCurrentTracks(): Tracks!

Returns the current tracks.

This method must only be called if COMMAND_GET_TRACKS is available.

See also
`onTracksChanged`

getCurrentWindowIndex

@UnstableApi
fun getCurrentWindowIndex(): Int

getCustomLayout

@UnstableApi
fun getCustomLayout(): ImmutableList<CommandButton!>!

Returns the custom layout.

After being connected, a change of the custom layout is reported with onCustomLayoutChanged.

Returns
`ImmutableList<CommandButton!>!`	The custom layout.

getDeviceInfo

fun getDeviceInfo(): DeviceInfo!

Gets the device information.

getDeviceVolume

fun getDeviceVolume(): @IntRange(from = 0) 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.

Interoperability: When connected to , it always returns 0.

getMediaItemAt

fun getMediaItemAt(index: Int): MediaItem!

Returns the MediaItem at the given index.

This method must only be called if COMMAND_GET_TIMELINE is available.

getMediaItemCount

fun getMediaItemCount(): Int

Returns the number of media items in the playlist.

This method must only be called if COMMAND_GET_TIMELINE is available.

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.

getNextMediaItemIndex

fun getNextMediaItemIndex(): Int

Returns the index of the that will be played if * #seekToNextMediaItem() is called, which may depend on the current repeat mode and whether shuffle mode is enabled. Returns C#INDEX_UNSET if #hasNextMediaItem() is *false.

Note: When the repeat mode is #REPEAT_MODE_ONE, this method behaves the same as when the current repeat mode is #REPEAT_MODE_OFF. See #REPEAT_MODE_ONE for more details.

This method must only be called if #COMMAND_GET_TIMELINE is * #getAvailableCommands() available.

Interoperability: When connected to , this will always return INDEX_UNSET even when hasNextMediaItem is true.

getNextWindowIndex

@UnstableApi
fun getNextWindowIndex(): Int

getPlayWhenReady

fun getPlayWhenReady(): Boolean

Whether playback will proceed when getPlaybackState == STATE_READY.

Returns
`Boolean`	Whether playback will proceed when ready.

See also
`onPlayWhenReadyChanged`

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(): PlaybackException?

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

getPreviousMediaItemIndex

fun getPreviousMediaItemIndex(): Int

Returns the index of the that will be played if * #seekToPreviousMediaItem() is called, which may depend on the current repeat mode and whether shuffle mode is enabled. Returns C#INDEX_UNSET if #hasPreviousMediaItem() is false}.

Note: When the repeat mode is #REPEAT_MODE_ONE, this method behaves the same as when the current repeat mode is #REPEAT_MODE_OFF. See #REPEAT_MODE_ONE for more details.

This method must only be called if #COMMAND_GET_TIMELINE is * #getAvailableCommands() available.

Interoperability: When connected to , this will always return INDEX_UNSET even when hasPreviousMediaItem is true.

getPreviousWindowIndex

@UnstableApi
fun getPreviousWindowIndex(): Int

getRepeatMode

@Player.RepeatMode
fun getRepeatMode(): Int

Returns the current RepeatMode used for playback.

Returns
`Int`	The current repeat mode.

See also
`onRepeatModeChanged`

getSeekBackIncrement

fun getSeekBackIncrement(): Long

Returns the #seekBack() increment.

Interoperability: When connected to MediaSessionCompat, it returns {code 0}.

getSeekForwardIncrement

fun getSeekForwardIncrement(): Long

Returns the #seekForward() increment.

Interoperability: When connected to MediaSessionCompat, it returns {code 0}.

getSessionActivity

fun getSessionActivity(): PendingIntent?

Returns an intent for launching UI associated with the session if exists, or null.

getSessionExtras

@UnstableApi
fun getSessionExtras(): Bundle!

Returns the session extras.

After being connected, onExtrasChanged is called when the extras on the session are set.

Returns
`Bundle!`	The session extras.

getShuffleModeEnabled

fun getShuffleModeEnabled(): Boolean

Returns whether shuffling of media items is enabled.

See also
`onShuffleModeEnabledChanged`

getSurfaceSize

@UnstableApi
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`	}

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(): @FloatRange(from = 0, to = 1) 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
`@FloatRange(from = 0, to = 1) Float`	The linear gain applied to all audio channels.

hasNext

@UnstableApi
fun hasNext(): Boolean

hasNextMediaItem

fun hasNextMediaItem(): Boolean

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

Note: When the repeat mode is REPEAT_MODE_ONE, this method behaves the same as when the current repeat mode is REPEAT_MODE_OFF. See REPEAT_MODE_ONE for more details.

This method must only be called if COMMAND_GET_TIMELINE is available.

hasNextWindow

@UnstableApi
fun hasNextWindow(): Boolean

hasPrevious

@UnstableApi
fun hasPrevious(): Boolean

hasPreviousMediaItem

fun hasPreviousMediaItem(): Boolean

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

Note: When the repeat mode is REPEAT_MODE_ONE, this method behaves the same as when the current repeat mode is REPEAT_MODE_OFF. See REPEAT_MODE_ONE for more details.

This method must only be called if COMMAND_GET_TIMELINE is available.

hasPreviousWindow

@UnstableApi
fun hasPreviousWindow(): Boolean

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

isCommandAvailable

fun isCommandAvailable(@Player.Command command: Int): Boolean

Returns whether the provided Command is available.

This method does not execute the command.

Parameters
`@Player.Command command: Int`	A `Command`.

Returns
`Boolean`	Whether the `Command` is available.

See also
`onAvailableCommandsChanged`

isConnected

fun isConnected(): Boolean

Returns whether this controller is connected to a MediaSession or not.

isCurrentMediaItemDynamic

fun isCurrentMediaItemDynamic(): Boolean

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

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

See also
`isDynamic`

isCurrentMediaItemLive

fun isCurrentMediaItemLive(): Boolean

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

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

See also
`isLive`

isCurrentMediaItemSeekable

fun isCurrentMediaItemSeekable(): Boolean

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

This method must only be called if COMMAND_GET_CURRENT_MEDIA_ITEM is available.

See also
`isSeekable`

isCurrentWindowDynamic

@UnstableApi
fun isCurrentWindowDynamic(): Boolean

isCurrentWindowLive

@UnstableApi
fun isCurrentWindowLive(): Boolean

isCurrentWindowSeekable

@UnstableApi
fun isCurrentWindowSeekable(): Boolean

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.

See also
`onIsLoadingChanged`

isPlaying

fun isPlaying(): Boolean

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

If false, then at least one of the following is true:

The playback state is not ready.
There is no intention to play.
Playback is suppressed for other reasons.

Returns
`Boolean`	Whether the player is playing.

See also
`onIsPlayingChanged`

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.

isSessionCommandAvailable

fun isSessionCommandAvailable(
    @SessionCommand.CommandCode sessionCommandCode: Int
): Boolean

Returns whether the SessionCommand.CommandCode is available. The sessionCommandCode must not be COMMAND_CODE_CUSTOM. Use isSessionCommandAvailable for custom commands.

isSessionCommandAvailable

fun isSessionCommandAvailable(sessionCommand: SessionCommand!): Boolean

Returns whether the SessionCommand is available.

moveMediaItem

fun moveMediaItem(currentIndex: Int, newIndex: Int): Unit

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

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`currentIndex: Int`	The current index of the media item to move. If the index is larger than the size of the playlist, the request is ignored.
`newIndex: Int`	The new index of the media item. If the new index is larger than the size of the playlist the item is moved to the end of the playlist.

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.

@UnstableApi
fun next(): Unit

pause

fun pause(): Unit

Pauses playback. Equivalent to setPlayWhenReady(false).

This method must only be called if COMMAND_PLAY_PAUSE is available.

play

fun play(): Unit

Resumes playback as soon as getPlaybackState == STATE_READY. Equivalent to setPlayWhenReady(true).

This method must only be called if COMMAND_PLAY_PAUSE 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.

@UnstableApi
fun previous(): Unit

release

fun release(): Unit

Releases the connection between MediaController and MediaSession. This method must be called when the controller is no longer required. The controller must not be used after calling this method.

This method does not call release of the underlying player in the session.

releaseFuture

java-static fun releaseFuture(controllerFuture: Future<MediaController!>!): Unit

Releases the future controller returned by buildAsync. It makes sure that the controller is released by canceling the future if the future is not yet done.

Must be called on the application thread of the media controller.

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.

removeMediaItem

fun removeMediaItem(index: Int): Unit

Removes the media item 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 remove the media item. If the index is larger than the size of the playlist, the request is ignored.

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.

replaceMediaItem

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

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

Implementations of this method may attempt to seamlessly continue playback if the currently playing media item is replaced with a compatible one (e.g. same URL, only metadata has changed).

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`index: Int`	The index at which to replace the media item. If the index is larger than the size of the playlist, the request is ignored.
`mediaItem: MediaItem!`	The new `MediaItem`.

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.

seekBack

fun seekBack(): Unit

Seeks back in the current by #getSeekBackIncrement() milliseconds.

This method must only be called if #COMMAND_SEEK_BACK is * #getAvailableCommands() available.

Interoperability: When connected to MediaSessionCompat, it calls rewind.

seekForward

fun seekForward(): Unit

Seeks forward in the current by #getSeekForwardIncrement() milliseconds.

This method must only be called if #COMMAND_SEEK_FORWARD is * #getAvailableCommands() available.

Interoperability: When connected to MediaSessionCompat, it calls fastForward.

seekTo

fun seekTo(positionMs: Long): Unit

Seeks to a position specified in milliseconds in the current MediaItem.

This method must only be called if COMMAND_SEEK_IN_CURRENT_MEDIA_ITEM is available.

Parameters
`positionMs: Long`	The seek position in the current `MediaItem`, or `TIME_UNSET` to seek to the media item's default position.

seekTo

fun seekTo(mediaItemIndex: Int, positionMs: Long): Unit

Seeks to a position specified in milliseconds in the specified MediaItem.

This method must only be called if COMMAND_SEEK_TO_MEDIA_ITEM is available.

Parameters
`mediaItemIndex: Int`	The index of the `MediaItem`. If the index is larger than the size of the playlist, the request is ignored.
`positionMs: Long`	The seek position in the specified `MediaItem`, or `TIME_UNSET` to seek to the media item's default position.

seekToDefaultPosition

fun seekToDefaultPosition(): Unit

Seeks to the default position associated with the current MediaItem. The position can depend on the type of media being played. For live streams it will typically be the live edge. For other streams it will typically be the start.

This method must only be called if COMMAND_SEEK_TO_DEFAULT_POSITION is available.

seekToDefaultPosition

fun seekToDefaultPosition(mediaItemIndex: Int): Unit

Seeks to the default position associated with the specified MediaItem. The position can depend on the type of media being played. For live streams it will typically be the live edge. For other streams it will typically be the start.

This method must only be called if COMMAND_SEEK_TO_MEDIA_ITEM is available.

Parameters
`mediaItemIndex: Int`	The index of the `MediaItem` whose associated default position should be seeked to. If the index is larger than the size of the playlist, the request is ignored.

seekToNext

fun seekToNext(): Unit

Seeks to a later position in the current or next (if available). More precisely:

If the timeline is empty or seeking is not possible, does nothing.
Otherwise, if #hasNextMediaItem() a next media item exists, seeks to the default position of the next .
Otherwise, if the current is #isCurrentMediaItemLive() live and has not ended, seeks to the live edge of the current .
Otherwise, does nothing.

This method must only be called if #COMMAND_SEEK_TO_NEXT is * #getAvailableCommands() available.

Interoperability: When connected to , it won't update the current media item index immediately because the previous media item index is unknown.

seekToNextMediaItem

fun seekToNextMediaItem(): Unit

Seeks to the default position of the next , which may depend on the current repeat mode and whether shuffle mode is enabled. Does nothing if #hasNextMediaItem() is false}.

Note: When the repeat mode is #REPEAT_MODE_ONE, this method behaves the same as when the current repeat mode is #REPEAT_MODE_OFF. See #REPEAT_MODE_ONE for more details.

This method must only be called if #COMMAND_SEEK_TO_NEXT_MEDIA_ITEM is * #getAvailableCommands() available.

Interoperability: When connected to , it's the same as seekToNext.

seekToNextWindow

@UnstableApi
fun seekToNextWindow(): Unit

seekToPrevious

fun seekToPrevious(): Unit

Seeks to an earlier position in the current or previous (if available). More precisely:

If the timeline is empty or seeking is not possible, does nothing.
Otherwise, if the current is #isCurrentMediaItemLive() live and #isCurrentMediaItemSeekable() unseekable, then:
- If #hasPreviousMediaItem() a previous media item exists, seeks to the default position of the previous media item.
- Otherwise, does nothing.
Otherwise, if #hasPreviousMediaItem() a previous media item exists and the #getCurrentPosition() current position is less than * #getMaxSeekToPreviousPosition(), seeks to the default position of the previous * .
Otherwise, seeks to 0 in the current .

This method must only be called if #COMMAND_SEEK_TO_PREVIOUS is * #getAvailableCommands() available.

Interoperability: When connected to , it won't update the current media item index immediately because the previous media item index is unknown.

seekToPreviousMediaItem

fun seekToPreviousMediaItem(): Unit

Seeks to the default position of the previous , which may depend on the current repeat mode and whether shuffle mode is enabled. Does nothing if * #hasPreviousMediaItem() is false}.

Note: When the repeat mode is #REPEAT_MODE_ONE, this method behaves the same as when the current repeat mode is #REPEAT_MODE_OFF. See #REPEAT_MODE_ONE for more details.

This method must only be called if #COMMAND_SEEK_TO_PREVIOUS_MEDIA_ITEM is #getAvailableCommands() available.

Interoperability: When connected to , it's the same as seekToPrevious.

seekToPreviousWindow

@UnstableApi
fun seekToPreviousWindow(): Unit

sendCustomCommand

fun sendCustomCommand(command: SessionCommand!, args: Bundle!): ListenableFuture<SessionResult!>!

Sends a custom command to the session.

A command is not accepted if it is not a custom command or the command is not in the list of available session commands.

Interoperability: When connected to , resultCode will return the custom result code from the android.os.ResultReceiver#onReceiveResult(int, Bundle) instead of the standard result codes defined in the SessionResult.

Parameters
`command: SessionCommand!`	The custom command.
`args: Bundle!`	The additional arguments. May be empty.

Returns
`ListenableFuture<SessionResult!>!`	A `ListenableFuture` of `SessionResult` representing the pending completion.

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.

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: @IntRange(from = 0) Int): Unit

setDeviceVolume

fun setDeviceVolume(volume: @IntRange(from = 0) 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: @IntRange(from = 0) Int`	The volume to set.
`@C.VolumeFlags flags: Int`	Either 0 or a bitwise combination of one or more `C.VolumeFlags`.

setMediaItem

fun setMediaItem(mediaItem: MediaItem!): Unit

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

To replace a media item (possibly seamlessly) without clearing the playlist, use replaceMediaItem.

This method must only be called if COMMAND_SET_MEDIA_ITEM is available.

Parameters
`mediaItem: MediaItem!`	The new `MediaItem`.

setMediaItem

fun setMediaItem(mediaItem: MediaItem!, resetPosition: Boolean): Unit

Clears the playlist and adds the specified MediaItem.

To replace a media item (possibly seamlessly) without clearing the playlist, use replaceMediaItem.

This method must only be called if COMMAND_SET_MEDIA_ITEM is available.

Parameters
`mediaItem: MediaItem!`	The new `MediaItem`.
`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`.

setMediaItem

fun setMediaItem(mediaItem: MediaItem!, startPositionMs: Long): Unit

Clears the playlist and adds the specified MediaItem.

To replace a media item (possibly seamlessly) without clearing the playlist, use replaceMediaItem.

This method must only be called if COMMAND_SET_MEDIA_ITEM is available.

Parameters
`mediaItem: MediaItem!`	The new `MediaItem`.
`startPositionMs: Long`	The position in milliseconds to start playback from. If `TIME_UNSET` is passed, the default position of the given `MediaItem` is used.

setMediaItems

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

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

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

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.

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.

setPlaybackSpeed

fun setPlaybackSpeed(speed: Float): Unit

Changes the rate at which playback occurs. The pitch is not changed.

This is equivalent to setPlaybackParameters(getPlaybackParameters().withSpeed(speed)).

This method must only be called if COMMAND_SET_SPEED_AND_PITCH is available.

Parameters
`speed: Float`	The linear factor by which playback will be sped up. Must be higher than 0. 1 is normal speed, 2 is twice as fast, 0.5 is half normal speed.

setPlaylistMetadata

fun setPlaylistMetadata(playlistMetadata: MediaMetadata!): Unit

Sets the playlist MediaMetadata.

This method must only be called if COMMAND_SET_PLAYLIST_METADATA is available.

setRating

fun setRating(rating: Rating!): ListenableFuture<SessionResult!>!

Requests that the connected MediaSession rates the current media item. This will cause the rating to be set for the current user. The rating style must follow the user rating style from the session. You can get the rating style from the session through the userRating.

If the user rating was null, the media item does not accept setting user rating.

Parameters
`rating: Rating!`	The rating to set.

Returns
`ListenableFuture<SessionResult!>!`	A `ListenableFuture` of `SessionResult` representing the pending completion.

setRating

fun setRating(mediaId: String!, rating: Rating!): ListenableFuture<SessionResult!>!

Requests that the connected MediaSession rates the media. This will cause the rating to be set for the current user. The rating style must follow the user rating style from the session. You can get the rating style from the session through the userRating.

If the user rating was null, the media item does not accept setting user rating.

Parameters
`mediaId: String!`	The non-empty `mediaId`.
`rating: Rating!`	The rating to set.

Returns
`ListenableFuture<SessionResult!>!`	A `ListenableFuture` of `SessionResult` representing the pending completion.

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.

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.

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.

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: @FloatRange(from = 0, to = 1) 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: @FloatRange(from = 0, to = 1) Float`	Linear output gain to apply to all audio channels.

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.

MediaController

Controller Lifecycle

Threading Model

Package Visibility Filter

Backward Compatibility with legacy media sessions

Summary

Nested types

Constants

Public functions

Inherited Constants

Constants

KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG

RELEASE_UNBIND_TIMEOUT_MS

Public functions

addListener

addMediaItem

addMediaItem

addMediaItems

addMediaItems

canAdvertiseSession

clearMediaItems

clearVideoSurface

clearVideoSurface

clearVideoSurfaceHolder

clearVideoSurfaceView

clearVideoTextureView

decreaseDeviceVolume

decreaseDeviceVolume

getApplicationLooper

getAudioAttributes

getAvailableCommands

getAvailableSessionCommands

getBufferedPercentage

getBufferedPosition

getConnectedToken

getContentBufferedPosition

getContentDuration

getContentPosition

getCurrentAdGroupIndex

getCurrentAdIndexInAdGroup

getCurrentCues

getCurrentLiveOffset

getCurrentManifest

getCurrentMediaItem

getCurrentMediaItemIndex

getCurrentPeriodIndex

getCurrentPosition

getCurrentTimeline

getCurrentTracks

getCurrentWindowIndex

getCustomLayout

getDeviceInfo

getDeviceVolume

getDuration

getMaxSeekToPreviousPosition

getMediaItemAt

getMediaItemCount

getMediaMetadata

getNextMediaItemIndex

getNextWindowIndex

getPlayWhenReady

getPlaybackParameters

getPlaybackState

getPlaybackSuppressionReason

getPlayerError

getPlaylistMetadata

getPreviousMediaItemIndex

getPreviousWindowIndex

getRepeatMode

getSeekBackIncrement

getSeekForwardIncrement

getSessionActivity

getSessionExtras

getShuffleModeEnabled

getSurfaceSize

getTotalBufferedDuration

getTrackSelectionParameters

getVideoSize

getVolume

hasNext