MediaControllerGlue

Kotlin |Java

abstract class MediaControllerGlue : PlaybackControlGlue

kotlin.Any
↳	androidx.leanback.media.PlaybackGlue
	↳	androidx.leanback.media.PlaybackControlGlue
		↳	androidx.leanback.media.MediaControllerGlue

A helper class for implementing a glue layer for MediaControllerCompat.

Summary

Inherited constants

From class 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. The negative of this value is for rewind at the same speed.
`Int`	`PLAYBACK_SPEED_FAST_L1` The level 1 fast forward playback speed. The negative of this value is for rewind at the same speed.
`Int`	`PLAYBACK_SPEED_FAST_L2` The level 2 fast forward playback speed. The negative of this value is for rewind at the same speed.
`Int`	`PLAYBACK_SPEED_FAST_L3` The level 3 fast forward playback speed. The negative of this value is for rewind at the same speed.
`Int`	`PLAYBACK_SPEED_FAST_L4` The level 4 fast forward playback speed. The negative of this value is for rewind at the same 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
`<init>(context: Context!, fastForwardSpeeds: IntArray!, rewindSpeeds: IntArray!)` Constructor for the glue.

Public methods
open Unit	`attachToMediaController(mediaController: MediaControllerCompat!)` Attaches to the given media controller.
open Unit	`detach()` Detaches from the media controller.
open Int	`getCurrentPosition()`
open Int	`getCurrentSpeedId()`
open Drawable!	`getMediaArt()`
MediaControllerCompat!	`getMediaController()` Returns the media controller currently attached.
open Int	`getMediaDuration()`
open CharSequence!	`getMediaSubtitle()`
open CharSequence!	`getMediaTitle()`
open Long	`getSupportedActions()`
open Boolean	`hasValidMedia()`
open Boolean	`isMediaPlaying()`
open Unit	`next()`
open Unit	`pause()`
open Unit	`play(speed: Int)`
open Unit	`previous()`

Inherited functions

From class PlaybackGlue

`Unit`	`addPlayerCallback(playerCallback: PlaybackGlue.PlayerCallback!)` Add a PlayerCallback.
`Context!`	`getContext()` Returns the context.
`PlaybackGlueHost!`	`getHost()`
`MutableList<PlaybackGlue.PlayerCallback!>!`	`getPlayerCallbacks()`
`Boolean`	`isPrepared()` Returns true when the media player is prepared to start media playback. When returning false, app may listen to `PlayerCallback#onPreparedStateChanged(PlaybackGlue)` event.
`Unit`	`next()` Goes to the next media item. This method is optional.
`Unit`	`onHostPause()` This method is called when `PlaybackGlueHost` is paused. Subclass may override.
`Unit`	`onHostResume()` This method is called when `PlaybackGlueHost` is resumed. Subclass may override.
`Unit`	`pause()` Pauses the media player.
`Unit`	`playWhenPrepared()` Starts play when `isPrepared()` becomes true.
`Unit`	`previous()` Goes to the previous media item. This method is optional.
`Unit`	`removePlayerCallback(callback: PlaybackGlue.PlayerCallback!)` Remove a PlayerCallback.
`Unit`	`setHost(host: PlaybackGlueHost!)` This method is used to associate a PlaybackGlue with the `PlaybackGlueHost` which provides UI and optional `SurfaceHolderGlueHost`.

From class PlaybackControlGlue

`Unit`	`enableProgressUpdating(enable: Boolean)` 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()` Returns the playback controls row Presenter managed by the glue layer.
`IntArray!`	`getFastForwardSpeeds()` Returns the fast forward speeds.
`PlaybackRowPresenter!`	`getPlaybackRowPresenter()` Returns the playback row Presenter to be passed to `PlaybackGlueHost` in `onAttachedToHost(PlaybackGlueHost)`.
`IntArray!`	`getRewindSpeeds()` Returns the rewind speeds.
`Int`	`getUpdatePeriod()` Returns the time period in milliseconds that should be used to update the progress. See `updateProgress()`.
`Boolean`	`isFadingEnabled()` Returns true if controls are set to fade when media is playing.
`Boolean`	`isPlaying()`
`Unit`	`onActionClicked(action: Action!)` Handles action clicks. A subclass may override this add support for additional actions.
`Unit`	`onAttachedToHost(host: PlaybackGlueHost!)`
`Unit`	`onCreateControlsRowAndPresenter()` Instantiating a `PlaybackControlsRow` and corresponding `PlaybackControlsRowPresenter`. Subclass may override.
`Unit`	`onCreatePrimaryActions(primaryActionsAdapter: SparseArrayObjectAdapter!)` May be overridden to add primary actions to the adapter.
`Unit`	`onCreateSecondaryActions(secondaryActionsAdapter: ArrayObjectAdapter!)` May be overridden to add secondary actions to the adapter.
`Unit`	`onDetachedFromHost()`
`Unit`	`onHostStart()`
`Unit`	`onHostStop()`
`Boolean`	`onKey(v: View!, keyCode: Int, event: KeyEvent!)` Handles key events and returns true if handled. A subclass may override this to provide additional support.
`Unit`	`onMetadataChanged()` Must be called appropriately by a subclass when the metadata state has changed.
`Unit`	`onStateChanged()` Must be called appropriately by a subclass when the playback state has changed. It updates the playback state displayed on the media player.
`Unit`	`play()`
`Unit`	`setControlsRow(controlsRow: PlaybackControlsRow!)` Sets the controls row to be managed by the glue layer. The primary actions and playback state related aspects of the row are updated by the glue.
`Unit`	`setControlsRowPresenter(presenter: PlaybackControlsRowPresenter!)` Sets the controls row Presenter to be managed by the glue layer.
`Unit`	`setFadingEnabled(enable: Boolean)` Sets the controls to fade after a timeout when media is playing.
`Unit`	`setPlaybackRowPresenter(presenter: PlaybackRowPresenter!)` Sets the controls row Presenter to be passed to `PlaybackGlueHost` in `onAttachedToHost(PlaybackGlueHost)`.
`Unit`	`updateProgress()` Updates the progress bar based on the current media playback position.

Public constructors

<init>

MediaControllerGlue(
    context: Context!, 
    fastForwardSpeeds: IntArray!, 
    rewindSpeeds: IntArray!)

Constructor for the glue.

Parameters
`context`	Context!:
`fastForwardSpeeds`	IntArray!: Array of seek speeds for fast forward.
`rewindSpeeds`	IntArray!: Array of seek speeds for rewind.

Public methods

attachToMediaController

open fun attachToMediaController(mediaController: MediaControllerCompat!): Unit

Attaches to the given media controller.

detach

open fun detach(): Unit

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

getCurrentPosition

open fun getCurrentPosition(): Int

getCurrentSpeedId

open fun getCurrentSpeedId(): Int

getMediaArt

open fun getMediaArt(): Drawable!

getMediaController

fun getMediaController(): MediaControllerCompat!

Returns the media controller currently attached.

getMediaDuration

open fun getMediaDuration(): Int

getMediaSubtitle

open fun getMediaSubtitle(): CharSequence!

getMediaTitle

open fun getMediaTitle(): CharSequence!

getSupportedActions

open fun getSupportedActions(): Long

hasValidMedia

open fun hasValidMedia(): Boolean

isMediaPlaying

open fun isMediaPlaying(): Boolean

open fun next(): Unit

pause

open fun pause(): Unit

play

open fun play(speed: Int): Unit

open fun previous(): Unit