PlaybackGlueHost

public abstract class 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 onAttachedToHost.

Summary

Nested types

public abstract class PlaybackGlueHost.HostCallback

Callbacks triggered by the host(e.g. fragment) hosting the video controls/surface.

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

Public constructors

Public methods

void

This method is deprecated.

Call hideControlsOverlay

PlaybackGlueHost.PlayerCallback

Implemented by PlaybackGlueHost for responding to player events.

void
hideControlsOverlay(boolean runAnimation)

Hide controls overlay.

boolean

Returns true if auto hides controls overlay.

boolean

Returns true if controls overlay is visible, false otherwise.

void

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

void

Enables or disables controls overlay auto hidden.

void
setFadingEnabled(boolean enable)

This method is deprecated.

Use setControlsOverlayAutoHideEnabled

void

Sets the host HostCallback callback on the host.

void

Sets the View.OnClickListener on this fragment.

void

Sets the android.view.View.OnKeyListener on the host.

void

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

void

Sets PlaybackRowPresenter for rendering the playback controls.

void
showControlsOverlay(boolean runAnimation)

Show controls overlay.

Public constructors

PlaybackGlueHost

Added in 1.1.0
public PlaybackGlueHost()

Public methods

fadeOut

Added in 1.1.0
Deprecated in 1.1.0
public void fadeOut()

Fades out the playback overlay immediately.

getPlayerCallback

Added in 1.1.0
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

Added in 1.1.0
public void hideControlsOverlay(boolean runAnimation)

Hide controls overlay.

Parameters
boolean runAnimation

True to run animation, false otherwise.

isControlsOverlayAutoHideEnabled

Added in 1.1.0
public boolean isControlsOverlayAutoHideEnabled()

Returns true if auto hides controls overlay.

Returns
boolean

True if auto hiding controls overlay.

isControlsOverlayVisible

Added in 1.1.0
public boolean isControlsOverlayVisible()

Returns true if controls overlay is visible, false otherwise.

Returns
boolean

True if controls overlay is visible, false otherwise.

notifyPlaybackRowChanged

Added in 1.1.0
public void notifyPlaybackRowChanged()

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

setControlsOverlayAutoHideEnabled

Added in 1.1.0
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.

setFadingEnabled

Added in 1.1.0
Deprecated in 1.1.0
public void setFadingEnabled(boolean enable)

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.

setHostCallback

Added in 1.1.0
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.

setOnActionClickedListener

Added in 1.1.0
public void setOnActionClickedListener(OnActionClickedListener listener)

Sets the View.OnClickListener on this fragment.

setOnKeyInterceptListener

Added in 1.1.0
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.

setPlaybackRow

Added in 1.1.0
public void setPlaybackRow(Row row)

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

setPlaybackRowPresenter

Added in 1.1.0
public void setPlaybackRowPresenter(PlaybackRowPresenter presenter)

Sets PlaybackRowPresenter for rendering the playback controls.

showControlsOverlay

Added in 1.1.0
public void showControlsOverlay(boolean runAnimation)

Show controls overlay.

Parameters
boolean runAnimation

True to run animation, false otherwise.