Summary: Inherited Constants | Ctors | Methods | Inherited Methods

MediaControllerGlue

Kotlin |Java

public abstract class MediaControllerGlue
extends PlaybackControlGlue

java.lang.Object
↳	androidx.leanback.media.PlaybackGlue
	↳	androidx.leanback.media.PlaybackControlGlue
		↳	androidx.leanback.media.MediaControllerGlue

This class is deprecated.
Use MediaControllerAdapter with PlaybackTransportControlGlue or PlaybackBannerControlGlue.

A helper class for implementing a glue layer for MediaControllerCompat.

Summary

Inherited constants

From class androidx.leanback.media.PlaybackControlGlue

`int`	`ACTION_CUSTOM_LEFT_FIRST` The adapter key for the first custom control on the left side of the predefined primary controls.
`int`	`ACTION_CUSTOM_RIGHT_FIRST` The adapter key for the first custom control on the right side of the predefined primary controls.
`int`	`ACTION_FAST_FORWARD` The adapter key for the fast forward control.
`int`	`ACTION_PLAY_PAUSE` The adapter key for the play/pause control.
`int`	`ACTION_REWIND` The adapter key for the rewind control.
`int`	`ACTION_SKIP_TO_NEXT` The adapter key for the skip to next control.
`int`	`ACTION_SKIP_TO_PREVIOUS` The adapter key for the skip to previous control.
`int`	`PLAYBACK_SPEED_FAST_L0` The initial (level 0) fast forward playback speed.
`int`	`PLAYBACK_SPEED_FAST_L1` The level 1 fast forward playback speed.
`int`	`PLAYBACK_SPEED_FAST_L2` The level 2 fast forward playback speed.
`int`	`PLAYBACK_SPEED_FAST_L3` The level 3 fast forward playback speed.
`int`	`PLAYBACK_SPEED_FAST_L4` The level 4 fast forward playback speed.
`int`	`PLAYBACK_SPEED_INVALID` Invalid playback speed.
`int`	`PLAYBACK_SPEED_NORMAL` Speed representing playback state that is playing normally.
`int`	`PLAYBACK_SPEED_PAUSED` Speed representing playback state that is paused.

Public constructors
`MediaControllerGlue(Context context, int[] fastForwardSpeeds, int[] rewindSpeeds)` Constructor for the glue.

Public methods
`void`	`attachToMediaController(MediaControllerCompat mediaController)` Attaches to the given media controller.
`void`	`detach()` Detaches from the media controller.
`int`	`getCurrentPosition()` Returns the current position of the media item in milliseconds.
`int`	`getCurrentSpeedId()` Returns the current playback speed.
`Drawable`	`getMediaArt()` Returns a bitmap of the art for the media item.
`final MediaControllerCompat`	`getMediaController()` Returns the media controller currently attached.
`int`	`getMediaDuration()` Returns the duration of the media item in milliseconds.
`CharSequence`	`getMediaSubtitle()` Returns the subtitle of the media item.
`CharSequence`	`getMediaTitle()` Returns the title of the media item.
`long`	`getSupportedActions()` Returns a bitmask of actions supported by the media player.
`boolean`	`hasValidMedia()` Returns true if there is a valid media item.
`boolean`	`isMediaPlaying()` Returns true if media is currently playing.
`void`	`next()` Goes to the next media item.
`void`	`pause()` Pauses the media player.
`void`	`play(int speed)` Start playback at the given speed.
`void`	`previous()` Goes to the previous media item.

Inherited methods

From class


        
          androidx.leanback.media.PlaybackControlGlue

`void`	`enableProgressUpdating(boolean enable)` Override this to start/stop a runnable to call `updateProgress()` at an interval such as `getUpdatePeriod()`.
`PlaybackControlsRow`	`getControlsRow()` Returns the playback controls row managed by the glue layer.
`PlaybackControlsRowPresenter`	`getControlsRowPresenter()` This method is deprecated. PlaybackControlGlue supports any PlaybackRowPresenter, use `getPlaybackRowPresenter()`.
`abstract int`	`getCurrentPosition()` Returns the current position of the media item in milliseconds.
`abstract int`	`getCurrentSpeedId()` Returns the current playback speed.
`int[]`	`getFastForwardSpeeds()` Returns the fast forward speeds.
`abstract Drawable`	`getMediaArt()` Returns a bitmap of the art for the media item.
`abstract int`	`getMediaDuration()` Returns the duration of the media item in milliseconds.
`abstract CharSequence`	`getMediaSubtitle()` Returns the subtitle of the media item.
`abstract CharSequence`	`getMediaTitle()` Returns the title of the media item.
`PlaybackRowPresenter`	`getPlaybackRowPresenter()` Returns the playback row Presenter to be passed to `PlaybackGlueHost` in `onAttachedToHost(PlaybackGlueHost)`.
`int[]`	`getRewindSpeeds()` Returns the rewind speeds.
`abstract long`	`getSupportedActions()` Returns a bitmask of actions supported by the media player.
`int`	`getUpdatePeriod()` Returns the time period in milliseconds that should be used to update the progress.
`abstract boolean`	`hasValidMedia()` Returns true if there is a valid media item.
`boolean`	`isFadingEnabled()` Returns true if controls are set to fade when media is playing.
`abstract boolean`	`isMediaPlaying()` Returns true if media is currently playing.
`boolean`	`isPlaying()` Returns true if media is currently playing.
`void`	`onActionClicked(Action action)` Handles action clicks.
`void`	`onAttachedToHost(PlaybackGlueHost host)` This method is called attached to associated `PlaybackGlueHost`.
`void`	`onCreateControlsRowAndPresenter()` Instantiating a `PlaybackControlsRow` and corresponding `PlaybackControlsRowPresenter`.
`void`	`onCreatePrimaryActions(SparseArrayObjectAdapter primaryActionsAdapter)` May be overridden to add primary actions to the adapter.
`void`	`onCreateSecondaryActions(ArrayObjectAdapter secondaryActionsAdapter)` May be overridden to add secondary actions to the adapter.
`void`	`onDetachedFromHost()` This method is called when current associated `PlaybackGlueHost` is attached to a different `PlaybackGlue` or `PlaybackGlueHost` is destroyed .
`void`	`onHostStart()` This method is called when `PlaybackGlueHost` is started.
`void`	`onHostStop()` This method is called when `PlaybackGlueHost` is stopped.
`boolean`	`onKey(View v, int keyCode, KeyEvent event)` Handles key events and returns true if handled.
`void`	`onMetadataChanged()` Must be called appropriately by a subclass when the metadata state has changed.
`void`	`onStateChanged()` Must be called appropriately by a subclass when the playback state has changed.
`void`	`play(int speed)` Start playback at the given speed.
`final void`	`play()` Starts the media player.
`void`	`setControlsRow(PlaybackControlsRow controlsRow)` Sets the controls row to be managed by the glue layer.
`void`	`setControlsRowPresenter(PlaybackControlsRowPresenter presenter)` This method is deprecated. PlaybackControlGlue supports any PlaybackRowPresenter, use `setPlaybackRowPresenter(PlaybackRowPresenter)`.
`void`	`setFadingEnabled(boolean enable)` Sets the controls to fade after a timeout when media is playing.
`void`	`setPlaybackRowPresenter(PlaybackRowPresenter presenter)` Sets the controls row Presenter to be passed to `PlaybackGlueHost` in `onAttachedToHost(PlaybackGlueHost)`.
`void`	`updateProgress()` Updates the progress bar based on the current media playback position.

From class


        
          androidx.leanback.media.PlaybackGlue

`void`	`addPlayerCallback(PlaybackGlue.PlayerCallback playerCallback)` Add a PlayerCallback.
`Context`	`getContext()` Returns the context.
`PlaybackGlueHost`	`getHost()`
`List<PlaybackGlue.PlayerCallback>`	`getPlayerCallbacks()`
`boolean`	`isPlaying()` Returns true if media is currently playing.
`boolean`	`isPrepared()` Returns true when the media player is prepared to start media playback.
`void`	`next()` Goes to the next media item.
`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`	`onHostPause()` This method is called when `PlaybackGlueHost` is paused.
`void`	`onHostResume()` This method is called when `PlaybackGlueHost` is resumed.
`void`	`onHostStart()` This method is called when `PlaybackGlueHost` is started.
`void`	`onHostStop()` This method is called when `PlaybackGlueHost` is stopped.
`void`	`pause()` Pauses the media player.
`void`	`play()` Starts the media player.
`void`	`playWhenPrepared()` Starts play when `isPrepared()` becomes true.
`void`	`previous()` Goes to the previous media item.
`void`	`removePlayerCallback(PlaybackGlue.PlayerCallback callback)` Remove a PlayerCallback.
`final void`	`setHost(PlaybackGlueHost host)` This method is used to associate a PlaybackGlue with the `PlaybackGlueHost` which provides UI and optional `SurfaceHolderGlueHost`.

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()`

From interface


        
          androidx.leanback.widget.OnActionClickedListener


      onActionClicked(Action action)

Callback fired when the host fragment receives an action.

From interface


        
          android.view.View.OnKeyListener

abstract boolean onKey(View arg0, int arg1, KeyEvent arg2)

Public constructors

MediaControllerGlue

public MediaControllerGlue (Context context, 
                int[] fastForwardSpeeds, 
                int[] rewindSpeeds)

Constructor for the glue.

Parameters
`fastForwardSpeeds`	`int`: Array of seek speeds for fast forward.
`rewindSpeeds`	`int`: Array of seek speeds for rewind.

Public methods

attachToMediaController

public void attachToMediaController (MediaControllerCompat mediaController)

Attaches to the given media controller.

Parameters
`mediaController`	`MediaControllerCompat`

detach

public void detach ()

Detaches from the media controller. Must be called when the object is no longer needed.

getCurrentPosition

public int getCurrentPosition ()

Returns the current position of the media item in milliseconds.

Returns
`int`

getCurrentSpeedId

public int getCurrentSpeedId ()

Returns the current playback speed. When playing normally, PLAYBACK_SPEED_NORMAL should be returned.

Returns
`int`

getMediaArt

public Drawable getMediaArt ()

Returns a bitmap of the art for the media item.

Returns
`Drawable`

getMediaController

public final MediaControllerCompat getMediaController ()

Returns the media controller currently attached.

Returns
`MediaControllerCompat`

getMediaDuration

public int getMediaDuration ()

Returns the duration of the media item in milliseconds.

Returns
`int`

getMediaSubtitle

public CharSequence getMediaSubtitle ()

Returns the subtitle of the media item.

Returns
`CharSequence`

getMediaTitle

public CharSequence getMediaTitle ()

Returns the title of the media item.

Returns
`CharSequence`

getSupportedActions

public long getSupportedActions ()

Returns a bitmask of actions supported by the media player.

Returns
`long`

hasValidMedia

public boolean hasValidMedia ()

Returns true if there is a valid media item.

Returns
`boolean`

isMediaPlaying

public boolean isMediaPlaying ()

Returns true if media is currently playing.

Returns
`boolean`

public void next ()

Goes to the next media item. This method is optional.

pause

public void pause ()

Pauses the media player.

play

public void play (int speed)

Start playback at the given speed.

Parameters
`speed`	`int`: The desired playback speed. For normal playback this will be `PlaybackControlGlue.PLAYBACK_SPEED_NORMAL`; higher positive values for fast forward, and negative values for rewind.

public void previous ()

Goes to the previous media item. This method is optional.