MediaPlayer

Kotlin |Java

class MediaPlayer : SessionPlayer

kotlin.Any
↳	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 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`	`android.media.AudioManager#AUDIOFOCUS_NONE`
`AudioAttributesCompat#USAGE_GAME` `AudioAttributesCompat#USAGE_MEDIA` `AudioAttributesCompat#USAGE_UNKNOWN`	`android.media.AudioManager#AUDIOFOCUS_GAIN`	Developers should specific a proper usage instead of `AudioAttributesCompat#USAGE_UNKNOWN`
`AudioAttributesCompat#USAGE_ALARM` `AudioAttributesCompat#USAGE_VOICE_COMMUNICATION`	`android.media.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`	`android.media.AudioManager#AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK`
`AudioAttributesCompat#USAGE_ASSISTANT`	`android.media.AudioManager#AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE`
`AudioAttributesCompat#USAGE_ASSISTANCE_ACCESSIBILITY`	`android.media.AudioManager#AUDIOFOCUS_GAIN_TRANSIENT` if `AudioAttributesCompat#CONTENT_TYPE_SPEECH`, `android.media.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, 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
abstract	`PlayerCallback` Interface definition for callbacks to be invoked when the player has the corresponding events.
	`TrackInfo` Class for the player to return each audio/video/subtitle track's metadata.

Constants
static Int	`MEDIA_INFO_AUDIO_NOT_PLAYING` Informs that audio is not playing.
static Int	`MEDIA_INFO_BAD_INTERLEAVING` Bad interleaving means that a media has been improperly interleaved or not interleaved at all, e.
static Int	`MEDIA_INFO_BUFFERING_UPDATE` Update status in buffering a media source received through progressive downloading.
static Int	`MEDIA_INFO_METADATA_UPDATE` A new set of metadata is available.
static Int	`MEDIA_INFO_NOT_SEEKABLE` The media cannot be seeked (e.g live stream)
static Int	`MEDIA_INFO_VIDEO_NOT_PLAYING` Informs that video is not playing.
static Int	`MEDIA_INFO_VIDEO_RENDERING_START` The player just pushed the very first video frame for rendering.
static Int	`MEDIA_INFO_VIDEO_TRACK_LAGGING` The video is too complex for the decoder: it can't decode frames fast enough.
static Int	`NO_TRACK_SELECTED` The return value of `getSelectedTrack(int)` when there is no selected track for the given type.
static Int	`PLAYER_ERROR_IO` File or network related operation errors.
static Int	`PLAYER_ERROR_MALFORMED` Bitstream is not conforming to the related coding standard or file spec.
static Int	`PLAYER_ERROR_TIMED_OUT` Some operation takes too long to complete, usually more than 3-5 seconds.
static Int	`PLAYER_ERROR_UNKNOWN` Unspecified player error.
static Int	`PLAYER_ERROR_UNSUPPORTED` Bitstream is conforming to the related coding standard or file spec, but the media framework does not support the feature.
static 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.
static 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.
static 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.
static 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 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. See `getBufferedPosition()` for how far is buffered already.
`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. This value will be returned when the corresponding media item does not exist.
`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. A group is a logical block of media items which is specified in the section 5.7 of the Bluetooth AVRCP 1.6. An example of a group is the playlist.
`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. A group is a logical block of media items which is specified in the section 5.7 of the Bluetooth AVRCP 1.6. An example of a group is the playlist.
`Int`	`SHUFFLE_MODE_NONE` Media list will be played in order.
`Long`	`UNKNOWN_TIME` Value indicating the time is unknown

Public constructors
`<init>(@NonNull context: Context)` Constructor to create a MediaPlayer instance.

Public methods
ListenableFuture<SessionPlayer.PlayerResult!>	`addPlaylistItem(index: Int, @NonNull item: MediaItem)` Adds the media item to the playlist at the index.
ListenableFuture<SessionPlayer.PlayerResult!>	`attachAuxEffect(effectId: Int)` Attaches an auxiliary effect to the player.
Unit	`close()` Closes the player and relinquish underlying resources.
ListenableFuture<SessionPlayer.PlayerResult!>	`deselectTrack(@NonNull trackInfo: SessionPlayer.TrackInfo)` Deselects the `TrackInfo` for the current media item.
AudioAttributesCompat?	`getAudioAttributes()`
Int	`getAudioSessionId()` Returns the audio session ID.
Long	`getBufferedPosition()`
Int	`getBufferingState()`
MediaItem?	`getCurrentMediaItem()`
Int	`getCurrentMediaItemIndex()` Gets the index of current media item in playlist.
Long	`getCurrentPosition()`
Long	`getDuration()`
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()`
Int	`getPlayerState()`
Float	`getPlayerVolume()`
MutableList<MediaItem