MediaPlayer

Kotlin |Java

public final class MediaPlayer
extends SessionPlayer

java.lang.Object
↳	androidx.media2.common.SessionPlayer
	↳	androidx.media2.player.MediaPlayer

A media player which plays MediaItems. The details on playback control and player states can be found in the documentation of the base class, SessionPlayer.

Topic covered here:

Audio focus and noisy intent

Audio focus and noisy intent

By default, MediaPlayer handles audio focus and noisy intent with AudioAttributesCompat set to this player. You need to call setAudioAttributes(AudioAttributesCompat) set the audio attribute while in the SessionPlayer.PLAYER_STATE_IDLE.

Here's the table of automatic audio focus behavior with audio attributes.

Audio Attributes	Audio Focus Gain Type	Misc
`AudioAttributesCompat.USAGE_VOICE_COMMUNICATION_SIGNALLING`	`AudioManager.AUDIOFOCUS_NONE`
`AudioAttributesCompat.USAGE_GAME` `AudioAttributesCompat.USAGE_MEDIA` `AudioAttributesCompat.USAGE_UNKNOWN`	`AudioManager.AUDIOFOCUS_GAIN`	Developers should specific a proper usage instead of `AudioAttributesCompat.USAGE_UNKNOWN`
`AudioAttributesCompat.USAGE_ALARM` `AudioAttributesCompat.USAGE_VOICE_COMMUNICATION`	`AudioManager.AUDIOFOCUS_GAIN_TRANSIENT`
`AudioAttributesCompat.USAGE_ASSISTANCE_NAVIGATION_GUIDANCE` `AudioAttributesCompat.USAGE_ASSISTANCE_SONIFICATION` `AudioAttributesCompat.USAGE_NOTIFICATION` `AudioAttributesCompat.USAGE_NOTIFICATION_COMMUNICATION_DELAYED` `AudioAttributesCompat.USAGE_NOTIFICATION_COMMUNICATION_INSTANT` `AudioAttributesCompat.USAGE_NOTIFICATION_COMMUNICATION_REQUEST` `AudioAttributesCompat.USAGE_NOTIFICATION_EVENT` `AudioAttributesCompat.USAGE_NOTIFICATION_RINGTONE`	`AudioManager.AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK`
`AudioAttributesCompat.USAGE_ASSISTANT`	`AudioManager.AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE`
`AudioAttributesCompat.USAGE_ASSISTANCE_ACCESSIBILITY`	`AudioManager.AUDIOFOCUS_GAIN_TRANSIENT` if `AudioAttributesCompat.CONTENT_TYPE_SPEECH`, `AudioManager.AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK` otherwise
`null`	No audio focus handling, and sets the player volume to `0`	Only valid if your media contents don't have audio
Any other AudioAttributes	No audio focus handling, and sets the player volume to `0`	This is to handle error

If an AudioAttributesCompat is not specified by setAudioAttributes(AudioAttributesCompat), getAudioAttributes() will return null and the default audio focus behavior will follow the null case on the table above.

For more information about the audio focus, take a look at Managing audio focus

Summary

Nested classes
`class`	`MediaPlayer.PlayerCallback` Interface definition for callbacks to be invoked when the player has the corresponding events.
`class`	`MediaPlayer.TrackInfo` Class for the player to return each audio/video/subtitle track's metadata.

Constants
`int`	`MEDIA_INFO_AUDIO_NOT_PLAYING` Informs that audio is not playing.
`int`	`MEDIA_INFO_BAD_INTERLEAVING` Bad interleaving means that a media has been improperly interleaved or not interleaved at all, e.g has all the video samples first then all the audio ones.
`int`	`MEDIA_INFO_BUFFERING_UPDATE` Update status in buffering a media source received through progressive downloading.
`int`	`MEDIA_INFO_METADATA_UPDATE` A new set of metadata is available.
`int`	`MEDIA_INFO_NOT_SEEKABLE` The media cannot be seeked (e.g live stream)
`int`	`MEDIA_INFO_VIDEO_NOT_PLAYING` Informs that video is not playing.
`int`	`MEDIA_INFO_VIDEO_RENDERING_START` The player just pushed the very first video frame for rendering.
`int`	`MEDIA_INFO_VIDEO_TRACK_LAGGING` The video is too complex for the decoder: it can't decode frames fast enough.
`int`	`NO_TRACK_SELECTED` This constant is deprecated. `getSelectedTrack(int)` returns `null` instead of this value.
`int`	`PLAYER_ERROR_IO` File or network related operation errors.
`int`	`PLAYER_ERROR_MALFORMED` Bitstream is not conforming to the related coding standard or file spec.
`int`	`PLAYER_ERROR_TIMED_OUT` Some operation takes too long to complete, usually more than 3-5 seconds.
`int`	`PLAYER_ERROR_UNKNOWN` Unspecified player error.
`int`	`PLAYER_ERROR_UNSUPPORTED` Bitstream is conforming to the related coding standard or file spec, but the media framework does not support the feature.
`int`	`SEEK_CLOSEST` This mode is used with `seekTo(long, int)` to move media position to a frame (not necessarily a key frame) associated with a media item that is located closest to or at the given time.
`int`	`SEEK_CLOSEST_SYNC` This mode is used with `seekTo(long, int)` to move media position to a sync (or key) frame associated with a media item that is located closest to (in time) or at the given time.
`int`	`SEEK_NEXT_SYNC` This mode is used with `seekTo(long, int)` to move media position to a sync (or key) frame associated with a media item that is located right after or at the given time.
`int`	`SEEK_PREVIOUS_SYNC` This mode is used with `seekTo(long, int)` to move media position to a sync (or key) frame associated with a media item that is located right before or at the given time.

Inherited constants

From class androidx.media2.common.SessionPlayer

`int`	`BUFFERING_STATE_BUFFERING_AND_PLAYABLE` Buffering state indicating the player is buffering but enough has been buffered for this player to be able to play the content.
`int`	`BUFFERING_STATE_BUFFERING_AND_STARVED` Buffering state indicating the player is buffering, but the player is currently starved for data, and cannot play.
`int`	`BUFFERING_STATE_COMPLETE` Buffering state indicating the player is done buffering, and the remainder of the content is available for playback.
`int`	`BUFFERING_STATE_UNKNOWN` Buffering state is unknown.
`int`	`INVALID_ITEM_INDEX` Media item index is invalid.
`int`	`PLAYER_STATE_ERROR` State when the player is in error state and cannot be recovered self.
`int`	`PLAYER_STATE_IDLE` State when the player is idle, and needs configuration to start playback.
`int`	`PLAYER_STATE_PAUSED` State when the player's playback is paused
`int`	`PLAYER_STATE_PLAYING` State when the player's playback is ongoing
`int`	`REPEAT_MODE_ALL` Playing media list will be repeated.
`int`	`REPEAT_MODE_GROUP` Playback of the playing media group will be repeated.
`int`	`REPEAT_MODE_NONE` Playback will be stopped at the end of the playing media list.
`int`	`REPEAT_MODE_ONE` Playback of the current playing media item will be repeated.
`int`	`SHUFFLE_MODE_ALL` Media list will be played in shuffled order.
`int`	`SHUFFLE_MODE_GROUP` Media group will be played in shuffled order.
`int`	`SHUFFLE_MODE_NONE` Media list will be played in order.
`long`	`UNKNOWN_TIME` Value indicating the time is unknown

Public constructors
`MediaPlayer(Context context)` Constructor to create a MediaPlayer instance.

Public methods
`ListenableFuture<SessionPlayer.PlayerResult>`	`addPlaylistItem(int index, MediaItem item)` Adds the media item to the playlist at the index.
`ListenableFuture<SessionPlayer.PlayerResult>`	`attachAuxEffect(int effectId)` Attaches an auxiliary effect to the player.
`void`	`close()` Closes the player and relinquish underlying resources.
`ListenableFuture<SessionPlayer.PlayerResult>`	`deselectTrack(SessionPlayer.TrackInfo trackInfo)` Deselects the `MediaPlayer.TrackInfo` for the current media item.
`AudioAttributesCompat`	`getAudioAttributes()` Gets the `AudioAttributesCompat` that media player has.
`int`	`getAudioSessionId()` Returns the audio session ID.
`long`	`getBufferedPosition()` Gets the position for how much has been buffered, or `UNKNOWN_TIME` if unknown.
`int`	`getBufferingState()` Returns the current buffering state of the player.
`MediaItem`	`getCurrentMediaItem()` Gets the current media item, which is currently playing or would be played with later `play()`.
`int`	`getCurrentMediaItemIndex()` Gets the index of current media item in playlist.
`long`	`getCurrentPosition()` Gets the current playback position.
`long`	`getDuration()` Gets the duration of the current media item, or `UNKNOWN_TIME` if unknown.
`float`	`getMaxPlayerVolume()`
`int`	`getNextMediaItemIndex()` Gets the next item index in the playlist.
`PlaybackParams`	`getPlaybackParams()` Gets the playback params, containing the current playback rate.
`float`	`getPlaybackSpeed()` Gets the actual playback speed to be used by the player when playing.
`int`	`getPlayerState()` Gets the current player state.
`float`	`getPlayerVolume()`
`List<MediaItem>`	`getPlaylist()` Gets the playlist.
`MediaMetadata`	`getPlaylistMetadata()` Gets the playlist metadata.
`int`	`getPreviousMediaItemIndex()` Gets the previous item index in the playlist.
`int`	`getRepeatMode()` Gets the repeat mode.
`MediaPlayer.TrackInfo`	`getSelectedTrack(int trackType)` Returns the selected track for the given track type.
`int`	`getShuffleMode()` Gets the shuffle mode.
`MediaTimestamp`	`getTimestamp()` Gets current playback position as a `MediaTimestamp`.
`List<MediaPlayer.TrackInfo>`	`getTrackInfo()` This method is deprecated. Use `getTracks()` instead.
`List<SessionPlayer.TrackInfo>`	`getTracks()` Gets the full list of selected and unselected tracks that the media contains.
`VideoSize`	`getVideoSize()` Returns the size of the video.
`ListenableFuture<SessionPlayer.PlayerResult>`	`movePlaylistItem(int fromIndex, int toIndex)` Moves the media item at `fromIdx` to `toIdx` in the playlist.
`ListenableFuture<SessionPlayer.PlayerResult>`	`pause()` Pauses playback.
`ListenableFuture<SessionPlayer.PlayerResult>`	`play()` Starts or resumes playback.
`ListenableFuture<SessionPlayer.PlayerResult>`	`prepare()` Prepares the media items for playback.
`void`	`registerPlayerCallback(Executor executor, MediaPlayer.PlayerCallback callback)` Register `MediaPlayer.PlayerCallback` to listen changes.
`ListenableFuture<SessionPlayer.PlayerResult>`	`removePlaylistItem(int index)` Removes the media item from the playlist On success, a `SessionPlayer.PlayerResult` would be returned with `item` removed.
`ListenableFuture<SessionPlayer.PlayerResult>`	`replacePlaylistItem(int index, MediaItem item)` Replaces the media item at index in the playlist.
`void`	`reset()` Resets `MediaPlayer` to its uninitialized state if not closed.
`ListenableFuture<SessionPlayer.PlayerResult>`	`seekTo(long position, int mode)` Moves the media to specified time position by considering the given mode.
`ListenableFuture<SessionPlayer.PlayerResult>`	`seekTo(long position)` Seeks to the specified position.
`ListenableFuture<SessionPlayer.PlayerResult>`	`selectTrack(SessionPlayer.TrackInfo trackInfo)` Selects the `MediaPlayer.TrackInfo` for the current media item.
`ListenableFuture<SessionPlayer.PlayerResult>`	`selectTrack(MediaPlayer.TrackInfo trackInfo)` This method is deprecated. Use `selectTrack(SessionPlayer.TrackInfo)` instead.
`ListenableFuture<SessionPlayer.PlayerResult>`	`setAudioAttributes(AudioAttributesCompat attributes)` Sets the `AudioAttributesCompat` to be used during the playback of the media.
`ListenableFuture<SessionPlayer.PlayerResult>`	`setAudioSessionId(int sessionId)` Sets the audio session ID.
`ListenableFuture<SessionPlayer.PlayerResult>`	`setAuxEffectSendLevel(float level)` Sets the send level of the player to the attached auxiliary effect.
`ListenableFuture<SessionPlayer.PlayerResult>`	`setMediaItem(MediaItem item)` Sets a `MediaItem` for playback.
`ListenableFuture<SessionPlayer.PlayerResult>`	`setPlaybackParams(PlaybackParams params)` Sets playback params using `PlaybackParams`.
`ListenableFuture<SessionPlayer.PlayerResult>`	`setPlaybackSpeed(float playbackSpeed)` Sets the playback speed.
`ListenableFuture<SessionPlayer.PlayerResult>`	`setPlayerVolume(float volume)` Sets the volume of the audio of the media to play, expressed

MediaPlayer

Audio focus and noisy intent

Summary

Nested classes

Constants

Inherited constants

Public constructors

Public methods