MediaPlayer

MEDIA_INFO_AUDIO_NOT_PLAYING

static val MEDIA_INFO_AUDIO_NOT_PLAYING: Int

Informs that audio is not playing. Note that playback of the video is not interrupted.

Value: 804

MEDIA_INFO_BAD_INTERLEAVING

static val MEDIA_INFO_BAD_INTERLEAVING: Int

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. Video is playing but a lot of disk seeks may be happening.

Value: 800

MEDIA_INFO_BUFFERING_UPDATE

static val MEDIA_INFO_BUFFERING_UPDATE: Int

Update status in buffering a media source received through progressive downloading. The received buffering percentage indicates how much of the content has been buffered or played. For example a buffering update of 80 percent when half the content has already been played indicates that the next 30 percent of the content to play has been buffered.

The extra parameter in PlayerCallback#onInfo is the percentage (0-100) of the content that has been buffered or played thus far.

Value: 704

MEDIA_INFO_METADATA_UPDATE

static val MEDIA_INFO_METADATA_UPDATE: Int

A new set of metadata is available.

Value: 802

MEDIA_INFO_NOT_SEEKABLE

static val MEDIA_INFO_NOT_SEEKABLE: Int

The media cannot be seeked (e.g live stream)

Value: 801

MEDIA_INFO_VIDEO_NOT_PLAYING

static val MEDIA_INFO_VIDEO_NOT_PLAYING: Int

Informs that video is not playing. Note that playback of the audio is not interrupted.

Value: 805

MEDIA_INFO_VIDEO_RENDERING_START

static val MEDIA_INFO_VIDEO_RENDERING_START: Int

The player just pushed the very first video frame for rendering.

Value: 3

MEDIA_INFO_VIDEO_TRACK_LAGGING

static val MEDIA_INFO_VIDEO_TRACK_LAGGING: Int

The video is too complex for the decoder: it can't decode frames fast enough. Possibly only the audio plays fine at this stage.

Value: 700

NO_TRACK_SELECTED

static val NO_TRACK_SELECTED: Int

The return value of getSelectedTrack when there is no selected track for the given type.

Value: Integer.MIN_VALUE

PLAYER_ERROR_IO

static val PLAYER_ERROR_IO: Int

File or network related operation errors.

Value: -1004

PLAYER_ERROR_MALFORMED

static val PLAYER_ERROR_MALFORMED: Int

Bitstream is not conforming to the related coding standard or file spec.

Value: -1007

PLAYER_ERROR_TIMED_OUT

static val PLAYER_ERROR_TIMED_OUT: Int

Some operation takes too long to complete, usually more than 3-5 seconds.

Value: -110

PLAYER_ERROR_UNKNOWN

static val PLAYER_ERROR_UNKNOWN: Int

Unspecified player error.

Value: 1

PLAYER_ERROR_UNSUPPORTED

static val PLAYER_ERROR_UNSUPPORTED: Int

Bitstream is conforming to the related coding standard or file spec, but the media framework does not support the feature.

Value: -1010

SEEK_CLOSEST

static val SEEK_CLOSEST: Int

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.

Value: 0x03

SEEK_CLOSEST_SYNC

static val SEEK_CLOSEST_SYNC: Int

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.

Value: 0x02

SEEK_NEXT_SYNC

static val SEEK_NEXT_SYNC: Int

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.

Value: 0x01

SEEK_PREVIOUS_SYNC

static val SEEK_PREVIOUS_SYNC: Int

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.

Value: 0x00

<init>

MediaPlayer(@NonNull context: Context)

Constructor to create a MediaPlayer instance.

addPlaylistItem

@NonNull fun addPlaylistItem(index: Int, @NonNull item: MediaItem): ListenableFuture<SessionPlayer.PlayerResult!>

attachAuxEffect

@NonNull fun attachAuxEffect(effectId: Int): ListenableFuture<SessionPlayer.PlayerResult!>

Attaches an auxiliary effect to the player. A typical auxiliary effect is a reverberation effect which can be applied on any sound source that directs a certain amount of its energy to this effect. This amount is defined by setAuxEffectSendLevel(). See setAuxEffectSendLevel(float).

After creating an auxiliary effect (e.g. android.media.audiofx.EnvironmentalReverb), retrieve its ID with android.media.audiofx.AudioEffect#getId() and use it when calling this method to attach the player to the effect.

To detach the effect from the player, call this method with a null effect id.

This method must be called before setMediaItem and setPlaylist methods.

close

fun close(): Unit

getAudioAttributes

@Nullable fun getAudioAttributes(): AudioAttributesCompat?

getAudioSessionId

fun getAudioSessionId(): Int

Returns the audio session ID.

getBufferedPosition

fun getBufferedPosition(): Long

getBufferingState

fun getBufferingState(): Int

getCurrentMediaItem

@Nullable fun getCurrentMediaItem(): MediaItem?

getCurrentMediaItemIndex

fun getCurrentMediaItemIndex(): Int

getCurrentPosition

fun getCurrentPosition(): Long

getDuration

fun getDuration(): Long

getMaxPlayerVolume

fun getMaxPlayerVolume(): Float

getNextMediaItemIndex

fun getNextMediaItemIndex(): Int

getPlaybackParams

@NonNull fun getPlaybackParams(): PlaybackParams

Gets the playback params, containing the current playback rate.

getPlaybackSpeed

fun getPlaybackSpeed(): Float

getPlayerState

fun getPlayerState(): Int

getPlayerVolume

fun getPlayerVolume(): Float

getPlaylist

@Nullable fun getPlaylist(): MutableList<MediaItem!>?

getPlaylistMetadata

@Nullable fun getPlaylistMetadata(): MediaMetadata?

getPreviousMediaItemIndex

fun getPreviousMediaItemIndex(): Int

getRepeatMode

fun getRepeatMode(): Int

getSelectedTrack

@Nullable fun getSelectedTrack(trackType: Int): MediaPlayer.TrackInfo?

Returns the audio or video track currently selected for playback. The return value is an element in the list returned by getTrackInfo(), and can be used in calls to selectTrack(TrackInfo).

getShuffleMode

fun getShuffleMode(): Int

getTimestamp

@Nullable fun getTimestamp(): MediaTimestamp?

Gets current playback position as a MediaTimestamp.

The MediaTimestamp represents how the media time correlates to the system time in a linear fashion using an anchor and a clock rate. During regular playback, the media time moves fairly constantly (though the anchor frame may be rebased to a current system time, the linear correlation stays steady). Therefore, this method does not need to be called often.

To help users get current playback position, this method always anchors the timestamp to the current system time, so MediaTimestamp#getAnchorMediaTimeUs can be used as current playback position.

getTrackInfo

@NonNull fun getTrackInfo(): MutableList<MediaPlayer.TrackInfo!>

Returns a List of track information.

getVideoSize

@NonNull fun getVideoSize(): VideoSize

Returns the size of the video.

pause

@NonNull fun pause(): ListenableFuture<SessionPlayer.PlayerResult!>

play

@NonNull fun play(): ListenableFuture<SessionPlayer.PlayerResult!>

prepare

@NonNull fun prepare(): ListenableFuture<SessionPlayer.PlayerResult!>

Prepares the media items for playback.

After setting the media items and the display surface, you need to call this method. During this preparation, the player may allocate resources required to play, such as audio and video decoders.

On success, a SessionPlayer.PlayerResult is returned with the current media item when the command completed.

registerPlayerCallback

fun registerPlayerCallback(@NonNull executor: Executor, @NonNull callback: MediaPlayer.PlayerCallback): Unit

Register PlayerCallback to listen changes.

removePlaylistItem

@NonNull fun removePlaylistItem(index: Int): ListenableFuture<SessionPlayer.PlayerResult!>

replacePlaylistItem

@NonNull fun replacePlaylistItem(index: Int, @NonNull item: MediaItem): ListenableFuture<SessionPlayer.PlayerResult!>

reset

fun reset(): Unit

Resets MediaPlayer to its uninitialized state if not closed. After calling this method, you will have to initialize it again by setting the media item and calling prepare().

Note that if the player is closed, there is no way to reuse the instance.

seekTo

@NonNull fun seekTo(position: Long): ListenableFuture<SessionPlayer.PlayerResult!>

seekTo

@NonNull fun seekTo(position: Long, mode: Int): ListenableFuture<SessionPlayer.PlayerResult!>

Moves the media to specified time position by considering the given mode.

There is at most one active seekTo processed at any time. If there is a to-be-completed seekTo, new seekTo requests will be queued in such a way that only the last request is kept. When current seekTo is completed, the queued request will be processed if that request is different from just-finished seekTo operation, i.e., the requested position or mode is different.

On success, a SessionPlayer.PlayerResult is returned with the current media item when the command completed.

selectTrack

@NonNull fun selectTrack(@NonNull trackInfo: MediaPlayer.TrackInfo): ListenableFuture<SessionPlayer.PlayerResult!>

Selects a track.

If the player is in invalid state, SessionPlayer.PlayerResult#RESULT_ERROR_INVALID_STATE will be reported with SessionPlayer.PlayerResult. If a player is in Playing state, the selected track is presented immediately. If a player is not in Playing state, it just marks the track to be played.

In any valid state, if it is called multiple times on the same type of track (ie. Video, Audio), the most recent one will be chosen.

The first audio and video tracks are selected by default if available, even though this method is not called.

Currently, audio tracks can be selected via this method.

setAudioAttributes

@NonNull fun setAudioAttributes(@NonNull attr: AudioAttributesCompat): ListenableFuture<SessionPlayer.PlayerResult!>

setAudioSessionId

@NonNull fun setAudioSessionId(sessionId: Int): ListenableFuture<SessionPlayer.PlayerResult!>

Sets the audio session ID.

setAuxEffectSendLevel

@NonNull fun setAuxEffectSendLevel(level: Float): ListenableFuture<SessionPlayer.PlayerResult!>

Sets the send level of the player to the attached auxiliary effect. See attachAuxEffect(int). The level value range is 0 to 1.0.

By default the send level is 0, so even if an effect is attached to the player this method must be called for the effect to be applied.

Note that the passed level value is a raw scalar. UI controls should be scaled logarithmically: the gain applied by audio framework ranges from -72dB to 0dB, so an appropriate conversion from linear UI input x to level is: x == 0 -> level = 0 0 < x <= R -> level = 10^(72*(x-R)/20/R)

On success, a SessionPlayer.PlayerResult is returned with the current media item when the command completed.

setMediaItem

@NonNull fun setMediaItem(@NonNull item: MediaItem): ListenableFuture<SessionPlayer.PlayerResult!>

setPlaybackParams

@NonNull fun setPlaybackParams(@NonNull params: PlaybackParams): ListenableFuture<SessionPlayer.PlayerResult!>

Sets playback params using PlaybackParams.

On success, a SessionPlayer.PlayerResult is returned with the current media item when the command completed.

setPlaybackSpeed

@NonNull fun setPlaybackSpeed(playbackSpeed: Float): ListenableFuture<SessionPlayer.PlayerResult!>

Sets the playback speed. 1.0f is the default, and values less than or equal to 0.0f are not allowed.

The supported playback speed range depends on the underlying player implementation, so it is recommended to query the actual speed of the player via getPlaybackSpeed() after the operation completes.

setPlayerVolume

@NonNull fun setPlayerVolume(volume: Float): ListenableFuture<SessionPlayer.PlayerResult!>

Sets the volume of the audio of the media to play, expressed as a linear multiplier on the audio samples.

Note that this volume is specific to the player, and is separate from stream volume used across the platform.

A value of 0.0f indicates muting, a value of 1.0f is the nominal unattenuated and unamplified gain. See getMaxPlayerVolume() for the volume range supported by this player.

The default player volume is 1.0f.

On success, a SessionPlayer.PlayerResult is returned with the current media item when the command completed.

setPlaylist

@NonNull fun setPlaylist(@NonNull playlist: MutableList<MediaItem!>, @Nullable metadata: MediaMetadata?): ListenableFuture<SessionPlayer.PlayerResult!>

setRepeatMode

@NonNull fun setRepeatMode(repeatMode: Int): ListenableFuture<SessionPlayer.PlayerResult!>

setShuffleMode

@NonNull fun setShuffleMode(shuffleMode: Int): ListenableFuture<SessionPlayer.PlayerResult!>

setSurface

@NonNull fun setSurface(@Nullable surface: Surface?): ListenableFuture<SessionPlayer.PlayerResult!>

Sets the Surface to be used as the sink for the video portion of the media.

A null surface will result in only the audio track being played.

If the Surface sends frames to a SurfaceTexture, the timestamps returned from SurfaceTexture#getTimestamp() will have an unspecified zero point. These timestamps cannot be directly compared between different media sources, different instances of the same media source, or multiple runs of the same program. The timestamp is normally monotonically increasing and is unaffected by time-of-day adjustments, but it is reset when the position is set.

On success, a SessionPlayer.PlayerResult is returned with the current media item when the command completed.

skipToNextPlaylistItem

@NonNull fun skipToNextPlaylistItem(): ListenableFuture<SessionPlayer.PlayerResult!>

skipToPlaylistItem

@NonNull fun skipToPlaylistItem(index: Int): ListenableFuture<SessionPlayer.PlayerResult!>

skipToPreviousPlaylistItem

@NonNull fun skipToPreviousPlaylistItem(): ListenableFuture<SessionPlayer.PlayerResult!>

unregisterPlayerCallback

fun unregisterPlayerCallback(@NonNull callback: MediaPlayer.PlayerCallback): Unit

Unregister the previously registered PlayerCallback.

updatePlaylistMetadata

@NonNull fun updatePlaylistMetadata(@Nullable metadata: MediaMetadata?): ListenableFuture<SessionPlayer.PlayerResult!>