PlaybackSupportFragmentGlueHost

Added in 1.1.0

Kotlin |Java

public class PlaybackSupportFragmentGlueHost extends PlaybackGlueHost implements PlaybackSeekUi

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

Known direct subclasses

VideoSupportFragmentGlueHost

VideoSupportFragmentGlueHost

PlaybackGlueHost implementation the interaction between PlaybackGlue and VideoSupportFragment.

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`
`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 `HostCallback` callback on the host.
`void`	`setOnActionClickedListener(OnActionClickedListener listener)` Sets the `View.OnClickListener` on this fragment.
`void`	`setOnKeyInterceptListener(View.OnKeyListener onKeyListener)` Sets the `android.view.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

From androidx.leanback.media.PlaybackGlueHost

void

setFadingEnabled(boolean enable)

This method is deprecated.

Use setControlsOverlayAutoHideEnabled

Public constructors

PlaybackSupportFragmentGlueHost

Added in 1.1.0

public PlaybackSupportFragmentGlueHost(PlaybackSupportFragment fragment)

Public methods

fadeOut

Added in 1.2.0-alpha04

public void fadeOut()

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 onBufferingStateChanged.

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

hideControlsOverlay

public void hideControlsOverlay(boolean runAnimation)

Hide controls overlay.

Parameters
`boolean runAnimation`	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.

See also
`showControlsOverlay`
`hideControlsOverlay`

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
`boolean enabled`	True to enable auto hidden of controls overlay.

setHostCallback

public void setHostCallback(PlaybackGlueHost.HostCallback callback)

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

public void setOnActionClickedListener(OnActionClickedListener listener)

Sets the View.OnClickListener on this fragment.

setOnKeyInterceptListener

public void setOnKeyInterceptListener(View.OnKeyListener onKeyListener)

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

public void setPlaybackRow(Row row)

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

public void setPlaybackRowPresenter(PlaybackRowPresenter presenter)

Sets PlaybackRowPresenter for rendering the playback controls.

Added in 1.2.0-alpha04

public void setPlaybackSeekUiClient(PlaybackSeekUi.Client client)

Interface to be implemented by UI widget to support PlaybackSeekUi.

showControlsOverlay

public void showControlsOverlay(boolean runAnimation)

Show controls overlay.

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