MediaControllerGlue

Added in 1.1.0

Deprecated in 1.1.0

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

Public constructors
`MediaControllerGlue( context: Context!, fastForwardSpeeds: IntArray!, rewindSpeeds: IntArray! )` Constructor for the glue.

Public functions
`Unit`	`attachToMediaController(mediaController: MediaControllerCompat!)` Attaches to the given media controller.
`Unit`	`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.
`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.
`Unit`	`next()` Goes to the next media item.
`Unit`	`pause()` Pauses the media player.
`Unit`	`play(speed: Int)` Start playback at the given speed.
`Unit`	`previous()` Goes to the previous media item.

Inherited Constants

From androidx.leanback.media.PlaybackControlGlue

`const Int`	`ACTION_CUSTOM_LEFT_FIRST = 1` The adapter key for the first custom control on the left side of the predefined primary controls.
`const Int`	`ACTION_CUSTOM_RIGHT_FIRST = 4096` The adapter key for the first custom control on the right side of the predefined primary controls.
`const Int`	`ACTION_FAST_FORWARD = 128` The adapter key for the fast forward control.
`const Int`	`ACTION_PLAY_PAUSE = 64` The adapter key for the play/pause control.
`const Int`	`ACTION_REWIND = 32` The adapter key for the rewind control.
`const Int`	`ACTION_SKIP_TO_NEXT = 256` The adapter key for the skip to next control.
`const Int`	`ACTION_SKIP_TO_PREVIOUS = 16` The adapter key for the skip to previous control.
`const Int`	`PLAYBACK_SPEED_FAST_L0 = 10` The initial (level 0) fast forward playback speed.
`const Int`	`PLAYBACK_SPEED_FAST_L1 = 11` The level 1 fast forward playback speed.
`const Int`	`PLAYBACK_SPEED_FAST_L2 = 12` The level 2 fast forward playback speed.
`const Int`	`PLAYBACK_SPEED_FAST_L3 = 13` The level 3 fast forward playback speed.
`const Int`	`PLAYBACK_SPEED_FAST_L4 = 14` The level 4 fast forward playback speed.
`const Int`	`PLAYBACK_SPEED_INVALID = -1` Invalid playback speed.
`const Int`	`PLAYBACK_SPEED_NORMAL = 1` Speed representing playback state that is playing normally.
`const Int`	`PLAYBACK_SPEED_PAUSED = 0` Speed representing playback state that is paused.

Inherited functions

From androidx.leanback.widget.OnActionClickedListener

abstract Unit

onActionClicked(action: Action)

Callback fired when the host fragment receives an action.

From androidx.leanback.media.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()` This function is deprecated. PlaybackControlGlue supports any PlaybackRowPresenter, use `getPlaybackRowPresenter`.
`IntArray<Int>!`	`getFastForwardSpeeds()` Returns the fast forward speeds.
`PlaybackRowPresenter!`	`getPlaybackRowPresenter()` Returns the playback row Presenter to be passed to `PlaybackGlueHost` in `onAttachedToHost`.
`IntArray<Int>!`	`getRewindSpeeds()` Returns the rewind speeds.
`Int`	`getUpdatePeriod()` Returns the time period in milliseconds that should be used to update the progress.
`Boolean`	`isFadingEnabled()` Returns true if controls are set to fade when media is playing.
`Boolean`	`isPlaying()` Returns true if media is currently playing.
`Unit`	`onActionClicked(action: Action!)` Handles action clicks.
`Unit`	`onAttachedToHost(host: PlaybackGlueHost)` This method is called attached to associated `PlaybackGlueHost`.
`Unit`	`onCreateControlsRowAndPresenter()` Instantiating a `PlaybackControlsRow` and corresponding `PlaybackControlsRowPresenter`.
`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()` This method is called when current associated `PlaybackGlueHost` is attached to a different `PlaybackGlue` or `PlaybackGlueHost` is destroyed .
`Unit`	`onHostStart()` This method is called when `PlaybackGlueHost` is started.
`Unit`	`onHostStop()` This method is called when `PlaybackGlueHost` is stopped.
`Boolean`	`onKey(v: View!, keyCode: Int, event: KeyEvent!)` Handles key events and returns true if handled.
`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.
`Unit`	`play()` Starts the media player.
`Unit`	`setControlsRow(controlsRow: PlaybackControlsRow!)` Sets the controls row to be managed by the glue layer.
`Unit`	`setControlsRowPresenter(presenter: PlaybackControlsRowPresenter!)` This function is deprecated. PlaybackControlGlue supports any PlaybackRowPresenter, use `setPlaybackRowPresenter`.
`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`.
`Unit`	`updateProgress()` Updates the progress bar based on the current media playback position.

From androidx.leanback.media.PlaybackGlue

`Unit`	`addPlayerCallback(playerCallback: PlaybackGlue.PlayerCallback)` Add a PlayerCallback.
`Context`	`getContext()` Returns the context.
`PlaybackGlueHost?`	`getHost()`
`(Mutable)List<PlaybackGlue.PlayerCallback!>?`	`getPlayerCallbacks()`
`Boolean`	`isPrepared()` Returns true when the media player is prepared to start media playback.
`Unit`	`onHostPause()` This method is called when `PlaybackGlueHost` is paused.
`Unit`	`onHostResume()` This method is called when `PlaybackGlueHost` is resumed.
`Unit`	`playWhenPrepared()` Starts play when `isPrepared` becomes true.
`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 android.view.View.OnKeyListener

abstract Boolean

onKey(p: View!, p1: Int, p2: KeyEvent!)

Public constructors

MediaControllerGlue

Added in 1.1.0

Deprecated in 1.1.0

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 functions

attachToMediaController

Added in 1.1.0

Deprecated in 1.1.0

fun attachToMediaController(mediaController: MediaControllerCompat!): Unit

Attaches to the given media controller.

detach

Added in 1.1.0

Deprecated in 1.1.0

fun detach(): Unit

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

getCurrentPosition

fun getCurrentPosition(): Int

Returns the current position of the media item in milliseconds.

getCurrentSpeedId

fun getCurrentSpeedId(): Int

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

getMediaArt

fun getMediaArt(): Drawable!

Returns a bitmap of the art for the media item.

getMediaController

Added in 1.1.0

Deprecated in 1.1.0

fun getMediaController(): MediaControllerCompat!

Returns the media controller currently attached.

getMediaDuration

fun getMediaDuration(): Int

Returns the duration of the media item in milliseconds.

getMediaSubtitle

fun getMediaSubtitle(): CharSequence!

Returns the subtitle of the media item.

getMediaTitle

fun getMediaTitle(): CharSequence!

Returns the title of the media item.

getSupportedActions

fun getSupportedActions(): Long

Returns a bitmask of actions supported by the media player.

hasValidMedia

fun hasValidMedia(): Boolean

Returns true if there is a valid media item.

isMediaPlaying

fun isMediaPlaying(): Boolean

Returns true if media is currently playing.

fun next(): Unit

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

pause

fun pause(): Unit

Pauses the media player.

play

fun play(speed: Int): Unit

Start playback at the given speed.

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

fun previous(): Unit

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