belongs to Maven artifact androidx.leanback:leanback:1.0.0-alpha1

PlaybackSupportFragmentGlueHost

public class PlaybackSupportFragmentGlueHost
extends PlaybackGlueHost implements PlaybackSeekUi

java.lang.Object
   ↳ androidx.leanback.media.PlaybackGlueHost
     ↳ androidx.leanback.app.PlaybackSupportFragmentGlueHost


PlaybackGlueHost implementation the interaction between this class and PlaybackSupportFragment.

Summary

Public constructors

PlaybackSupportFragmentGlueHost(PlaybackSupportFragment fragment)

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 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 setPlaybackSeekUiClient(PlaybackSeekUi.Client client)

Interface to be implemented by UI widget to support PlaybackSeekUi.

void showControlsOverlay(boolean runAnimation)

Show controls overlay.

Inherited methods

Public constructors

PlaybackSupportFragmentGlueHost

PlaybackSupportFragmentGlueHost (PlaybackSupportFragment fragment)

Parameters
fragment PlaybackSupportFragment

Public methods

fadeOut

void fadeOut ()

This method is deprecated.
Call hideControlsOverlay(boolean)

Fades out the playback overlay immediately.

getPlayerCallback

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

void hideControlsOverlay (boolean runAnimation)

Hide controls overlay.

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

isControlsOverlayAutoHideEnabled

boolean isControlsOverlayAutoHideEnabled ()

Returns true if auto hides controls overlay.

Returns
boolean True if auto hiding controls overlay.

isControlsOverlayVisible

boolean isControlsOverlayVisible ()

Returns true if controls overlay is visible, false otherwise.

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

notifyPlaybackRowChanged

void notifyPlaybackRowChanged ()

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

setControlsOverlayAutoHideEnabled

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.

setHostCallback

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

void setOnActionClickedListener (OnActionClickedListener listener)

Sets the View.OnClickListener on this fragment.

Parameters
listener OnActionClickedListener

setOnKeyInterceptListener

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

void setPlaybackRow (Row row)

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

Parameters
row Row

setPlaybackRowPresenter

void setPlaybackRowPresenter (PlaybackRowPresenter presenter)

Sets PlaybackRowPresenter for rendering the playback controls.

Parameters
presenter PlaybackRowPresenter

setPlaybackSeekUiClient

void setPlaybackSeekUiClient (PlaybackSeekUi.Client client)

Interface to be implemented by UI widget to support PlaybackSeekUi.

Parameters
client PlaybackSeekUi.Client

showControlsOverlay

void showControlsOverlay (boolean runAnimation)

Show controls overlay.

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