MediaPlayerAdapter

Kotlin |Java

open class MediaPlayerAdapter : PlayerAdapter

kotlin.Any
↳	androidx.leanback.media.PlayerAdapter
	↳	androidx.leanback.media.MediaPlayerAdapter

This implementation extends the PlayerAdapter with a MediaPlayer.

Summary

Public constructors
`<init>(context: Context!)` Constructor.

Public methods
open Long	`getBufferedPosition()`
open Long	`getCurrentPosition()`
open Long	`getDuration()`
MediaPlayer!	`getMediaPlayer()` Return the MediaPlayer associated with the MediaPlayerAdapter.
open Int	`getProgressUpdatingInterval()` Return updating interval of progress UI in milliseconds.
open Boolean	`isPlaying()`
open Boolean	`isPrepared()`
open Unit	`onAttachedToHost(host: PlaybackGlueHost!)`
open Unit	`onDetachedFromHost()`
open Unit	`pause()`
open Unit	`play()`
open Unit	`release()` Release internal MediaPlayer.
open Unit	`reset()` Will reset the `MediaPlayer` and the glue such that a new file can be played.
open Unit	`seekTo(newPosition: Long)`
open Boolean	`setDataSource(uri: Uri!)` Sets the media source of the player witha given URI.
open Unit	`setProgressUpdatingEnabled(enabled: Boolean)`

Protected methods
open Boolean	`onError(what: Int, extra: Int)` Called to indicate an error.
open Boolean	`onInfo(what: Int, extra: Int)` Called to indicate an info or a warning.
open Unit	`onSeekComplete()` Called to indicate the completion of a seek operation.

Inherited functions

From class PlayerAdapter

`Unit`	`fastForward()` Optional method. Override this method if `getSupportedActions()` include `PlaybackBaseControlGlue#ACTION_FAST_FORWARD` to fast forward current media item.
`PlayerAdapter.Callback!`	`getCallback()` Gets callback for event of PlayerAdapter.
`Long`	`getSupportedActions()` Return xor combination of values defined in PlaybackBaseControlGlue. Default is PLAY_PAUSE (unless subclass enforce to be 0)
`Unit`	`next()` Optional method. Override this method if `getSupportedActions()` include `PlaybackBaseControlGlue#ACTION_SKIP_TO_NEXT` to skip to next item.
`Unit`	`previous()` Optional method. Override this method if `getSupportedActions()` include `PlaybackBaseControlGlue#ACTION_SKIP_TO_PREVIOUS` to skip to previous item.
`Unit`	`rewind()` Optional method. Override this method if `getSupportedActions()` include `PlaybackBaseControlGlue#ACTION_REWIND` to rewind in current media item.
`Unit`	`setCallback(callback: PlayerAdapter.Callback!)` Sets callback for event of PlayerAdapter.
`Unit`	`setRepeatAction(repeatActionIndex: Int)` Optional method. Override this method if `getSupportedActions()` include `PlaybackBaseControlGlue#ACTION_REPEAT` to set the repeat action.
`Unit`	`setShuffleAction(shuffleActionIndex: Int)` Optional method. Override this method if `getSupportedActions()` include `PlaybackBaseControlGlue#ACTION_SHUFFLE` to set the shuffle action.

Public constructors

<init>

MediaPlayerAdapter(context: Context!)

Constructor.

Public methods

getBufferedPosition

open fun getBufferedPosition(): Long

getCurrentPosition

open fun getCurrentPosition(): Long

getDuration

open fun getDuration(): Long

getMediaPlayer

fun getMediaPlayer(): MediaPlayer!

Return the MediaPlayer associated with the MediaPlayerAdapter. App can use the instance to config DRM or control volumes, etc. Warning: App should not use the following seven listeners as they are controlled by MediaPlayerAdapter. If that's the case, app should write its own PlayerAdapter class. MediaPlayer#setOnPreparedListener MediaPlayer#setOnVideoSizeChangedListener MediaPlayer#setOnErrorListener MediaPlayer#setOnSeekCompleteListener MediaPlayer#setOnCompletionListener MediaPlayer#setOnInfoListener MediaPlayer#setOnBufferingUpdateListener

Return
`MediaPlayer!`	The MediaPlayer associated with the MediaPlayerAdapter.

getProgressUpdatingInterval

open fun getProgressUpdatingInterval(): Int

Return updating interval of progress UI in milliseconds. Subclass may override.

Return
`Int`	Update interval of progress UI in milliseconds.

isPlaying

open fun isPlaying(): Boolean

isPrepared

open fun isPrepared(): Boolean

Return
`Boolean`	True if MediaPlayer OnPreparedListener is invoked and got a SurfaceHolder if `PlaybackGlueHost` provides SurfaceHolder.

onAttachedToHost

open fun onAttachedToHost(host: PlaybackGlueHost!): Unit

onDetachedFromHost

open fun onDetachedFromHost(): Unit

pause

open fun pause(): Unit

play

open fun play(): Unit

release

open fun release(): Unit

Release internal MediaPlayer. Should not use the object after call release().

reset

open fun reset(): Unit

Will reset the MediaPlayer and the glue such that a new file can be played. You are not required to call this method before playing the first file. However you have to call it before playing a second one.

seekTo

open fun seekTo(newPosition: Long): Unit

setDataSource

open fun setDataSource(uri: Uri!): Boolean

Sets the media source of the player witha given URI.

Return
`Boolean`	Returns `true` if uri represents a new media; `false` otherwise.

See Also

MediaPlayer#setDataSource(String)

setProgressUpdatingEnabled

open fun setProgressUpdatingEnabled(enabled: Boolean): Unit

Protected methods

onError

protected open fun onError(
    what: Int, 
    extra: Int
): Boolean

Called to indicate an error.

Parameters
`what`	Int: the type of error that has occurred: `MediaPlayer#MEDIA_ERROR_UNKNOWN` `MediaPlayer#MEDIA_ERROR_SERVER_DIED`
`extra`	Int: an extra code, specific to the error. Typically implementation dependent. `MediaPlayer#MEDIA_ERROR_IO` `MediaPlayer#MEDIA_ERROR_MALFORMED` `MediaPlayer#MEDIA_ERROR_UNSUPPORTED` `MediaPlayer#MEDIA_ERROR_TIMED_OUT` `MEDIA_ERROR_SYSTEM (-2147483648)` - low-level system error.

Return
`Boolean`	True if the method handled the error, false if it didn't. Returning false, will cause the `PlayerAdapter.Callback#onPlayCompleted(PlayerAdapter)` being called.

onInfo

protected open fun onInfo(
    what: Int, 
    extra: Int
): Boolean

Called to indicate an info or a warning.

Parameters

Parameters
`what`	Int: the type of info or warning. `MediaPlayer#MEDIA_INFO_UNKNOWN` `MediaPlayer#MEDIA_INFO_VIDEO_TRACK_LAGGING` `MediaPlayer#MEDIA_INFO_VIDEO_RENDERING_START` `MediaPlayer#MEDIA_INFO_BUFFERING_START` `MediaPlayer#MEDIA_INFO_BUFFERING_END` `MEDIA_INFO_NETWORK_BANDWIDTH (703)` - bandwidth information is available (as `extra` kbps) `MediaPlayer#MEDIA_INFO_BAD_INTERLEAVING` `MediaPlayer#MEDIA_INFO_NOT_SEEKABLE` `MediaPlayer#MEDIA_INFO_METADATA_UPDATE` `MediaPlayer#MEDIA_INFO_UNSUPPORTED_SUBTITLE` `MediaPlayer#MEDIA_INFO_SUBTITLE_TIMED_OUT`
`extra`	Int: an extra code, specific to the info. Typically implementation dependent.

what

Int: the type of info or warning.

MediaPlayer#MEDIA_INFO_UNKNOWN
MediaPlayer#MEDIA_INFO_VIDEO_TRACK_LAGGING
MediaPlayer#MEDIA_INFO_VIDEO_RENDERING_START
MediaPlayer#MEDIA_INFO_BUFFERING_START
MediaPlayer#MEDIA_INFO_BUFFERING_END
MEDIA_INFO_NETWORK_BANDWIDTH (703) - bandwidth information is available (as extra kbps)
MediaPlayer#MEDIA_INFO_BAD_INTERLEAVING
MediaPlayer#MEDIA_INFO_NOT_SEEKABLE
MediaPlayer#MEDIA_INFO_METADATA_UPDATE
MediaPlayer#MEDIA_INFO_UNSUPPORTED_SUBTITLE
MediaPlayer#MEDIA_INFO_SUBTITLE_TIMED_OUT

extra Int: an extra code, specific to the info. Typically implementation dependent.

Return
`Boolean`	True if the method handled the info, false if it didn't. Returning false, will cause the info to be discarded.

onSeekComplete

protected open fun onSeekComplete(): Unit

Called to indicate the completion of a seek operation.