# PlaybackFragment

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1  
Deprecated since version 27.1.0  
Summary:[Constants](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#constants)\|[Inherited Constants](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#inhconstants)\|[Ctors](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#pubctors)\|[Methods](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#pubmethods)\|[Protected Methods](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#promethods)\|[Inherited Methods](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#inhmethods)\|[\[Expand All\]](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#)  

# PlaybackFragment

| This package is part of the Android[support library](https://developer.android.com/topic/libraries/support-library)which is no longer maintained. The support library has been superseded by[AndroidX](https://developer.android.com/jetpack/androidx)which is part of[Jetpack](https://developer.android.com/jetpack). We recommend using the AndroidX libraries in all new projects. You should also consider[migrating](https://developer.android.com/jetpack/androidx/migrate)existing projects to AndroidX. To find the AndroidX class that maps to this deprecated class, see the AndroidX support library[class mappings](https://developer.android.com/jetpack/androidx/migrate/class-mappings).

`
public


class
PlaybackFragment
`  
`


``

extends `[Fragment](https://developer.android.com/reference/android/app/Fragment.html)`


``


`

|---|---|---------------------------------------------------|
| java.lang.Object                                        |||
| ↳ | [android.app.Fragment](https://developer.android.com/reference/android/app/Fragment.html) ||
|   | ↳ | android.support.v17.leanback.app.PlaybackFragment |

|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#)Known Direct Subclasses [VideoFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VideoFragment) |---------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [VideoFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VideoFragment) | *This class was deprecated in API level 27.1.0. use[VideoSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VideoSupportFragment)* | |

<br />

*** ** * ** ***

<br />

**This class was deprecated in API level 27.1.0.**   
use[PlaybackSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackSupportFragment)

A fragment for displaying playback controls and related content.

A PlaybackFragment renders the elements of its[ObjectAdapter](https://developer.android.com/reference/android/support/v17/leanback/widget/ObjectAdapter)as a set of rows in a vertical list. The Adapter's[PresenterSelector](https://developer.android.com/reference/android/support/v17/leanback/widget/PresenterSelector)must maintain subclasses of[RowPresenter](https://developer.android.com/reference/android/support/v17/leanback/widget/RowPresenter).

A playback row is a row rendered by[PlaybackRowPresenter](https://developer.android.com/reference/android/support/v17/leanback/widget/PlaybackRowPresenter). App can call[setPlaybackRow(Row)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setPlaybackRow(android.support.v17.leanback.widget.Row))to set playback row for the first element of adapter. App can call[setPlaybackRowPresenter(PlaybackRowPresenter)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setPlaybackRowPresenter(android.support.v17.leanback.widget.PlaybackRowPresenter))to set presenter for it.[setPlaybackRow(Row)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setPlaybackRow(android.support.v17.leanback.widget.Row))and[setPlaybackRowPresenter(PlaybackRowPresenter)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setPlaybackRowPresenter(android.support.v17.leanback.widget.PlaybackRowPresenter))are optional, app can pass playback row and PlaybackRowPresenter in the adapter using[setAdapter(ObjectAdapter)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setAdapter(android.support.v17.leanback.widget.ObjectAdapter)).

Auto hide controls upon playing: best practice is calling[setControlsOverlayAutoHideEnabled(boolean)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setControlsOverlayAutoHideEnabled(boolean))upon play/pause. The auto hiding timer will be cancelled upon[tickle()](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#tickle())triggered by input event.

<br />

## Summary

|                                                                     ### Constants                                                                     ||
|-------|------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | [BG_DARK](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#BG_DARK) A dark translucent background.    |
| `int` | [BG_LIGHT](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#BG_LIGHT) A light translucent background. |
| `int` | [BG_NONE](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#BG_NONE) No background.                    |

|                                                                                                                                                                                                                                                                                                                ### Inherited constants                                                                                                                                                                                                                                                                                                                |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#)From interface` android.content.ComponentCallbacks2 ` |-------|---------------------------------------| | `int` | `TRIM_MEMORY_BACKGROUND` <br />       | | `int` | `TRIM_MEMORY_COMPLETE` <br />         | | `int` | `TRIM_MEMORY_MODERATE` <br />         | | `int` | `TRIM_MEMORY_RUNNING_CRITICAL` <br /> | | `int` | `TRIM_MEMORY_RUNNING_LOW` <br />      | | `int` | `TRIM_MEMORY_RUNNING_MODERATE` <br /> | | `int` | `TRIM_MEMORY_UI_HIDDEN` <br />        | |

|                                                           ### Public constructors                                                           ||
|------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[PlaybackFragment](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#PlaybackFragment())`() ` |

|                                                                                                                                                                                                                                                                                                                                                                                                                           ### Public methods                                                                                                                                                                                                                                                                                                                                                                                                                           ||
|----------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` void`                                                                                                              | ` `[fadeOut](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#fadeOut())`() ` *This method was deprecated in API level 26.1.0. Call[hideControlsOverlay(boolean)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#hideControlsOverlay(boolean))*                                                                                                                                                                                                                                                                                                                                                                                                              |
| ` `[ObjectAdapter](https://developer.android.com/reference/android/support/v17/leanback/widget/ObjectAdapter)        | ` `[getAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#getAdapter())`() `                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| ` int`                                                                                                               | ` `[getBackgroundType](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#getBackgroundType())`() ` Returns the background type.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ` `[ProgressBarManager](https://developer.android.com/reference/android/support/v17/leanback/app/ProgressBarManager) | ` `[getProgressBarManager](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#getProgressBarManager())`() ` Returns the ProgressBarManager that will show or hide progress bar in[onBufferingStateChanged(boolean)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#onBufferingStateChanged(boolean)).                                                                                                                                                                                                                                                                                                                                                          |
| ` void`                                                                                                              | ` `[hideControlsOverlay](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#hideControlsOverlay(boolean))`(boolean runAnimation) ` Hide controls overlay.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| ` boolean`                                                                                                           | ` `[isControlsOverlayAutoHideEnabled](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#isControlsOverlayAutoHideEnabled())`() ` Returns true if controls will be auto hidden after a delay when fragment is resumed.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ` boolean`                                                                                                           | ` `[isControlsOverlayVisible](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#isControlsOverlayVisible())`() ` Returns true if controls overlay is visible, false otherwise.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ` boolean`                                                                                                           | ` `[isFadingEnabled](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#isFadingEnabled())`() ` *This method was deprecated in API level 26.1.0. Uses[isControlsOverlayAutoHideEnabled()](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#isControlsOverlayAutoHideEnabled())*                                                                                                                                                                                                                                                                                                                                                                                  |
| ` void`                                                                                                              | ` `[notifyPlaybackRowChanged](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#notifyPlaybackRowChanged())`() ` Updates the ui when the row data changes.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ` void`                                                                                                              | ` `[onCreate](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#onCreate(android.os.Bundle))`(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) `                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ` `[View](https://developer.android.com/reference/android/view/View.html)                                            | ` `[onCreateView](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#onCreateView(android.view.LayoutInflater, android.view.ViewGroup, android.os.Bundle))`(`[LayoutInflater](https://developer.android.com/reference/android/view/LayoutInflater.html)` inflater, `[ViewGroup](https://developer.android.com/reference/android/view/ViewGroup.html)` container, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) `                                                                                                                                                                                                                                         |
| ` void`                                                                                                              | ` `[onDestroy](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#onDestroy())`() `                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ` void`                                                                                                              | ` `[onDestroyView](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#onDestroyView())`() `                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ` void`                                                                                                              | ` `[onPause](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#onPause())`() `                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ` void`                                                                                                              | ` `[onResume](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#onResume())`() `                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ` void`                                                                                                              | ` `[onStart](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#onStart())`() `                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ` void`                                                                                                              | ` `[onStop](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#onStop())`() `                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ` void`                                                                                                              | ` `[onViewCreated](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#onViewCreated(android.view.View, android.os.Bundle))`(`[View](https://developer.android.com/reference/android/view/View.html)` view, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` savedInstanceState) `                                                                                                                                                                                                                                                                                                                                                                                               |
| ` void`                                                                                                              | ` `[setAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setAdapter(android.support.v17.leanback.widget.ObjectAdapter))`(`[ObjectAdapter](https://developer.android.com/reference/android/support/v17/leanback/widget/ObjectAdapter)` adapter) ` Sets the list of rows for the fragment.                                                                                                                                                                                                                                                                                                                                                                                                        |
| ` void`                                                                                                              | ` `[setBackgroundType](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setBackgroundType(int))`(int type) ` Sets the background type.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ` void`                                                                                                              | ` `[setControlsOverlayAutoHideEnabled](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setControlsOverlayAutoHideEnabled(boolean))`(boolean enabled) ` Enables or disables auto hiding controls overlay after a short delay fragment is resumed.                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ` void`                                                                                                              | ` `[setFadingEnabled](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setFadingEnabled(boolean))`(boolean enabled) ` *This method was deprecated in API level 26.1.0. Uses[setControlsOverlayAutoHideEnabled(boolean)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setControlsOverlayAutoHideEnabled(boolean))*                                                                                                                                                                                                                                                                                                                                          |
| ` void`                                                                                                              | ` `[setHostCallback](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setHostCallback(android.support.v17.leanback.media.PlaybackGlueHost.HostCallback))`(`[PlaybackGlueHost.HostCallback](https://developer.android.com/reference/android/support/v17/leanback/media/PlaybackGlueHost.HostCallback)` hostCallback) ` Sets the[PlaybackGlueHost.HostCallback](https://developer.android.com/reference/android/support/v17/leanback/media/PlaybackGlueHost.HostCallback).                                                                                                                                                                                                                                |
| ` void`                                                                                                              | ` `[setOnItemViewClickedListener](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setOnItemViewClickedListener(android.support.v17.leanback.widget.BaseOnItemViewClickedListener))`(`[BaseOnItemViewClickedListener](https://developer.android.com/reference/android/support/v17/leanback/widget/BaseOnItemViewClickedListener)` listener) ` This listener is called every time there is a click in[RowsFragment](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment).                                                                                                                                                                                              |
| ` void`                                                                                                              | ` `[setOnItemViewSelectedListener](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setOnItemViewSelectedListener(android.support.v17.leanback.widget.BaseOnItemViewSelectedListener))`(`[BaseOnItemViewSelectedListener](https://developer.android.com/reference/android/support/v17/leanback/widget/BaseOnItemViewSelectedListener)` listener) ` This listener is called every time there is a selection in[RowsFragment](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment).                                                                                                                                                                                     |
| ` final void`                                                                                                        | ` `[setOnKeyInterceptListener](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setOnKeyInterceptListener(android.view.View.OnKeyListener))`(`[View.OnKeyListener](https://developer.android.com/reference/android/view/View.OnKeyListener.html)` handler) ` Sets the input event handler.                                                                                                                                                                                                                                                                                                                                                                                                              |
| ` void`                                                                                                              | ` `[setOnPlaybackItemViewClickedListener](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setOnPlaybackItemViewClickedListener(android.support.v17.leanback.widget.BaseOnItemViewClickedListener))`(`[BaseOnItemViewClickedListener](https://developer.android.com/reference/android/support/v17/leanback/widget/BaseOnItemViewClickedListener)` listener) ` Sets the[BaseOnItemViewClickedListener](https://developer.android.com/reference/android/support/v17/leanback/widget/BaseOnItemViewClickedListener)that would be invoked for clicks only on[PlaybackRowPresenter.ViewHolder](https://developer.android.com/reference/android/support/v17/leanback/widget/PlaybackRowPresenter.ViewHolder). |
| ` void`                                                                                                              | ` `[setPlaybackRow](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setPlaybackRow(android.support.v17.leanback.widget.Row))`(`[Row](https://developer.android.com/reference/android/support/v17/leanback/widget/Row)` row) ` Sets the playback row for the playback controls.                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ` void`                                                                                                              | ` `[setPlaybackRowPresenter](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setPlaybackRowPresenter(android.support.v17.leanback.widget.PlaybackRowPresenter))`(`[PlaybackRowPresenter](https://developer.android.com/reference/android/support/v17/leanback/widget/PlaybackRowPresenter)` presenter) ` Sets the presenter for rendering the playback row set by[setPlaybackRow(Row)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setPlaybackRow(android.support.v17.leanback.widget.Row)).                                                                                                                                                             |
| ` void`                                                                                                              | ` `[setPlaybackSeekUiClient](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setPlaybackSeekUiClient(android.support.v17.leanback.widget.PlaybackSeekUi.Client))`(`[PlaybackSeekUi.Client](https://developer.android.com/reference/android/support/v17/leanback/widget/PlaybackSeekUi.Client)` client) ` Interface to be implemented by UI widget to support PlaybackSeekUi.                                                                                                                                                                                                                                                                                                                           |
| ` void`                                                                                                              | ` `[setSelectedPosition](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setSelectedPosition(int))`(int position) ` Sets the selected row position with smooth animation.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| ` void`                                                                                                              | ` `[setSelectedPosition](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setSelectedPosition(int, boolean))`(int position, boolean smooth) ` Sets the selected row position.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ` void`                                                                                                              | ` `[showControlsOverlay](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#showControlsOverlay(boolean))`(boolean runAnimation) ` Show controls overlay.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| ` void`                                                                                                              | ` `[tickle](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#tickle())`() ` Tickles the playback controls.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |

|                                                                                                        ### Protected methods                                                                                                        ||
|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` void` | ` `[onBufferingStateChanged](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#onBufferingStateChanged(boolean))`(boolean start) ` Called when media has start or stop buffering.  |
| ` void` | ` `[onError](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#onError(int, java.lang.CharSequence))`(int errorCode, CharSequence errorMessage) ` Called when media has error.     |
| ` void` | ` `[onVideoSizeChanged](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#onVideoSizeChanged(int, int))`(int videoWidth, int videoHeight) ` Called when size of the video changes. |

| ### Inherited methods |
|-----------------------|---|
| [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#)From class` `[android.app.Fragment](https://developer.android.com/reference/android/app/Fragment.html)` ` |------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` void`                                                                                              | ` dump(String arg0, FileDescriptor arg1, PrintWriter arg2, String[] arg3) `                                                                                                                                                                                                                                                                     | | ` final boolean`                                                                                     | ` equals(Object arg0) `                                                                                                                                                                                                                                                                                                                         | | ` final `[Activity](https://developer.android.com/reference/android/app/Activity.html)               | ` getActivity() `                                                                                                                                                                                                                                                                                                                               | | ` boolean`                                                                                           | ` getAllowEnterTransitionOverlap() `                                                                                                                                                                                                                                                                                                            | | ` boolean`                                                                                           | ` getAllowReturnTransitionOverlap() `                                                                                                                                                                                                                                                                                                           | | ` final `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)                    | ` getArguments() `                                                                                                                                                                                                                                                                                                                              | | ` final `[FragmentManager](https://developer.android.com/reference/android/app/FragmentManager.html) | ` getChildFragmentManager() `                                                                                                                                                                                                                                                                                                                   | | ` `[Context](https://developer.android.com/reference/android/content/Context.html)                   | ` getContext() `                                                                                                                                                                                                                                                                                                                                | | ` `[Transition](https://developer.android.com/reference/android/transition/Transition.html)          | ` getEnterTransition() `                                                                                                                                                                                                                                                                                                                        | | ` `[Transition](https://developer.android.com/reference/android/transition/Transition.html)          | ` getExitTransition() `                                                                                                                                                                                                                                                                                                                         | | ` final `[FragmentManager](https://developer.android.com/reference/android/app/FragmentManager.html) | ` getFragmentManager() `                                                                                                                                                                                                                                                                                                                        | | ` final Object`                                                                                      | ` getHost() `                                                                                                                                                                                                                                                                                                                                   | | ` final int`                                                                                         | ` getId() `                                                                                                                                                                                                                                                                                                                                     | | ` final `[LayoutInflater](https://developer.android.com/reference/android/view/LayoutInflater.html)  | ` getLayoutInflater() `                                                                                                                                                                                                                                                                                                                         | | ` `[LoaderManager](https://developer.android.com/reference/android/app/LoaderManager.html)           | ` getLoaderManager() `                                                                                                                                                                                                                                                                                                                          | | ` final `[Fragment](https://developer.android.com/reference/android/app/Fragment.html)               | ` getParentFragment() `                                                                                                                                                                                                                                                                                                                         | | ` `[Transition](https://developer.android.com/reference/android/transition/Transition.html)          | ` getReenterTransition() `                                                                                                                                                                                                                                                                                                                      | | ` final `[Resources](https://developer.android.com/reference/android/content/res/Resources.html)     | ` getResources() `                                                                                                                                                                                                                                                                                                                              | | ` final boolean`                                                                                     | ` getRetainInstance() `                                                                                                                                                                                                                                                                                                                         | | ` `[Transition](https://developer.android.com/reference/android/transition/Transition.html)          | ` getReturnTransition() `                                                                                                                                                                                                                                                                                                                       | | ` `[Transition](https://developer.android.com/reference/android/transition/Transition.html)          | ` getSharedElementEnterTransition() `                                                                                                                                                                                                                                                                                                           | | ` `[Transition](https://developer.android.com/reference/android/transition/Transition.html)          | ` getSharedElementReturnTransition() `                                                                                                                                                                                                                                                                                                          | | ` final String`                                                                                      | ` getString(int arg0, Object... arg1) `                                                                                                                                                                                                                                                                                                         | | ` final String`                                                                                      | ` getString(int arg0) `                                                                                                                                                                                                                                                                                                                         | | ` final String`                                                                                      | ` getTag() `                                                                                                                                                                                                                                                                                                                                    | | ` final `[Fragment](https://developer.android.com/reference/android/app/Fragment.html)               | ` getTargetFragment() `                                                                                                                                                                                                                                                                                                                         | | ` final int`                                                                                         | ` getTargetRequestCode() `                                                                                                                                                                                                                                                                                                                      | | ` final CharSequence`                                                                                | ` getText(int arg0) `                                                                                                                                                                                                                                                                                                                           | | ` boolean`                                                                                           | ` getUserVisibleHint() `                                                                                                                                                                                                                                                                                                                        | | ` `[View](https://developer.android.com/reference/android/view/View.html)                            | ` getView() `                                                                                                                                                                                                                                                                                                                                   | | ` final int`                                                                                         | ` hashCode() `                                                                                                                                                                                                                                                                                                                                  | | ` static `[Fragment](https://developer.android.com/reference/android/app/Fragment.html)              | ` instantiate(`[Context](https://developer.android.com/reference/android/content/Context.html)` arg0, String arg1) `                                                                                                                                                                                                                            | | ` static `[Fragment](https://developer.android.com/reference/android/app/Fragment.html)              | ` instantiate(`[Context](https://developer.android.com/reference/android/content/Context.html)` arg0, String arg1, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` 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](https://developer.android.com/reference/android/os/Bundle.html)` arg0) `                                                                                                                                                                                                                                          | | ` void`                                                                                              | ` onActivityResult(int arg0, int arg1, `[Intent](https://developer.android.com/reference/android/content/Intent.html)` arg2) `                                                                                                                                                                                                                  | | ` void`                                                                                              | ` onAttach(`[Activity](https://developer.android.com/reference/android/app/Activity.html)` arg0) `                                                                                                                                                                                                                                              | | ` void`                                                                                              | ` onAttach(`[Context](https://developer.android.com/reference/android/content/Context.html)` arg0) `                                                                                                                                                                                                                                            | | ` void`                                                                                              | ` onAttachFragment(`[Fragment](https://developer.android.com/reference/android/app/Fragment.html)` arg0) `                                                                                                                                                                                                                                      | | ` void`                                                                                              | ` onConfigurationChanged(`[Configuration](https://developer.android.com/reference/android/content/res/Configuration.html)` arg0) `                                                                                                                                                                                                              | | ` boolean`                                                                                           | ` onContextItemSelected(`[MenuItem](https://developer.android.com/reference/android/view/MenuItem.html)` arg0) `                                                                                                                                                                                                                                | | ` void`                                                                                              | ` onCreate(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg0) `                                                                                                                                                                                                                                                   | | ` `[Animator](https://developer.android.com/reference/android/animation/Animator.html)               | ` onCreateAnimator(int arg0, boolean arg1, int arg2) `                                                                                                                                                                                                                                                                                          | | ` void`                                                                                              | ` onCreateContextMenu(`[ContextMenu](https://developer.android.com/reference/android/view/ContextMenu.html)` arg0, `[View](https://developer.android.com/reference/android/view/View.html)` arg1, `[ContextMenu.ContextMenuInfo](https://developer.android.com/reference/android/view/ContextMenu.ContextMenuInfo.html)` arg2) `                | | ` void`                                                                                              | ` onCreateOptionsMenu(`[Menu](https://developer.android.com/reference/android/view/Menu.html)` arg0, `[MenuInflater](https://developer.android.com/reference/android/view/MenuInflater.html)` arg1) `                                                                                                                                           | | ` `[View](https://developer.android.com/reference/android/view/View.html)                            | ` onCreateView(`[LayoutInflater](https://developer.android.com/reference/android/view/LayoutInflater.html)` arg0, `[ViewGroup](https://developer.android.com/reference/android/view/ViewGroup.html)` arg1, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg2) `                                                   | | ` void`                                                                                              | ` onDestroy() `                                                                                                                                                                                                                                                                                                                                 | | ` void`                                                                                              | ` onDestroyOptionsMenu() `                                                                                                                                                                                                                                                                                                                      | | ` void`                                                                                              | ` onDestroyView() `                                                                                                                                                                                                                                                                                                                             | | ` void`                                                                                              | ` onDetach() `                                                                                                                                                                                                                                                                                                                                  | | ` `[LayoutInflater](https://developer.android.com/reference/android/view/LayoutInflater.html)        | ` onGetLayoutInflater(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg0) `                                                                                                                                                                                                                                        | | ` void`                                                                                              | ` onHiddenChanged(boolean arg0) `                                                                                                                                                                                                                                                                                                               | | ` void`                                                                                              | ` onInflate(`[AttributeSet](https://developer.android.com/reference/android/util/AttributeSet.html)` arg0, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg1) `                                                                                                                                                   | | ` void`                                                                                              | ` onInflate(`[Activity](https://developer.android.com/reference/android/app/Activity.html)` arg0, `[AttributeSet](https://developer.android.com/reference/android/util/AttributeSet.html)` arg1, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg2) `                                                             | | ` void`                                                                                              | ` onInflate(`[Context](https://developer.android.com/reference/android/content/Context.html)` arg0, `[AttributeSet](https://developer.android.com/reference/android/util/AttributeSet.html)` arg1, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg2) `                                                           | | ` void`                                                                                              | ` onLowMemory() `                                                                                                                                                                                                                                                                                                                               | | ` void`                                                                                              | ` onMultiWindowModeChanged(boolean arg0) `                                                                                                                                                                                                                                                                                                      | | ` void`                                                                                              | ` onMultiWindowModeChanged(boolean arg0, `[Configuration](https://developer.android.com/reference/android/content/res/Configuration.html)` arg1) `                                                                                                                                                                                              | | ` boolean`                                                                                           | ` onOptionsItemSelected(`[MenuItem](https://developer.android.com/reference/android/view/MenuItem.html)` arg0) `                                                                                                                                                                                                                                | | ` void`                                                                                              | ` onOptionsMenuClosed(`[Menu](https://developer.android.com/reference/android/view/Menu.html)` arg0) `                                                                                                                                                                                                                                          | | ` void`                                                                                              | ` onPause() `                                                                                                                                                                                                                                                                                                                                   | | ` void`                                                                                              | ` onPictureInPictureModeChanged(boolean arg0, `[Configuration](https://developer.android.com/reference/android/content/res/Configuration.html)` arg1) `                                                                                                                                                                                         | | ` void`                                                                                              | ` onPictureInPictureModeChanged(boolean arg0) `                                                                                                                                                                                                                                                                                                 | | ` void`                                                                                              | ` onPrepareOptionsMenu(`[Menu](https://developer.android.com/reference/android/view/Menu.html)` arg0) `                                                                                                                                                                                                                                         | | ` void`                                                                                              | ` onRequestPermissionsResult(int arg0, String[] arg1, int[] arg2) `                                                                                                                                                                                                                                                                             | | ` void`                                                                                              | ` onResume() `                                                                                                                                                                                                                                                                                                                                  | | ` void`                                                                                              | ` onSaveInstanceState(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg0) `                                                                                                                                                                                                                                        | | ` void`                                                                                              | ` onStart() `                                                                                                                                                                                                                                                                                                                                   | | ` void`                                                                                              | ` onStop() `                                                                                                                                                                                                                                                                                                                                    | | ` void`                                                                                              | ` onTrimMemory(int arg0) `                                                                                                                                                                                                                                                                                                                      | | ` void`                                                                                              | ` onViewCreated(`[View](https://developer.android.com/reference/android/view/View.html)` arg0, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg1) `                                                                                                                                                               | | ` void`                                                                                              | ` onViewStateRestored(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg0) `                                                                                                                                                                                                                                        | | ` void`                                                                                              | ` postponeEnterTransition() `                                                                                                                                                                                                                                                                                                                   | | ` void`                                                                                              | ` registerForContextMenu(`[View](https://developer.android.com/reference/android/view/View.html)` arg0) `                                                                                                                                                                                                                                       | | ` final void`                                                                                        | ` requestPermissions(String[] arg0, int arg1) `                                                                                                                                                                                                                                                                                                 | | ` void`                                                                                              | ` setAllowEnterTransitionOverlap(boolean arg0) `                                                                                                                                                                                                                                                                                                | | ` void`                                                                                              | ` setAllowReturnTransitionOverlap(boolean arg0) `                                                                                                                                                                                                                                                                                               | | ` void`                                                                                              | ` setArguments(`[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg0) `                                                                                                                                                                                                                                               | | ` void`                                                                                              | ` setEnterSharedElementCallback(`[SharedElementCallback](https://developer.android.com/reference/android/app/SharedElementCallback.html)` arg0) `                                                                                                                                                                                               | | ` void`                                                                                              | ` setEnterTransition(`[Transition](https://developer.android.com/reference/android/transition/Transition.html)` arg0) `                                                                                                                                                                                                                         | | ` void`                                                                                              | ` setExitSharedElementCallback(`[SharedElementCallback](https://developer.android.com/reference/android/app/SharedElementCallback.html)` arg0) `                                                                                                                                                                                                | | ` void`                                                                                              | ` setExitTransition(`[Transition](https://developer.android.com/reference/android/transition/Transition.html)` arg0) `                                                                                                                                                                                                                          | | ` void`                                                                                              | ` setHasOptionsMenu(boolean arg0) `                                                                                                                                                                                                                                                                                                             | | ` void`                                                                                              | ` setInitialSavedState(`[Fragment.SavedState](https://developer.android.com/reference/android/app/Fragment.SavedState.html)` arg0) `                                                                                                                                                                                                            | | ` void`                                                                                              | ` setMenuVisibility(boolean arg0) `                                                                                                                                                                                                                                                                                                             | | ` void`                                                                                              | ` setReenterTransition(`[Transition](https://developer.android.com/reference/android/transition/Transition.html)` arg0) `                                                                                                                                                                                                                       | | ` void`                                                                                              | ` setRetainInstance(boolean arg0) `                                                                                                                                                                                                                                                                                                             | | ` void`                                                                                              | ` setReturnTransition(`[Transition](https://developer.android.com/reference/android/transition/Transition.html)` arg0) `                                                                                                                                                                                                                        | | ` void`                                                                                              | ` setSharedElementEnterTransition(`[Transition](https://developer.android.com/reference/android/transition/Transition.html)` arg0) `                                                                                                                                                                                                            | | ` void`                                                                                              | ` setSharedElementReturnTransition(`[Transition](https://developer.android.com/reference/android/transition/Transition.html)` arg0) `                                                                                                                                                                                                           | | ` void`                                                                                              | ` setTargetFragment(`[Fragment](https://developer.android.com/reference/android/app/Fragment.html)` arg0, int arg1) `                                                                                                                                                                                                                           | | ` void`                                                                                              | ` setUserVisibleHint(boolean arg0) `                                                                                                                                                                                                                                                                                                            | | ` boolean`                                                                                           | ` shouldShowRequestPermissionRationale(String arg0) `                                                                                                                                                                                                                                                                                           | | ` void`                                                                                              | ` startActivity(`[Intent](https://developer.android.com/reference/android/content/Intent.html)` arg0) `                                                                                                                                                                                                                                         | | ` void`                                                                                              | ` startActivity(`[Intent](https://developer.android.com/reference/android/content/Intent.html)` arg0, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg1) `                                                                                                                                                        | | ` void`                                                                                              | ` startActivityForResult(`[Intent](https://developer.android.com/reference/android/content/Intent.html)` arg0, int arg1) `                                                                                                                                                                                                                      | | ` void`                                                                                              | ` startActivityForResult(`[Intent](https://developer.android.com/reference/android/content/Intent.html)` arg0, int arg1, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg2) `                                                                                                                                     | | ` void`                                                                                              | ` startIntentSenderForResult(`[IntentSender](https://developer.android.com/reference/android/content/IntentSender.html)` arg0, int arg1, `[Intent](https://developer.android.com/reference/android/content/Intent.html)` arg2, int arg3, int arg4, int arg5, `[Bundle](https://developer.android.com/reference/android/os/Bundle.html)` arg6) ` | | ` void`                                                                                              | ` startPostponedEnterTransition() `                                                                                                                                                                                                                                                                                                             | | ` String`                                                                                            | ` toString() `                                                                                                                                                                                                                                                                                                                                  | | ` void`                                                                                              | ` unregisterForContextMenu(`[View](https://developer.android.com/reference/android/view/View.html)` arg0) `                                                                                                                                                                                                                                     | ||
| [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#)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() `                    | ||
| [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#)From interface` `[android.content.ComponentCallbacks2](https://developer.android.com/reference/android/content/ComponentCallbacks2.html)` ` |------------------|----------------------------| | ` abstract void` | ` onTrimMemory(int arg0) ` | ||
| [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#)From interface` `[android.view.View.OnCreateContextMenuListener](https://developer.android.com/reference/android/view/View.OnCreateContextMenuListener.html)` ` |------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract void` | ` onCreateContextMenu(`[ContextMenu](https://developer.android.com/reference/android/view/ContextMenu.html)` arg0, `[View](https://developer.android.com/reference/android/view/View.html)` arg1, `[ContextMenu.ContextMenuInfo](https://developer.android.com/reference/android/view/ContextMenu.ContextMenuInfo.html)` arg2) ` | ||
| [![](https://developer.android.com/static/assets/images/styles/disclosure_down.png)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#)From interface` `[android.content.ComponentCallbacks](https://developer.android.com/reference/android/content/ComponentCallbacks.html)` ` |------------------|------------------------------------------------------------------------------------------------------------------------------------| | ` abstract void` | ` onConfigurationChanged(`[Configuration](https://developer.android.com/reference/android/content/res/Configuration.html)` arg0) ` | | ` abstract void` | ` onLowMemory() `                                                                                                                  | ||

## Constants

### BG_DARK

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
int BG_DARK
```

A dark translucent background.

<br />

Constant Value: 1 (0x00000001)  

### BG_LIGHT

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
int BG_LIGHT
```

A light translucent background.

<br />

Constant Value: 2 (0x00000002)  

### BG_NONE

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
int BG_NONE
```

No background.

<br />

Constant Value: 0 (0x00000000)

## Public constructors

### PlaybackFragment

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
PlaybackFragment ()
```

<br />

<br />

## Public methods

### fadeOut

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void fadeOut ()
```

<br />

**This method was deprecated in API level 26.1.0.**   
Call[hideControlsOverlay(boolean)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#hideControlsOverlay(boolean))

Fades out the playback overlay immediately.

<br />

### getAdapter

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
ObjectAdapter getAdapter ()
```

<br />

<br />

|                                                      Returns                                                       ||
|------------------------------------------------------------------------------------------------------------|--------|
| [ObjectAdapter](https://developer.android.com/reference/android/support/v17/leanback/widget/ObjectAdapter) | <br /> |

### getBackgroundType

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
int getBackgroundType ()
```

Returns the background type.

<br />

|    Returns    ||
|-------|--------|
| `int` | <br /> |

### getProgressBarManager

added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
ProgressBarManager getProgressBarManager ()
```

Returns the ProgressBarManager that will show or hide progress bar in[onBufferingStateChanged(boolean)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#onBufferingStateChanged(boolean)).

<br />

|                                                                                                                                                                        Returns                                                                                                                                                                         ||
|-------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [ProgressBarManager](https://developer.android.com/reference/android/support/v17/leanback/app/ProgressBarManager) | The ProgressBarManager that will show or hide progress bar in[onBufferingStateChanged(boolean)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#onBufferingStateChanged(boolean)). <br /> |

### hideControlsOverlay

added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void hideControlsOverlay (boolean runAnimation)
```

Hide controls overlay.

<br />

|                                Parameters                                 ||
|----------------|-----------------------------------------------------------|
| `runAnimation` | `boolean`: True to run animation, false otherwise. <br /> |

### isControlsOverlayAutoHideEnabled

added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
boolean isControlsOverlayAutoHideEnabled ()
```

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

<br />

|      Returns      ||
|-----------|--------|
| `boolean` | <br /> |

### isControlsOverlayVisible

added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
boolean isControlsOverlayVisible ()
```

Returns true if controls overlay is visible, false otherwise.

<br />

|                                 Returns                                 ||
|-----------|--------------------------------------------------------------|
| `boolean` | True if controls overlay is visible, false otherwise. <br /> |

**See also:**

- [showControlsOverlay(boolean)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#showControlsOverlay(boolean))
- [hideControlsOverlay(boolean)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#hideControlsOverlay(boolean))  

### isFadingEnabled

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
boolean isFadingEnabled ()
```

<br />

**This method was deprecated in API level 26.1.0.**   
Uses[isControlsOverlayAutoHideEnabled()](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#isControlsOverlayAutoHideEnabled())

<br />

<br />

|      Returns      ||
|-----------|--------|
| `boolean` | <br /> |

### notifyPlaybackRowChanged

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void notifyPlaybackRowChanged ()
```

Updates the ui when the row data changes.

<br />

### onCreate

```
void onCreate (Bundle savedInstanceState)
```

<br />

<br />

|              Parameters               ||
|----------------------|-----------------|
| `savedInstanceState` | `Bundle` <br /> |

### onCreateView

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

<br />

<br />

|                  Parameters                   ||
|----------------------|-------------------------|
| `inflater`           | `LayoutInflater` <br /> |
| `container`          | `ViewGroup` <br />      |
| `savedInstanceState` | `Bundle` <br />         |

|                                    Returns                                     ||
|------------------------------------------------------------------------|--------|
| [View](https://developer.android.com/reference/android/view/View.html) | <br /> |

### onDestroy

```
void onDestroy ()
```

<br />

<br />

### onDestroyView

```
void onDestroyView ()
```

<br />

<br />

### onPause

```
void onPause ()
```

<br />

<br />

### onResume

```
void onResume ()
```

<br />

<br />

### onStart

```
void onStart ()
```

<br />

<br />

### onStop

```
void onStop ()
```

<br />

<br />

### onViewCreated

```
void onViewCreated (View view, 
                Bundle savedInstanceState)
```

<br />

<br />

|              Parameters               ||
|----------------------|-----------------|
| `view`               | `View` <br />   |
| `savedInstanceState` | `Bundle` <br /> |

### setAdapter

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void setAdapter (ObjectAdapter adapter)
```

Sets the list of rows for the fragment. A default[ClassPresenterSelector](https://developer.android.com/reference/android/support/v17/leanback/widget/ClassPresenterSelector)will be created if[getPresenterSelector()](https://developer.android.com/reference/android/support/v17/leanback/widget/ObjectAdapter#getPresenterSelector())is null. if user provides[setPlaybackRow(Row)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setPlaybackRow(android.support.v17.leanback.widget.Row))and[setPlaybackRowPresenter(PlaybackRowPresenter)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setPlaybackRowPresenter(android.support.v17.leanback.widget.PlaybackRowPresenter)), the row and presenter will be set onto the adapter.

<br />

|                                              Parameters                                              ||
|-----------|-------------------------------------------------------------------------------------------|
| `adapter` | `ObjectAdapter`: The adapter that contains related rows and optional playback row. <br /> |

### setBackgroundType

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void setBackgroundType (int type)
```

Sets the background type.

<br />

|                         Parameters                          ||
|--------|-----------------------------------------------------|
| `type` | `int`: One of BG_LIGHT, BG_DARK, or BG_NONE. <br /> |

### setControlsOverlayAutoHideEnabled

added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
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()](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#tickle())will kill the timer, next time fragment is resumed, the timer will be started again if[isControlsOverlayAutoHideEnabled()](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#isControlsOverlayAutoHideEnabled())is true.

<br />

|         Parameters          ||
|-----------|------------------|
| `enabled` | `boolean` <br /> |

### setFadingEnabled

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void setFadingEnabled (boolean enabled)
```

<br />

**This method was deprecated in API level 26.1.0.**   
Uses[setControlsOverlayAutoHideEnabled(boolean)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setControlsOverlayAutoHideEnabled(boolean))

<br />

<br />

|         Parameters          ||
|-----------|------------------|
| `enabled` | `boolean` <br /> |

### setHostCallback

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void setHostCallback (PlaybackGlueHost.HostCallback hostCallback)
```

Sets the[PlaybackGlueHost.HostCallback](https://developer.android.com/reference/android/support/v17/leanback/media/PlaybackGlueHost.HostCallback). Implementor of this interface will take appropriate actions to take action when the hosting fragment starts/stops processing.

<br />

|                       Parameters                       ||
|----------------|----------------------------------------|
| `hostCallback` | `PlaybackGlueHost.HostCallback` <br /> |

### setOnItemViewClickedListener

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void setOnItemViewClickedListener (BaseOnItemViewClickedListener listener)
```

This listener is called every time there is a click in[RowsFragment](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment). This can be used by users to take additional actions such as animations.

<br />

|                     Parameters                     ||
|------------|----------------------------------------|
| `listener` | `BaseOnItemViewClickedListener` <br /> |

### setOnItemViewSelectedListener

added in[version 25.4.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void setOnItemViewSelectedListener (BaseOnItemViewSelectedListener listener)
```

This listener is called every time there is a selection in[RowsFragment](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment). This can be used by users to take additional actions such as animations.

<br />

|                     Parameters                      ||
|------------|-----------------------------------------|
| `listener` | `BaseOnItemViewSelectedListener` <br /> |

### setOnKeyInterceptListener

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void setOnKeyInterceptListener (View.OnKeyListener handler)
```

Sets the input event handler.

<br />

|               Parameters               ||
|-----------|-----------------------------|
| `handler` | `View.OnKeyListener` <br /> |

### setOnPlaybackItemViewClickedListener

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void setOnPlaybackItemViewClickedListener (BaseOnItemViewClickedListener listener)
```

Sets the[BaseOnItemViewClickedListener](https://developer.android.com/reference/android/support/v17/leanback/widget/BaseOnItemViewClickedListener)that would be invoked for clicks only on[PlaybackRowPresenter.ViewHolder](https://developer.android.com/reference/android/support/v17/leanback/widget/PlaybackRowPresenter.ViewHolder).

<br />

|                     Parameters                     ||
|------------|----------------------------------------|
| `listener` | `BaseOnItemViewClickedListener` <br /> |

### setPlaybackRow

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
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](https://developer.android.com/reference/android/support/v17/leanback/widget/ArrayObjectAdapter)or[SparseArrayObjectAdapter](https://developer.android.com/reference/android/support/v17/leanback/widget/SparseArrayObjectAdapter).

<br />

|                         Parameters                         ||
|-------|-----------------------------------------------------|
| `row` | `Row`: The row that represents the playback. <br /> |

### setPlaybackRowPresenter

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void setPlaybackRowPresenter (PlaybackRowPresenter presenter)
```

Sets the presenter for rendering the playback row set by[setPlaybackRow(Row)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setPlaybackRow(android.support.v17.leanback.widget.Row)). If adapter does not set a[PresenterSelector](https://developer.android.com/reference/android/support/v17/leanback/widget/PresenterSelector),[setAdapter(ObjectAdapter)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setAdapter(android.support.v17.leanback.widget.ObjectAdapter))will create a[ClassPresenterSelector](https://developer.android.com/reference/android/support/v17/leanback/widget/ClassPresenterSelector)by default and map from the row object class to this[PlaybackRowPresenter](https://developer.android.com/reference/android/support/v17/leanback/widget/PlaybackRowPresenter).

<br />

|                                                                                                                  Parameters                                                                                                                   ||
|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `presenter` | `PlaybackRowPresenter`: Presenter used to render[setPlaybackRow(Row)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setPlaybackRow(android.support.v17.leanback.widget.Row)). <br /> |

### setPlaybackSeekUiClient

added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void setPlaybackSeekUiClient (PlaybackSeekUi.Client client)
```

Interface to be implemented by UI widget to support PlaybackSeekUi.

<br />

|                Parameters                ||
|----------|--------------------------------|
| `client` | `PlaybackSeekUi.Client` <br /> |

### setSelectedPosition

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void setSelectedPosition (int position)
```

Sets the selected row position with smooth animation.

<br />

|        Parameters        ||
|------------|--------------|
| `position` | `int` <br /> |

### setSelectedPosition

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void setSelectedPosition (int position, 
                boolean smooth)
```

Sets the selected row position.

<br />

|          Parameters          ||
|------------|------------------|
| `position` | `int` <br />     |
| `smooth`   | `boolean` <br /> |

### showControlsOverlay

added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void showControlsOverlay (boolean runAnimation)
```

Show controls overlay.

<br />

|                                Parameters                                 ||
|----------------|-----------------------------------------------------------|
| `runAnimation` | `boolean`: True to run animation, false otherwise. <br /> |

### tickle

added in[version 25.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void tickle ()
```

Tickles the playback controls. Fades in the view if it was faded out.[tickle()](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#tickle())will also kill the timer created by[setControlsOverlayAutoHideEnabled(boolean)](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#setControlsOverlayAutoHideEnabled(boolean)). When next time fragment is resumed, the timer will be started again if[isControlsOverlayAutoHideEnabled()](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment#isControlsOverlayAutoHideEnabled())is true. In most cases app does not need call this method, tickling on input events is handled by the fragment.

<br />

## Protected methods

### onBufferingStateChanged

added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void onBufferingStateChanged (boolean start)
```

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

<br />

|                              Parameters                               ||
|---------|--------------------------------------------------------------|
| `start` | `boolean`: True for buffering start, false otherwise. <br /> |

### onError

added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void onError (int errorCode, 
                CharSequence errorMessage)
```

Called when media has error. App may override.

<br />

|                                         Parameters                                         ||
|----------------|----------------------------------------------------------------------------|
| `errorCode`    | `int`: Optional error code for specific implementation. <br />             |
| `errorMessage` | `CharSequence`: Optional error message for specific implementation. <br /> |

### onVideoSizeChanged

added in[version 26.1.0](https://developer.android.com/topic/libraries/support-library/revisions)  

```
void onVideoSizeChanged (int videoWidth, 
                int videoHeight)
```

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

<br />

|                       Parameters                       ||
|---------------|-----------------------------------------|
| `videoWidth`  | `int`: Intrinsic width of video <br />  |
| `videoHeight` | `int`: Intrinsic height of video <br /> |

-

  ## Interfaces

  - [BrowseFragment.FragmentHost](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.FragmentHost)
  - [BrowseFragment.MainFragmentAdapterProvider](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentAdapterProvider)
  - [BrowseFragment.MainFragmentRowsAdapterProvider](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentRowsAdapterProvider)
  - [BrowseSupportFragment.FragmentHost](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.FragmentHost)
  - [BrowseSupportFragment.MainFragmentAdapterProvider](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentAdapterProvider)
  - [BrowseSupportFragment.MainFragmentRowsAdapterProvider](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentRowsAdapterProvider)
  - [HeadersFragment.OnHeaderClickedListener](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersFragment.OnHeaderClickedListener)
  - [HeadersFragment.OnHeaderViewSelectedListener](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersFragment.OnHeaderViewSelectedListener)
  - [HeadersSupportFragment.OnHeaderClickedListener](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersSupportFragment.OnHeaderClickedListener)
  - [HeadersSupportFragment.OnHeaderViewSelectedListener](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersSupportFragment.OnHeaderViewSelectedListener)
  - [SearchFragment.SearchResultProvider](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment.SearchResultProvider)
  - [SearchSupportFragment.SearchResultProvider](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment.SearchResultProvider)
-

  ## Classes

  - [BackgroundManager](https://developer.android.com/reference/android/support/v17/leanback/app/BackgroundManager)
  - [BaseFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BaseFragment)
  - [BaseSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BaseSupportFragment)
  - [BrandedFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BrandedFragment)
  - [BrandedSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BrandedSupportFragment)
  - [BrowseFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment)
  - [BrowseFragment.BrowseTransitionListener](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.BrowseTransitionListener)
  - [BrowseFragment.FragmentFactory](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.FragmentFactory)
  - [BrowseFragment.ListRowFragmentFactory](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.ListRowFragmentFactory)
  - [BrowseFragment.MainFragmentAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentAdapter)
  - [BrowseFragment.MainFragmentAdapterRegistry](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentAdapterRegistry)
  - [BrowseFragment.MainFragmentRowsAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseFragment.MainFragmentRowsAdapter)
  - [BrowseSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment)
  - [BrowseSupportFragment.BrowseTransitionListener](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.BrowseTransitionListener)
  - [BrowseSupportFragment.FragmentFactory](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.FragmentFactory)
  - [BrowseSupportFragment.ListRowFragmentFactory](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.ListRowFragmentFactory)
  - [BrowseSupportFragment.MainFragmentAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentAdapter)
  - [BrowseSupportFragment.MainFragmentAdapterRegistry](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentAdapterRegistry)
  - [BrowseSupportFragment.MainFragmentRowsAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/BrowseSupportFragment.MainFragmentRowsAdapter)
  - [DetailsFragment](https://developer.android.com/reference/android/support/v17/leanback/app/DetailsFragment)
  - [DetailsFragmentBackgroundController](https://developer.android.com/reference/android/support/v17/leanback/app/DetailsFragmentBackgroundController)
  - [DetailsSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/DetailsSupportFragment)
  - [DetailsSupportFragmentBackgroundController](https://developer.android.com/reference/android/support/v17/leanback/app/DetailsSupportFragmentBackgroundController)
  - [ErrorFragment](https://developer.android.com/reference/android/support/v17/leanback/app/ErrorFragment)
  - [ErrorSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/ErrorSupportFragment)
  - [GuidedStepFragment](https://developer.android.com/reference/android/support/v17/leanback/app/GuidedStepFragment)
  - [GuidedStepSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/GuidedStepSupportFragment)
  - [HeadersFragment](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersFragment)
  - [HeadersSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/HeadersSupportFragment)
  - [OnboardingFragment](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingFragment)
  - [OnboardingSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/OnboardingSupportFragment)
  - [PlaybackFragment](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragment)
  - [PlaybackFragmentGlueHost](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackFragmentGlueHost)
  - [PlaybackSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackSupportFragment)
  - [PlaybackSupportFragmentGlueHost](https://developer.android.com/reference/android/support/v17/leanback/app/PlaybackSupportFragmentGlueHost)
  - [ProgressBarManager](https://developer.android.com/reference/android/support/v17/leanback/app/ProgressBarManager)
  - [RowsFragment](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment)
  - [RowsFragment.MainFragmentAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment.MainFragmentAdapter)
  - [RowsFragment.MainFragmentRowsAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/RowsFragment.MainFragmentRowsAdapter)
  - [RowsSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/RowsSupportFragment)
  - [RowsSupportFragment.MainFragmentAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/RowsSupportFragment.MainFragmentAdapter)
  - [RowsSupportFragment.MainFragmentRowsAdapter](https://developer.android.com/reference/android/support/v17/leanback/app/RowsSupportFragment.MainFragmentRowsAdapter)
  - [SearchFragment](https://developer.android.com/reference/android/support/v17/leanback/app/SearchFragment)
  - [SearchSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/SearchSupportFragment)
  - [VerticalGridFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VerticalGridFragment)
  - [VerticalGridSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VerticalGridSupportFragment)
  - [VideoFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VideoFragment)
  - [VideoFragmentGlueHost](https://developer.android.com/reference/android/support/v17/leanback/app/VideoFragmentGlueHost)
  - [VideoSupportFragment](https://developer.android.com/reference/android/support/v17/leanback/app/VideoSupportFragment)
  - [VideoSupportFragmentGlueHost](https://developer.android.com/reference/android/support/v17/leanback/app/VideoSupportFragmentGlueHost)