LeanbackPlayerAdapter

Artifact: androidx.media3:media3-ui-leanback

Kotlin |Java

@UnstableApi
public final class LeanbackPlayerAdapter extends PlayerAdapter implements Runnable

java.lang.Object
↳	androidx.leanback.media.PlayerAdapter
	↳	androidx.media3.ui.leanback.LeanbackPlayerAdapter

Leanback PlayerAdapter implementation for Player.

Summary

Public constructors
`LeanbackPlayerAdapter( Context context, Player player, int updatePeriodMs )` Builds an instance.

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.
`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`	`run()`
`void`	`seekTo(long positionInMs)` Seek to new position.
`void`	`setErrorMessageProvider( @Nullable ErrorMessageProvider<PlaybackException> errorMessageProvider )` Sets the optional `ErrorMessageProvider`.
`void`	`setProgressUpdatingEnabled(boolean enable)` Implement this method to enable or disable progress updating.

Inherited methods

From androidx.leanback.media.PlayerAdapter

`void`	`fastForward()` Optional method.
`final @Nullable PlayerAdapter.Callback`	`getCallback()` Gets callback for event of PlayerAdapter.
`long`	`getSupportedActions()` Return xor combination of values defined in PlaybackBaseControlGlue.
`void`	`next()` Optional method.
`void`	`previous()` Optional method.
`void`	`rewind()` Optional method.
`final void`	`setCallback(@Nullable PlayerAdapter.Callback callback)` Sets callback for event of PlayerAdapter.
`void`	`setRepeatAction(int repeatActionIndex)` Optional method.
`void`	`setShuffleAction(int shuffleActionIndex)` Optional method.

Public constructors

LeanbackPlayerAdapter

public LeanbackPlayerAdapter(
    Context context,
    Player player,
    int updatePeriodMs
)

Builds an instance. Note that the PlayerAdapter does not manage the lifecycle of the Player instance. The caller remains responsible for releasing the player when it's no longer required.

Parameters
`Context context`	The current `Context` (activity).
`Player player`	The `Player` being used.
`int updatePeriodMs`	The delay between player control updates, in milliseconds.

Public methods

getBufferedPosition

public long getBufferedPosition()

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

getCurrentPosition

public long getCurrentPosition()

Returns the current position of the media item in milliseconds.

getDuration

public long getDuration()

Returns the duration of the media item in milliseconds.

isPlaying

public boolean isPlaying()

Returns true if media is currently playing.

isPrepared

public boolean isPrepared()

Returns
`boolean`	True if media is ready for playback, false otherwise.

onAttachedToHost

public void onAttachedToHost(PlaybackGlueHost host)

This method is called attached to associated PlaybackGlueHost.

Parameters
`PlaybackGlueHost host`

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.

run

public void run()

seekTo

public void seekTo(long positionInMs)

Seek to new position.

Parameters
`long positionInMs`	New position in milliseconds.

setErrorMessageProvider

public void setErrorMessageProvider(
    @Nullable ErrorMessageProvider<PlaybackException> errorMessageProvider
)

Sets the optional ErrorMessageProvider.

Parameters
`@Nullable ErrorMessageProvider<PlaybackException> errorMessageProvider`	The `ErrorMessageProvider`.

setProgressUpdatingEnabled

public void setProgressUpdatingEnabled(boolean enable)

Implement this method to enable or disable progress updating.

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