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

This package is part of the Android support library which is no longer maintained. The support library has been superseded by AndroidX which is part of Jetpack. We recommend using the AndroidX libraries in all new projects. You should also consider migrating existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library class mappings.

public class PlaybackFragment
extends Fragment

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

Known Direct Subclasses VideoFragment VideoFragment This class was deprecated in API level 27.1.0. use VideoSupportFragment

---

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 int TRIM_MEMORY_BACKGROUND int TRIM_MEMORY_COMPLETE int TRIM_MEMORY_MODERATE int TRIM_MEMORY_RUNNING_CRITICAL int TRIM_MEMORY_RUNNING_LOW int TRIM_MEMORY_RUNNING_MODERATE int TRIM_MEMORY_UI_HIDDEN

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 void dump(String arg0, FileDescriptor arg1, PrintWriter arg2, String[] arg3) final boolean equals(Object arg0) final Activity getActivity() boolean getAllowEnterTransitionOverlap() boolean getAllowReturnTransitionOverlap() final Bundle getArguments() final FragmentManager getChildFragmentManager() Context getContext() Transition getEnterTransition() Transition getExitTransition() final FragmentManager getFragmentManager() final Object getHost() final int getId() final LayoutInflater getLayoutInflater() LoaderManager getLoaderManager() final Fragment getParentFragment() Transition getReenterTransition() final Resources getResources() final boolean getRetainInstance() Transition getReturnTransition() Transition getSharedElementEnterTransition() Transition getSharedElementReturnTransition() final String getString(int arg0, Object... arg1) final String getString(int arg0) final String getTag() final Fragment getTargetFragment() final int getTargetRequestCode() final CharSequence getText(int arg0) boolean getUserVisibleHint() View getView() final int hashCode() static Fragment instantiate(Context arg0, String arg1) static Fragment instantiate(Context arg0, String arg1, Bundle arg2) final boolean isAdded() final boolean isDetached() final boolean isHidden() final boolean isInLayout() final boolean isRemoving() final boolean isResumed() final boolean isStateSaved() final boolean isVisible() void onActivityCreated(Bundle arg0) void onActivityResult(int arg0, int arg1, Intent arg2) void onAttach(Activity arg0) void onAttach(Context arg0) void onAttachFragment(Fragment arg0) void onConfigurationChanged(Configuration arg0) boolean onContextItemSelected(MenuItem arg0) void onCreate(Bundle arg0) Animator onCreateAnimator(int arg0, boolean arg1, int arg2) void onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2) void onCreateOptionsMenu(Menu arg0, MenuInflater arg1) View onCreateView(LayoutInflater arg0, ViewGroup arg1, Bundle arg2) void onDestroy() void onDestroyOptionsMenu() void onDestroyView() void onDetach() LayoutInflater onGetLayoutInflater(Bundle arg0) void onHiddenChanged(boolean arg0) void onInflate(AttributeSet arg0, Bundle arg1) void onInflate(Activity arg0, AttributeSet arg1, Bundle arg2) void onInflate(Context arg0, AttributeSet arg1, Bundle arg2) void onLowMemory() void onMultiWindowModeChanged(boolean arg0) void onMultiWindowModeChanged(boolean arg0, Configuration arg1) boolean onOptionsItemSelected(MenuItem arg0) void onOptionsMenuClosed(Menu arg0) void onPause() void onPictureInPictureModeChanged(boolean arg0, Configuration arg1) void onPictureInPictureModeChanged(boolean arg0) void onPrepareOptionsMenu(Menu arg0) void onRequestPermissionsResult(int arg0, String[] arg1, int[] arg2) void onResume() void onSaveInstanceState(Bundle arg0) void onStart() void onStop() void onTrimMemory(int arg0) void onViewCreated(View arg0, Bundle arg1) void onViewStateRestored(Bundle arg0) void postponeEnterTransition() void registerForContextMenu(View arg0) final void requestPermissions(String[] arg0, int arg1) void setAllowEnterTransitionOverlap(boolean arg0) void setAllowReturnTransitionOverlap(boolean arg0) void setArguments(Bundle arg0) void setEnterSharedElementCallback(SharedElementCallback arg0) void setEnterTransition(Transition arg0) void setExitSharedElementCallback(SharedElementCallback arg0) void setExitTransition(Transition arg0) void setHasOptionsMenu(boolean arg0) void setInitialSavedState(Fragment.SavedState arg0) void setMenuVisibility(boolean arg0) void setReenterTransition(Transition arg0) void setRetainInstance(boolean arg0) void setReturnTransition(Transition arg0) void setSharedElementEnterTransition(Transition arg0) void setSharedElementReturnTransition(Transition arg0) void setTargetFragment(Fragment arg0, int arg1) void setUserVisibleHint(boolean arg0) boolean shouldShowRequestPermissionRationale(String arg0) void startActivity(Intent arg0) void startActivity(Intent arg0, Bundle arg1) void startActivityForResult(Intent arg0, int arg1) void startActivityForResult(Intent arg0, int arg1, Bundle arg2) void startIntentSenderForResult(IntentSender arg0, int arg1, Intent arg2, int arg3, int arg4, int arg5, Bundle arg6) void startPostponedEnterTransition() String toString() void unregisterForContextMenu(View arg0)
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait(long arg0, int arg1) final void wait(long arg0) final void wait()
From interface android.content.ComponentCallbacks2 abstract void onTrimMemory(int arg0)
From interface android.view.View.OnCreateContextMenuListener abstract void onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)
From interface android.content.ComponentCallbacks abstract void onConfigurationChanged(Configuration arg0) abstract void onLowMemory()

Constants

BG_DARK

added in version 25.1.0

int BG_DARK

A dark translucent background.

Constant Value: 1 (0x00000001)

BG_LIGHT

added in version 25.1.0

int BG_LIGHT

A light translucent background.

Constant Value: 2 (0x00000002)

BG_NONE

added in version 25.1.0

int BG_NONE

No background.

Constant Value: 0 (0x00000000)

Public constructors

PlaybackFragment

added in version 25.1.0

PlaybackFragment ()

Public methods

fadeOut

added in version 25.1.0

void fadeOut ()

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

Fades out the playback overlay immediately.

getAdapter

added in version 25.1.0

ObjectAdapter getAdapter ()

Returns
ObjectAdapter

getBackgroundType

added in version 25.1.0

int getBackgroundType ()

Returns the background type.

Returns
int

getProgressBarManager

added in version 26.1.0

ProgressBarManager getProgressBarManager ()

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

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

hideControlsOverlay

added in version 26.1.0

void hideControlsOverlay (boolean runAnimation)

Hide controls overlay.

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

isControlsOverlayAutoHideEnabled

added in version 26.1.0

boolean isControlsOverlayAutoHideEnabled ()

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

Returns
boolean

isControlsOverlayVisible

added in version 26.1.0

boolean isControlsOverlayVisible ()

Returns true if controls overlay is visible, false otherwise.

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

See also:

• showControlsOverlay(boolean)
• hideControlsOverlay(boolean)

isFadingEnabled

added in version 25.1.0

boolean isFadingEnabled ()

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

Returns
boolean

notifyPlaybackRowChanged

added in version 25.1.0

void notifyPlaybackRowChanged ()

Updates the ui when the row data changes.

onCreate

void onCreate (Bundle savedInstanceState)

Parameters
savedInstanceState	Bundle

onCreateView

View onCreateView (LayoutInflater inflater, 
                ViewGroup container, 
                Bundle savedInstanceState)

Parameters
inflater	LayoutInflater
container	ViewGroup
savedInstanceState	Bundle

Returns
View

onDestroy

void onDestroy ()

onDestroyView

void onDestroyView ()

onPause

void onPause ()

onResume

void onResume ()

onStart

void onStart ()

onStop

void onStop ()

onViewCreated

void onViewCreated (View view, 
                Bundle savedInstanceState)

Parameters
view	View
savedInstanceState	Bundle

setAdapter

added in version 25.1.0

void setAdapter (ObjectAdapter adapter)

Sets the list of rows for the fragment. A default ClassPresenterSelector will be created if getPresenterSelector() is null. if user provides setPlaybackRow(Row) and setPlaybackRowPresenter(PlaybackRowPresenter), the row and presenter will be set onto the adapter.

Parameters
adapter	ObjectAdapter: The adapter that contains related rows and optional playback row.

setBackgroundType

added in version 25.1.0

void setBackgroundType (int type)

Sets the background type.

Parameters
type	int: One of BG_LIGHT, BG_DARK, or BG_NONE.

setControlsOverlayAutoHideEnabled

added in version 26.1.0

void setControlsOverlayAutoHideEnabled (boolean enabled)

Enables or disables auto hiding controls overlay after a short delay fragment is resumed. If enabled and fragment is resumed, the view will fade out after a time period. tickle() will kill the timer, next time fragment is resumed, the timer will be started again if isControlsOverlayAutoHideEnabled() is true.

Parameters
enabled	boolean

setFadingEnabled

added in version 25.1.0

void setFadingEnabled (boolean enabled)

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

Parameters
enabled	boolean

setHostCallback

added in version 25.1.0

void setHostCallback (PlaybackGlueHost.HostCallback hostCallback)

Sets the PlaybackGlueHost.HostCallback. Implementor of this interface will take appropriate actions to take action when the hosting fragment starts/stops processing.

Parameters
hostCallback	PlaybackGlueHost.HostCallback

setOnItemViewClickedListener

added in version 25.1.0

void setOnItemViewClickedListener (BaseOnItemViewClickedListener listener)

This listener is called every time there is a click in RowsFragment. This can be used by users to take additional actions such as animations.

Parameters
listener	BaseOnItemViewClickedListener

setOnItemViewSelectedListener

added in version 25.4.0

void setOnItemViewSelectedListener (BaseOnItemViewSelectedListener listener)

This listener is called every time there is a selection in RowsFragment. This can be used by users to take additional actions such as animations.

Parameters
listener	BaseOnItemViewSelectedListener

setOnKeyInterceptListener

added in version 25.1.0

void setOnKeyInterceptListener (View.OnKeyListener handler)

Sets the input event handler.

Parameters
handler	View.OnKeyListener

setOnPlaybackItemViewClickedListener

added in version 25.1.0

void setOnPlaybackItemViewClickedListener (BaseOnItemViewClickedListener listener)

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

Parameters
listener	BaseOnItemViewClickedListener

setPlaybackRow

added in version 25.1.0

void setPlaybackRow (Row row)

Sets the playback row for the playback controls. The row will be set as first element of adapter if the adapter is ArrayObjectAdapter or SparseArrayObjectAdapter.

Parameters
row	Row: The row that represents the playback.

setPlaybackRowPresenter

added in version 25.1.0

void setPlaybackRowPresenter (PlaybackRowPresenter presenter)

Sets the presenter for rendering the playback row set by setPlaybackRow(Row). If adapter does not set a PresenterSelector, setAdapter(ObjectAdapter) will create a ClassPresenterSelector by default and map from the row object class to this PlaybackRowPresenter.

Parameters
presenter	PlaybackRowPresenter: Presenter used to render setPlaybackRow(Row).

setPlaybackSeekUiClient

added in version 26.1.0

void setPlaybackSeekUiClient (PlaybackSeekUi.Client client)

Interface to be implemented by UI widget to support PlaybackSeekUi.

Parameters
client	PlaybackSeekUi.Client

setSelectedPosition

added in version 25.1.0

void setSelectedPosition (int position)

Sets the selected row position with smooth animation.

Parameters
position	int

setSelectedPosition

added in version 25.1.0

void setSelectedPosition (int position, 
                boolean smooth)

Sets the selected row position.

Parameters
position	int
smooth	boolean

showControlsOverlay

added in version 26.1.0

void showControlsOverlay (boolean runAnimation)

Show controls overlay.

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

tickle

added in version 25.1.0

void tickle ()

Tickles the playback controls. Fades in the view if it was faded out. tickle() will also kill the timer created by setControlsOverlayAutoHideEnabled(boolean). When next time fragment is resumed, the timer will be started again if isControlsOverlayAutoHideEnabled() is true. In most cases app does not need call this method, tickling on input events is handled by the fragment.

Protected methods

onBufferingStateChanged

added in version 26.1.0

void onBufferingStateChanged (boolean start)

Called when media has start or stop buffering. App may override. The default initial state is not buffering.

Parameters
start	boolean: True for buffering start, false otherwise.

onError

added in version 26.1.0

void onError (int errorCode, 
                CharSequence errorMessage)

Called when media has error. App may override.

Parameters
errorCode	int: Optional error code for specific implementation.
errorMessage	CharSequence: Optional error message for specific implementation.

onVideoSizeChanged

added in version 26.1.0

void onVideoSizeChanged (int videoWidth, 
                int videoHeight)

Called when size of the video changes. App may override.

Parameters
videoWidth	int: Intrinsic width of video
videoHeight	int: Intrinsic height of video

• Interfaces

  • BrowseFragment.FragmentHost
  • BrowseFragment.MainFragmentAdapterProvider
  • BrowseFragment.MainFragmentRowsAdapterProvider
  • BrowseSupportFragment.FragmentHost
  • BrowseSupportFragment.MainFragmentAdapterProvider
  • BrowseSupportFragment.MainFragmentRowsAdapterProvider
  • HeadersFragment.OnHeaderClickedListener
  • HeadersFragment.OnHeaderViewSelectedListener
  • HeadersSupportFragment.OnHeaderClickedListener
  • HeadersSupportFragment.OnHeaderViewSelectedListener
  • SearchFragment.SearchResultProvider
  • SearchSupportFragment.SearchResultProvider

• Classes

  • BackgroundManager
  • BaseFragment
  • BaseSupportFragment
  • BrandedFragment
  • BrandedSupportFragment
  • BrowseFragment
  • BrowseFragment.BrowseTransitionListener
  • BrowseFragment.FragmentFactory
  • BrowseFragment.ListRowFragmentFactory
  • BrowseFragment.MainFragmentAdapter
  • BrowseFragment.MainFragmentAdapterRegistry
  • BrowseFragment.MainFragmentRowsAdapter
  • BrowseSupportFragment
  • BrowseSupportFragment.BrowseTransitionListener
  • BrowseSupportFragment.FragmentFactory
  • BrowseSupportFragment.ListRowFragmentFactory
  • BrowseSupportFragment.MainFragmentAdapter
  • BrowseSupportFragment.MainFragmentAdapterRegistry
  • BrowseSupportFragment.MainFragmentRowsAdapter
  • DetailsFragment
  • DetailsFragmentBackgroundController
  • DetailsSupportFragment
  • DetailsSupportFragmentBackgroundController
  • ErrorFragment
  • ErrorSupportFragment
  • GuidedStepFragment
  • GuidedStepSupportFragment
  • HeadersFragment
  • HeadersSupportFragment
  • OnboardingFragment
  • OnboardingSupportFragment
  • PlaybackFragment
  • PlaybackFragmentGlueHost
  • PlaybackSupportFragment
  • PlaybackSupportFragmentGlueHost
  • ProgressBarManager
  • RowsFragment
  • RowsFragment.MainFragmentAdapter
  • RowsFragment.MainFragmentRowsAdapter
  • RowsSupportFragment
  • RowsSupportFragment.MainFragmentAdapter
  • RowsSupportFragment.MainFragmentRowsAdapter
  • SearchFragment
  • SearchSupportFragment
  • VerticalGridFragment
  • VerticalGridSupportFragment
  • VideoFragment
  • VideoFragmentGlueHost
  • VideoSupportFragment
  • VideoSupportFragmentGlueHost