added in version 25.1.0
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1
Deprecated since version 27.1.0
Summary: Constants | Inherited Constants | Ctors | Methods | Protected Methods | Inherited Methods | [Expand All]

PlaybackFragment

public class PlaybackFragment
extends Fragment

java.lang.Object
   ↳ android.app.Fragment
     ↳ android.support.v17.leanback.app.PlaybackFragment
Known Direct Subclasses

This class was deprecated in API level 27.1.0.
use PlaybackSupportFragment

A fragment for displaying playback controls and related content.

A PlaybackFragment renders the elements of its ObjectAdapter as a set of rows in a vertical list. The Adapter's PresenterSelector must maintain subclasses of RowPresenter.

A playback row is a row rendered by PlaybackRowPresenter. App can call setPlaybackRow(Row) to set playback row for the first element of adapter. App can call setPlaybackRowPresenter(PlaybackRowPresenter) to set presenter for it. setPlaybackRow(Row) and setPlaybackRowPresenter(PlaybackRowPresenter) are optional, app can pass playback row and PlaybackRowPresenter in the adapter using setAdapter(ObjectAdapter).

Auto hide controls upon playing: best practice is calling setControlsOverlayAutoHideEnabled(boolean) upon play/pause. The auto hiding timer will be cancelled upon tickle() triggered by input event.

Summary

Constants

int BG_DARK

A dark translucent background.

int BG_LIGHT

A light translucent background.

int BG_NONE

No background.

Inherited constants

From interface android.content.ComponentCallbacks2

Public constructors

PlaybackFragment()

Public methods

void fadeOut()

This method was deprecated in API level 26.1.0. Call hideControlsOverlay(boolean)

ObjectAdapter getAdapter()
int getBackgroundType()

Returns the background type.

ProgressBarManager getProgressBarManager()

Returns the ProgressBarManager that will show or hide progress bar in onBufferingStateChanged(boolean).

void hideControlsOverlay(boolean runAnimation)

Hide controls overlay.

boolean isControlsOverlayAutoHideEnabled()

Returns true if controls will be auto hidden after a delay when fragment is resumed.

boolean isControlsOverlayVisible()

Returns true if controls overlay is visible, false otherwise.

boolean isFadingEnabled()

This method was deprecated in API level 26.1.0. Uses isControlsOverlayAutoHideEnabled()

void notifyPlaybackRowChanged()

Updates the ui when the row data changes.

void onCreate(Bundle savedInstanceState)
View onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)
void onDestroy()
void onDestroyView()
void onPause()
void onResume()
void onStart()
void onStop()
void onViewCreated(View view, Bundle savedInstanceState)
void setAdapter(ObjectAdapter adapter)

Sets the list of rows for the fragment.

void setBackgroundType(int type)

Sets the background type.

void setControlsOverlayAutoHideEnabled(boolean enabled)

Enables or disables auto hiding controls overlay after a short delay fragment is resumed.

void setFadingEnabled(boolean enabled)

This method was deprecated in API level 26.1.0. Uses setControlsOverlayAutoHideEnabled(boolean)

void setHostCallback(PlaybackGlueHost.HostCallback hostCallback)

Sets the PlaybackGlueHost.HostCallback.

void setOnItemViewClickedListener(BaseOnItemViewClickedListener listener)

This listener is called every time there is a click in RowsFragment.

void setOnItemViewSelectedListener(BaseOnItemViewSelectedListener listener)

This listener is called every time there is a selection in RowsFragment.

final void setOnKeyInterceptListener(View.OnKeyListener handler)

Sets the input event handler.

void setOnPlaybackItemViewClickedListener(BaseOnItemViewClickedListener listener)

Sets the BaseOnItemViewClickedListener that would be invoked for clicks only on PlaybackRowPresenter.ViewHolder.

void setPlaybackRow(Row row)

Sets the playback row for the playback controls.

void setPlaybackRowPresenter(PlaybackRowPresenter presenter)

Sets the presenter for rendering the playback row set by setPlaybackRow(Row).

void setPlaybackSeekUiClient(PlaybackSeekUi.Client client)

Interface to be implemented by UI widget to support PlaybackSeekUi.

void setSelectedPosition(int position)

Sets the selected row position with smooth animation.

void setSelectedPosition(int position, boolean smooth)

Sets the selected row position.

void showControlsOverlay(boolean runAnimation)

Show controls overlay.

void tickle()

Tickles the playback controls.

Protected methods

void onBufferingStateChanged(boolean start)

Called when media has start or stop buffering.

void onError(int errorCode, CharSequence errorMessage)

Called when media has error.

void onVideoSizeChanged(int videoWidth, int videoHeight)

Called when size of the video changes.

Inherited methods

From class android.app.Fragment