CastPlayer

Kotlin |Java

@UnstableApi
class CastPlayer : BasePlayer

kotlin.Any
↳	androidx.media3.common.BasePlayer
	↳	androidx.media3.cast.CastPlayer

Player implementation that communicates with a Cast receiver app.

The behavior of this class depends on the underlying Cast session, which is obtained from the injected CastContext. To keep track of the session, isCastSessionAvailable can be queried and SessionAvailabilityListener can be implemented and attached to the player.

If no session is available, the player state will remain unchanged and calls to methods that alter it will be ignored. Querying the player state is possible even when no session is available, in which case, the last observed receiver app state is reported.

Methods should be called on the application's main thread.

Summary

Constants
`const DeviceInfo!`	`DEVICE_INFO_REMOTE_EMPTY` A `remoteDeviceInfo` with a null `routingControllerId`.
`const Float`	`MAX_SPEED_SUPPORTED = 2.0f`
`const Float`	`MIN_SPEED_SUPPORTED = 0.5f`

Public constructors
`CastPlayer(castContext: CastContext!)` Creates a new cast player.
`CastPlayer( castContext: CastContext!, mediaItemConverter: MediaItemConverter! )` Creates a new cast player.
`CastPlayer( castContext: CastContext!, mediaItemConverter: MediaItemConverter!, seekBackIncrementMs: @IntRange(from = 1) Long, seekForwardIncrementMs: @IntRange(from = 1) Long )` Creates a new cast player.
`CastPlayer( context: Context?, castContext: CastContext!, mediaItemConverter: MediaItemConverter!, seekBackIncrementMs: @IntRange(from = 1) Long, seekForwardIncrementMs: @IntRange(from = 1) Long, maxSeekToPreviousPositionMs: @IntRange(from = 0) Long )` Creates a new cast player.

Public functions
`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`	`clearVideoSurface()` This method is not supported and does nothing.
`Unit`	`clearVideoSurface(surface: Surface?)` This method is not supported and does nothing.
`Unit`	`clearVideoSurfaceHolder(surfaceHolder: SurfaceHolder?)` This method is not supported and does nothing.
`Unit`	`clearVideoSurfaceView(surfaceView: SurfaceView?)` This method is not supported and does nothing.
`Unit`	`clearVideoTextureView(textureView: TextureView?)` This method is not supported and does nothing.
`Unit`	`decreaseDeviceVolume()` This function is deprecated. Use `decreaseDeviceVolume` instead.
`Unit`	`decreaseDeviceVolume(@C.VolumeFlags flags: Int)` This method is not supported and does nothing.
`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()` This method is not supported and returns `DEFAULT`.
`Long`	`getBufferedPosition()` Returns an estimate of the position in the current content or ad up to which data is buffered, in milliseconds.
`Long`	`getContentBufferedPosition()` If `isPlayingAd` returns `true`, returns an estimate of the content position in the current content up to which data is buffered, in milliseconds.
`Long`	`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()` This method is not supported and returns an empty `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`.
`Int`	`getDeviceVolume()` This method is not supported and always returns `0`.
`Long`	`getDuration()` Returns the duration of the current content or ad in milliseconds, or `TIME_UNSET` if the duration is not known.
`MediaQueueItem?`	`getItem(periodId: Int)` Returns the item that corresponds to the period with the given id, or null if no media queue or period with id `periodId` exist.
`Long`	`getMaxSeekToPreviousPosition()` Returns the maximum position for which `seekToPrevious` seeks to the previous , in milliseconds.
`MediaMetadata!`	`getMediaMetadataInternal()`
`Boolean`	`getPlayWhenReady()` Whether playback will proceed when `getPlaybackState` == `STATE_READY`.
`PlaybackParameters!`	`getPlaybackParameters()` Returns the currently active playback parameters.
`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`	`@Player.RepeatMode getRepeatMode()` Returns the current `RepeatMode` used for playback.
`Long`	`getSeekBackIncrement()` Returns the `seekBack` increment.
`Long`	`getSeekForwardIncrement()` Returns the `seekForward` increment.
`Boolean`	`getShuffleModeEnabled()` Returns whether shuffling of media items is enabled.
`Size!`	`getSurfaceSize()` This method is not supported and returns `UNKNOWN`.
`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()` This method is not supported and returns `UNKNOWN`.
`Float`	`getVolume()` This method is not supported and returns 1.
`Unit`	`increaseDeviceVolume()` This function is deprecated. Use `increaseDeviceVolume` instead.
`Unit`	`increaseDeviceVolume(@C.VolumeFlags flags: Int)` This method is not supported and does nothing.
`Boolean`	`isCastSessionAvailable()` Returns whether a cast session is available.
`Boolean`	`isDeviceMuted()` This method is not supported and always returns `false`.
`Boolean`	`isLoading()` Whether the player is currently loading the source.
`Boolean`	`isPlayingAd()` Returns whether the player is currently playing an ad.
`Unit`	`moveMediaItems(fromIndex: Int, toIndex: Int, newIndex: Int)` Moves the media item range to the new index.
`Unit`	`prepare()` Prepares the player.
`Unit`	`release()` Releases the player.
`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`	`@VisibleForTesting(otherwise = 4) seekTo( mediaItemIndex: Int, positionMs: Long, @Player.Command seekCommand: Int, isRepeatingCurrentItem: Boolean )` Seeks to a position in the specified `MediaItem`.
`Unit`	`setAudioAttributes( audioAttributes: AudioAttributes!, handleAudioFocus: Boolean )` This method is not supported and does nothing.
`Unit`	`setDeviceMuted(muted: Boolean)` This function is deprecated. Use `setDeviceMuted` instead.
`Unit`	`setDeviceMuted(muted: Boolean, @C.VolumeFlags flags: Int)` This method is not supported and does nothing.
`Unit`	`setDeviceVolume(volume: Int)` This function is deprecated. Use `setDeviceVolume` instead.
`Unit`	`setDeviceVolume(volume: Int, @C.VolumeFlags flags: Int)` This method is not supported and does nothing.
`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`	`setPlaylistMetadata(mediaMetadata: MediaMetadata!)` This method is not supported and does nothing.
`Unit`	`setRepeatMode(@Player.RepeatMode repeatMode: Int)` Sets the `RepeatMode` to be used for playback.
`Unit`	`setSessionAvailabilityListener(listener: SessionAvailabilityListener?)` Sets a listener for updates on the cast session availability.
`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?)` This method is not supported and does nothing.
`Unit`	`setVideoSurfaceHolder(surfaceHolder: SurfaceHolder?)` This method is not supported and does nothing.
`Unit`	`setVideoSurfaceView(surfaceView: SurfaceView?)` This method is not supported and does nothing.
`Unit`	`setVideoTextureView(textureView: TextureView?)` This method is not supported and does nothing.
`Unit`	`setVolume(volume: Float)` This method is not supported and does nothing.
`Unit`	`stop()` Stops playback without resetting the playlist.

Public properties
`Player.Commands!`	`availableCommands`
`Tracks!`	`currentTracks`
`DeviceInfo!`	`deviceInfo`
`MediaMetadata!`	`mediaMetadata`
`Int`	`@Player.State playbackState`

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

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`	`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`	`hasNextWindow()` This function is deprecated. Use `hasNextMediaItem` 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`	`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 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`	`next()` This function is deprecated. Use `seekToNextMediaItem` instead.
`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`	`seekToNextWindow()` This function is deprecated. Use `seekToNextMediaItem` instead.
`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`	`seekToPreviousWindow()` This function is deprecated. Use `seekToPreviousMediaItem` instead.
`Unit`	`setMediaItem(mediaItem: MediaItem!)` Clears the playlist, adds the specified `MediaItem` and resets the position to the default position.
`Unit`	`setMediaItem(mediaItem: MediaItem!, resetPosition: Boolean)` Clears the playlist and adds the specified `MediaItem`.
`Unit`	`setMediaItem(mediaItem: MediaItem!, startPositionMs: Long)` Clears the playlist and adds the specified `MediaItem`.
`Unit`	`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

Constants

DEVICE_INFO_REMOTE_EMPTY

const val DEVICE_INFO_REMOTE_EMPTY: DeviceInfo!

A remoteDeviceInfo with a null routingControllerId.

MAX_SPEED_SUPPORTED

const val MAX_SPEED_SUPPORTED = 2.0f: Float

MIN_SPEED_SUPPORTED

const val MIN_SPEED_SUPPORTED = 0.5f: Float

Public constructors

CastPlayer

CastPlayer(castContext: CastContext!)

Creates a new cast player.

The returned player uses a DefaultMediaItemConverter and

mediaItemConverter is set to a DefaultMediaItemConverter, seekBackIncrementMs is set to DEFAULT_SEEK_BACK_INCREMENT_MS and seekForwardIncrementMs is set to DEFAULT_SEEK_FORWARD_INCREMENT_MS.

Parameters
`castContext: CastContext!`	The context from which the cast session is obtained.

CastPlayer

CastPlayer(
    castContext: CastContext!,
    mediaItemConverter: MediaItemConverter!
)

Creates a new cast player.

seekBackIncrementMs is set to DEFAULT_SEEK_BACK_INCREMENT_MS and seekForwardIncrementMs is set to DEFAULT_SEEK_FORWARD_INCREMENT_MS.

Parameters
`castContext: CastContext!`	The context from which the cast session is obtained.
`mediaItemConverter: MediaItemConverter!`	The `MediaItemConverter` to use.

CastPlayer

CastPlayer(
    castContext: CastContext!,
    mediaItemConverter: MediaItemConverter!,
    seekBackIncrementMs: @IntRange(from = 1) Long,
    seekForwardIncrementMs: @IntRange(from = 1) Long
)

Creates a new cast player.

Parameters
`castContext: CastContext!`	The context from which the cast session is obtained.
`mediaItemConverter: MediaItemConverter!`	The `MediaItemConverter` to use.
`seekBackIncrementMs: @IntRange(from = 1) Long`	The `seekBack` increment, in milliseconds.
`seekForwardIncrementMs: @IntRange(from = 1) Long`	The `seekForward` increment, in milliseconds.

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

CastPlayer

CastPlayer(
    context: Context?,
    castContext: CastContext!,
    mediaItemConverter: MediaItemConverter!,
    seekBackIncrementMs: @IntRange(from = 1) Long,
    seekForwardIncrementMs: @IntRange(from = 1) Long,
    maxSeekToPreviousPositionMs: @IntRange(from = 0) Long
)

Creates a new cast player.

Parameters
`context: Context?`	A `Context` used to populate `getDeviceInfo`. If null, `getDeviceInfo` will always return `DEVICE_INFO_REMOTE_EMPTY`.
`castContext: CastContext!`	The context from which the cast session is obtained.
`mediaItemConverter: MediaItemConverter!`	The `MediaItemConverter` to use.
`seekBackIncrementMs: @IntRange(from = 1) Long`	The `seekBack` increment, in milliseconds.
`seekForwardIncrementMs: @IntRange(from = 1) Long`	The `seekForward` increment, in milliseconds.
`maxSeekToPreviousPositionMs: @IntRange(from = 0) Long`	The maximum position for which `seekToPrevious` seeks to the previous `MediaItem`, in milliseconds.

Throws
`java.lang.IllegalArgumentException`	If `seekBackIncrementMs` or `seekForwardIncrementMs` is non-positive, or if `maxSeekToPreviousPositionMs` is negative.

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.

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.

clearVideoSurface

fun clearVideoSurface(): Unit

This method is not supported and does nothing.

clearVideoSurface

fun clearVideoSurface(surface: Surface?): Unit

This method is not supported and does nothing.

clearVideoSurfaceHolder

fun clearVideoSurfaceHolder(surfaceHolder: SurfaceHolder?): Unit

This method is not supported and does nothing.

clearVideoSurfaceView

fun clearVideoSurfaceView(surfaceView: SurfaceView?): Unit

This method is not supported and does nothing.

clearVideoTextureView

fun clearVideoTextureView(textureView: TextureView?): Unit

This method is not supported and does nothing.

decreaseDeviceVolume

fun decreaseDeviceVolume(): Unit

decreaseDeviceVolume

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

This method is not supported and does nothing.

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!

This method is not supported and returns DEFAULT.

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.

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!

This method is not supported and returns an empty CueGroup.

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`

getDeviceVolume

fun getDeviceVolume(): Int

This method is not supported and always returns 0.

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.

getItem

fun getItem(periodId: Int): MediaQueueItem?

Returns the item that corresponds to the period with the given id, or null if no media queue or period with id periodId exist.

Parameters
`periodId: Int`	The id of the period (`getCurrentTimeline`) that corresponds to the item to get.

Returns
`MediaQueueItem?`	The item that corresponds to the period with the given id, or null if no media queue or period with id `periodId` exist.

getMaxSeekToPreviousPosition

fun getMaxSeekToPreviousPosition(): Long

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

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

See also
`onMaxSeekToPreviousPositionChanged`

getMediaMetadataInternal

fun getMediaMetadataInternal(): MediaMetadata!

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`

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.

See also
`onPlaylistMetadataChanged`

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.

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`

getShuffleModeEnabled

fun getShuffleModeEnabled(): Boolean

Returns whether shuffling of media items is enabled.

See also
`onShuffleModeEnabledChanged`

getSurfaceSize

fun getSurfaceSize(): Size!

This method is not supported and returns UNKNOWN.

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!

This method is not supported and returns UNKNOWN.

getVolume

fun getVolume(): Float

This method is not supported and returns 1.

increaseDeviceVolume

fun increaseDeviceVolume(): Unit

increaseDeviceVolume

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

This method is not supported and does nothing.

isCastSessionAvailable

fun isCastSessionAvailable(): Boolean

Returns whether a cast session is available.

isDeviceMuted

fun isDeviceMuted(): Boolean

This method is not supported and always returns false.

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.

moveMediaItems

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

Moves the media item range to the new index.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`fromIndex: Int`	The start of the range to move. If the index is larger than the size of the playlist, the request is ignored.
`toIndex: Int`	The first item not to be included in the range (exclusive). If the index is larger than the size of the playlist, items up to the end of the playlist are moved.
`newIndex: Int`	The new index of the first media item of the range. If the new index is larger than the size of the remaining playlist after removing the range, the range is moved to the end of the playlist.

prepare

fun prepare(): Unit

Prepares the player.

This method must only be called if COMMAND_PREPARE is available.

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

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.

removeListener

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

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

Parameters
`listener: Player.Listener!`	The listener to unregister.

removeMediaItems

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

Removes a range of media items from the playlist.

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

Parameters
`fromIndex: Int`	The index at which to start removing media items. If the index is larger than the size of the playlist, the request is ignored.
`toIndex: Int`	The index of the first item to be kept (exclusive). If the index is larger than the size of the playlist, media items up to the end of the playlist are removed.

replaceMediaItems

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

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

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

This method must only be called if COMMAND_CHANGE_MEDIA_ITEMS is available.

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

Parameters
`fromIndex: Int`	The start of the range. If the index is larger than the size of the playlist, the request is ignored.
`toIndex: Int`	The first item not to be included in the range (exclusive). If the index is larger than the size of the playlist, items up to the end of the playlist are replaced.
`mediaItems: (Mutable)List<MediaItem!>!`	The `media items` to replace the range with.

seekTo

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

Seeks to a position in the specified MediaItem.

Parameters
`mediaItemIndex: Int`	The index of the `MediaItem`. If the original seek operation did not directly specify an index, this is the most likely implied index based on the available player state. If the implied action is to do nothing, this will be `INDEX_UNSET`.
`positionMs: Long`	The seek position in the specified `MediaItem` in milliseconds, or `TIME_UNSET` to seek to the media item's default position. If the original seek operation did not directly specify a position, this is the most likely implied position based on the available player state.
`@Player.Command seekCommand: Int`	The `Player.Command` used to trigger the seek.
`isRepeatingCurrentItem: Boolean`	Whether this seeks repeats the current item.

setAudioAttributes

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

This method is not supported and does nothing.

setDeviceMuted

fun setDeviceMuted(muted: Boolean): Unit

setDeviceMuted

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

This method is not supported and does nothing.

setDeviceVolume

fun setDeviceVolume(volume: Int): Unit

setDeviceVolume

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

This method is not supported and does nothing.

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.

setPlaylistMetadata

fun setPlaylistMetadata(mediaMetadata: MediaMetadata!): Unit

This method is not supported and does nothing.

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.

setSessionAvailabilityListener

fun setSessionAvailabilityListener(listener: SessionAvailabilityListener?): Unit

Sets a listener for updates on the cast session availability.

Parameters
`listener: SessionAvailabilityListener?`	The `SessionAvailabilityListener`, or null to clear the listener.

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

This method is not supported and does nothing.

setVideoSurfaceHolder

fun setVideoSurfaceHolder(surfaceHolder: SurfaceHolder?): Unit

This method is not supported and does nothing.

setVideoSurfaceView

fun setVideoSurfaceView(surfaceView: SurfaceView?): Unit

This method is not supported and does nothing.

setVideoTextureView

fun setVideoTextureView(textureView: TextureView?): Unit

This method is not supported and does nothing.

setVolume

fun setVolume(volume: Float): Unit

This method is not supported and does nothing.

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.

Public properties

availableCommands

val availableCommands: Player.Commands!

currentTracks

val currentTracks: Tracks!

deviceInfo

val deviceInfo: DeviceInfo!

mediaMetadata

val mediaMetadata: MediaMetadata!

playbackState

@Player.State
val playbackState: Int