Summary: Ctors | Methods | Protected Methods | Inherited Methods

MediaPlayerAdapter

Kotlin |Java

public class MediaPlayerAdapter
extends PlayerAdapter

java.lang.Object
↳	androidx.leanback.media.PlayerAdapter
	↳	androidx.leanback.media.MediaPlayerAdapter

This implementation extends the PlayerAdapter with a MediaPlayer.

Summary

Public constructors
`MediaPlayerAdapter(Context context)` Constructor.

Public methods
`long`	`getBufferedPosition()` Returns the current buffered position of the media item in milliseconds.
`long`	`getCurrentPosition()` Returns the current position of the media item in milliseconds.
`long`	`getDuration()` Returns the duration of the media item in milliseconds.
`final MediaPlayer`	`getMediaPlayer()` Return the MediaPlayer associated with the MediaPlayerAdapter.
`int`	`getProgressUpdatingInterval()` Return updating interval of progress UI in milliseconds.
`boolean`	`isPlaying()` Returns true if media is currently playing.
`boolean`	`isPrepared()`
`void`	`onAttachedToHost(PlaybackGlueHost host)` This method is called attached to associated `PlaybackGlueHost`.
`void`	`onDetachedFromHost()` This method is called when current associated `PlaybackGlueHost` is attached to a different `PlaybackGlue` or `PlaybackGlueHost` is destroyed.
`void`	`pause()` Pauses the media player.
`void`	`play()` Starts the media player.
`void`	`release()` Release internal MediaPlayer.
`void`	`reset()` Will reset the `MediaPlayer` and the glue such that a new file can be played.
`void`	`seekTo(long newPosition)` Seek to new position.
`boolean`	`setDataSource(Uri uri)` Sets the media source of the player witha given URI.
`void`	`setProgressUpdatingEnabled(boolean enabled)` Implement this method to enable or disable progress updating.

Protected methods
`boolean`	`onError(int what, int extra)` Called to indicate an error.
`boolean`	`onInfo(int what, int extra)` Called to indicate an info or a warning.
`void`	`onSeekComplete()` Called to indicate the completion of a seek operation.

Inherited methods

From class


        
          androidx.leanback.media.PlayerAdapter

`void`	`fastForward()` Optional method.
`long`	`getBufferedPosition()` Returns the current buffered position of the media item in milliseconds.
`final PlayerAdapter.Callback`	`getCallback()` Gets callback for event of PlayerAdapter.
`long`	`getCurrentPosition()` Returns the current position of the media item in milliseconds.
`long`	`getDuration()` Returns the duration of the media item in milliseconds.
`long`	`getSupportedActions()` Return xor combination of values defined in PlaybackBaseControlGlue.
`boolean`	`isPlaying()` Returns true if media is currently playing.
`boolean`	`isPrepared()`
`void`	`next()` Optional method.
`void`	`onAttachedToHost(PlaybackGlueHost host)` This method is called attached to associated `PlaybackGlueHost`.
`void`	`onDetachedFromHost()` This method is called when current associated `PlaybackGlueHost` is attached to a different `PlaybackGlue` or `PlaybackGlueHost` is destroyed.
`abstract void`	`pause()` Pauses the media player.
`abstract void`	`play()` Starts the media player.
`void`	`previous()` Optional method.
`void`	`rewind()` Optional method.
`void`	`seekTo(long positionInMs)` Seek to new position.
`final void`	`setCallback(PlayerAdapter.Callback callback)` Sets callback for event of PlayerAdapter.
`void`	`setProgressUpdatingEnabled(boolean enable)` Implement this method to enable or disable progress updating.
`void`	`setRepeatAction(int repeatActionIndex)` Optional method.
`void`	`setShuffleAction(int shuffleActionIndex)` Optional method.

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public constructors

MediaPlayerAdapter

public MediaPlayerAdapter (Context context)

Constructor.

Parameters
`context`	`Context`

Public methods

getBufferedPosition

public long getBufferedPosition ()

Returns the current buffered position of the media item in milliseconds.

Returns
`long`

getCurrentPosition

public long getCurrentPosition ()

Returns the current position of the media item in milliseconds.

Returns
`long`

getDuration

public long getDuration ()

Returns the duration of the media item in milliseconds.

Returns
`long`

getMediaPlayer

public final MediaPlayer getMediaPlayer ()

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.OnPreparedListener) MediaPlayer.setOnVideoSizeChangedListener(MediaPlayer.OnVideoSizeChangedListener) MediaPlayer.setOnErrorListener(MediaPlayer.OnErrorListener) MediaPlayer.setOnSeekCompleteListener(MediaPlayer.OnSeekCompleteListener) MediaPlayer.setOnCompletionListener(MediaPlayer.OnCompletionListener) MediaPlayer.setOnInfoListener(MediaPlayer.OnInfoListener) MediaPlayer.setOnBufferingUpdateListener(MediaPlayer.OnBufferingUpdateListener)

Returns
`MediaPlayer`	The MediaPlayer associated with the MediaPlayerAdapter.

getProgressUpdatingInterval

public int getProgressUpdatingInterval ()

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

Returns
`int`	Update interval of progress UI in milliseconds.

isPlaying

public boolean isPlaying ()

Returns true if media is currently playing.

Returns
`boolean`

isPrepared

public boolean isPrepared ()

Returns
`boolean`	True if MediaPlayer OnPreparedListener is invoked and got a SurfaceHolder if `PlaybackGlueHost` provides SurfaceHolder.

onAttachedToHost

public void onAttachedToHost (PlaybackGlueHost host)

This method is called attached to associated PlaybackGlueHost.

onDetachedFromHost

public void onDetachedFromHost ()

This method is called when current associated PlaybackGlueHost is attached to a different PlaybackGlue or PlaybackGlueHost is destroyed. Subclass may override. A typical implementation will release resources (e.g. MediaPlayer or connection to playback service) in this method.

pause

public void pause ()

Pauses the media player.

play

public void play ()

Starts the media player.

release

public void release ()

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

reset

public void reset ()

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

public void seekTo (long newPosition)

Seek to new position.

Parameters
`newPosition`	`long`: New position in milliseconds.

setDataSource

public boolean setDataSource (Uri uri)

Sets the media source of the player witha given URI.

Parameters
`uri`	`Uri`

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

See also:

MediaPlayer.setDataSource(String)

setProgressUpdatingEnabled

public void setProgressUpdatingEnabled (boolean enabled)

Implement this method to enable or disable progress updating.

Parameters
`enabled`	`boolean`: True to enable progress updating, false otherwise.

Protected methods

onError

protected boolean onError (int what, 
                int extra)

Called to indicate an error.

Parameters

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.

what

int: the type of error that has occurred:

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.

Returns
`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 boolean onInfo (int what, 
                int extra)

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.

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

onSeekComplete

protected void onSeekComplete ()

Called to indicate the completion of a seek operation.