PlaybackGlueHost

public abstract class PlaybackGlueHost
extends Object

java.lang.Object
   ↳ androidx.leanback.media.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:

Subclass of PlaybackGlueHost may implement optional interfaces: These optional interfaces should be accessed by glue in PlaybackGlue.onAttachedToHost(PlaybackGlueHost).

Summary

Nested classes

class PlaybackGlueHost.HostCallback

Callbacks triggered by the host(e.g. 

class PlaybackGlueHost.PlayerCallback

Optional Client that implemented by PlaybackGlueHost to respond to player event. 

Public constructors

PlaybackGlueHost()

Public methods

void fadeOut()

This method is deprecated. Call hideControlsOverlay(boolean)

PlaybackGlueHost.PlayerCallback getPlayerCallback()

Implemented by PlaybackGlueHost for responding to player events.

void hideControlsOverlay(boolean runAnimation)

Hide controls overlay.

boolean isControlsOverlayAutoHideEnabled()

Returns true if auto hides controls overlay.

boolean isControlsOverlayVisible()

Returns true if controls overlay is visible, false otherwise.

void notifyPlaybackRowChanged()

Notifies host about a change so it can update the view.

void setControlsOverlayAutoHideEnabled(boolean enabled)

Enables or disables controls overlay auto hidden.

void setFadingEnabled(boolean enable)

This method is deprecated. Use setControlsOverlayAutoHideEnabled(boolean)

void setHostCallback(PlaybackGlueHost.HostCallback callback)

Sets the host PlaybackGlueHost.HostCallback callback on the host.

void setOnActionClickedListener(OnActionClickedListener listener)

Sets the View.OnClickListener on this fragment.

void setOnKeyInterceptListener(View.OnKeyListener onKeyListener)

Sets the View.OnKeyListener on the host.

void setPlaybackRow(Row row)

Sets the Row that represents the information on control items that needs to be rendered.

void setPlaybackRowPresenter(PlaybackRowPresenter presenter)

Sets PlaybackRowPresenter for rendering the playback controls.

void showControlsOverlay(boolean runAnimation)

Show controls overlay.

Inherited methods

Public constructors

PlaybackGlueHost

public PlaybackGlueHost ()

Public methods

fadeOut

public void fadeOut ()

This method is deprecated.
Call hideControlsOverlay(boolean)

Fades out the playback overlay immediately.

getPlayerCallback

public PlaybackGlueHost.PlayerCallback getPlayerCallback ()

Implemented by PlaybackGlueHost for responding to player events. Such as showing a spinning wheel progress bar when PlaybackGlueHost.PlayerCallback.onBufferingStateChanged(boolean).

Returns
PlaybackGlueHost.PlayerCallback PlayerEventCallback that Host supports, null if not supported.

hideControlsOverlay

public void hideControlsOverlay (boolean runAnimation)

Hide controls overlay.

Parameters
runAnimation boolean: True to run animation, false otherwise.

isControlsOverlayAutoHideEnabled

public boolean isControlsOverlayAutoHideEnabled ()

Returns true if auto hides controls overlay.

Returns
boolean True if auto hiding controls overlay.

isControlsOverlayVisible

public boolean isControlsOverlayVisible ()

Returns true if controls overlay is visible, false otherwise.

Returns
boolean True if controls overlay is visible, false otherwise.

notifyPlaybackRowChanged

public void notifyPlaybackRowChanged ()

Notifies host about a change so it can update the view.

setControlsOverlayAutoHideEnabled

public void setControlsOverlayAutoHideEnabled (boolean enabled)

Enables or disables controls overlay auto hidden. If enabled, the view will be faded out after a time period.

Parameters
enabled boolean: True to enable auto hidden of controls overlay.

setFadingEnabled

public void setFadingEnabled (boolean enable)

This method is deprecated.
Use setControlsOverlayAutoHideEnabled(boolean)

Enables or disables view fading. If enabled, the view will be faded in when the fragment starts and will fade out after a time period.

Parameters
enable boolean

setHostCallback

public void setHostCallback (PlaybackGlueHost.HostCallback callback)

Sets the host PlaybackGlueHost.HostCallback callback on the host. This method should only be called by PlaybackGlue. App should not directly call this method, app should override PlaybackGlue.onHostStart() etc.

Parameters
callback PlaybackGlueHost.HostCallback

setOnActionClickedListener

public void setOnActionClickedListener (OnActionClickedListener listener)

Sets the View.OnClickListener on this fragment.

Parameters
listener OnActionClickedListener

setOnKeyInterceptListener

public void setOnKeyInterceptListener (View.OnKeyListener onKeyListener)

Sets the View.OnKeyListener on the host. This would trigger the listener when a KeyEvent is unhandled by the host.

Parameters
onKeyListener View.OnKeyListener

setPlaybackRow

public void setPlaybackRow (Row row)

Sets the Row that represents the information on control items that needs to be rendered.

Parameters
row Row

setPlaybackRowPresenter

public void setPlaybackRowPresenter (PlaybackRowPresenter presenter)

Sets PlaybackRowPresenter for rendering the playback controls.

Parameters
presenter PlaybackRowPresenter

showControlsOverlay

public void showControlsOverlay (boolean runAnimation)

Show controls overlay.

Parameters
runAnimation boolean: True to run animation, false otherwise.