PlaybackGlueHost

Kotlin |Java

abstract class PlaybackGlueHost

kotlin.Any
↳	androidx.leanback.media.PlaybackGlueHost

Known Direct Subclasses

PlaybackFragmentGlueHost, PlaybackSupportFragmentGlueHost

PlaybackFragmentGlueHost	`PlaybackGlueHost` implementation the interaction between this class and `PlaybackFragment`.
PlaybackSupportFragmentGlueHost	`PlaybackGlueHost` implementation the interaction between this class and `PlaybackSupportFragment`.

Known Indirect Subclasses

VideoFragmentGlueHost, VideoSupportFragmentGlueHost

VideoFragmentGlueHost	`PlaybackGlueHost` implementation the interaction between `PlaybackGlue` and `VideoFragment`.
VideoSupportFragmentGlueHost	`PlaybackGlueHost` implementation the interaction between `PlaybackGlue` and `VideoSupportFragment`.

This class represents the UI (e.g. Fragment/Activity) hosting playback controls and defines the interaction between PlaybackGlue and the host. PlaybackGlueHost provides the following functions:

Render UI of PlaybackGlue: setPlaybackRow(Row), setPlaybackRowPresenter(PlaybackRowPresenter).

Client for fragment/activity onStart/onStop: setHostCallback(HostCallback).

Auto fade out controls after a short period: setFadingEnabled(boolean).

Key listener and ActionListener. setOnKeyInterceptListener(View.OnKeyListener), setOnActionClickedListener(OnActionClickedListener).

Subclass of PlaybackGlueHost may implement optional interfaces:

SurfaceHolderGlueHost to provide SurfaceView for video playback.

PlaybackSeekUi to provide seek UI to glue

These optional interfaces should be accessed by glue in PlaybackGlue#onAttachedToHost(PlaybackGlueHost).

Summary

Nested classes
abstract	`HostCallback` Callbacks triggered by the host(e.g. fragment) hosting the video controls/surface.
open	`PlayerCallback` Optional Client that implemented by PlaybackGlueHost to respond to player event.

Public constructors
`<init>()` This class represents the UI (e.g. Fragment/Activity) hosting playback controls and defines the interaction between

Public methods
open Unit	`fadeOut()` Fades out the playback overlay immediately.
open PlaybackGlueHost.PlayerCallback!	`getPlayerCallback()` Implemented by PlaybackGlueHost for responding to player events.
open Unit	`hideControlsOverlay(runAnimation: Boolean)` Hide controls overlay.
open Boolean	`isControlsOverlayAutoHideEnabled()` Returns true if auto hides controls overlay.
open Boolean	`isControlsOverlayVisible()` Returns true if controls overlay is visible, false otherwise.
open Unit	`notifyPlaybackRowChanged()` Notifies host about a change so it can update the view.
open Unit	`setControlsOverlayAutoHideEnabled(enabled: Boolean)` Enables or disables controls overlay auto hidden.
open Unit	`setFadingEnabled(enable: Boolean)` Enables or disables view fading.
open Unit	`setHostCallback(callback: PlaybackGlueHost.HostCallback!)` Sets the host `HostCallback` callback on the host.
open Unit	`setOnActionClickedListener(listener: OnActionClickedListener!)` Sets the `View.OnClickListener` on this fragment.
open Unit	`setOnKeyInterceptListener(onKeyListener: OnKeyListener!)` Sets the `android.view.View.OnKeyListener` on the host.
open Unit	`setPlaybackRow(row: Row!)` Sets the `Row` that represents the information on control items that needs to be rendered.
open Unit	`setPlaybackRowPresenter(presenter: PlaybackRowPresenter!)` Sets `PlaybackRowPresenter` for rendering the playback controls.
open Unit	`showControlsOverlay(runAnimation: Boolean)` Show controls overlay.

Public constructors

<init>

PlaybackGlueHost()

This class represents the UI (e.g. Fragment/Activity) hosting playback controls and defines the interaction between PlaybackGlue and the host. PlaybackGlueHost provides the following functions:

Render UI of PlaybackGlue: setPlaybackRow(Row), setPlaybackRowPresenter(PlaybackRowPresenter).

Client for fragment/activity onStart/onStop: setHostCallback(HostCallback).

Auto fade out controls after a short period: setFadingEnabled(boolean).

Key listener and ActionListener. setOnKeyInterceptListener(View.OnKeyListener), setOnActionClickedListener(OnActionClickedListener).

Subclass of PlaybackGlueHost may implement optional interfaces:

SurfaceHolderGlueHost to provide SurfaceView for video playback.

PlaybackSeekUi to provide seek UI to glue

These optional interfaces should be accessed by glue in PlaybackGlue#onAttachedToHost(PlaybackGlueHost).

Public methods

fadeOut

open fun fadeOut(): Unit

Deprecated: Call hideControlsOverlay(boolean)

Fades out the playback overlay immediately.

getPlayerCallback

open fun <