Summary: Constants | Ctors | Methods | Protected Methods | Inherited Methods

PlaybackSupportFragment

Kotlin |Java

public class PlaybackSupportFragment
extends Fragment

java.lang.Object
↳	androidx.fragment.app.Fragment
	↳	androidx.leanback.app.PlaybackSupportFragment

Known direct subclasses

VideoSupportFragment

VideoSupportFragment Subclass of PlaybackSupportFragment that is responsible for providing a SurfaceView and rendering video.

A fragment for displaying playback controls and related content.

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

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

Hiding and showing controls: the controls are initially visible and automatically show/hide when play/pause or user interacts with fragment.

App may manually call showControlsOverlay(boolean) or hideControlsOverlay(boolean) to show or hide the controls.
The controls are visible by default upon onViewCreated(). To make it initially invisible, call hideControlsOverlay(false) in overridden onViewCreated().
Upon play or pause, PlaybackControlGlue or PlaybackTransportControlGlue will fade-in the controls and automatically fade out after a delay customized by R.attr.playbackControlsAutoHideTimeout. To disable the fade in and fade out behavior: call #setControlsOverlayAutoHideEnabled(boolean) with false.
Upon user interaction event, fragment will fade-in the controls and automatically fade out after a delay customized by R.attr.playbackControlsAutoHideTickleTimeout. To disable the fade in and fade out behavior, call setShowOrHideControlsOverlayOnUserInteraction(boolean) with false.

Summary

Constants
`int`	`BG_DARK` A dark translucent background.
`int`	`BG_LIGHT` A light translucent background.
`int`	`BG_NONE` No background.

Public constructors
`PlaybackSupportFragment()`

Public methods
`void`	`fadeOut()` This method is deprecated. Call `hideControlsOverlay(boolean)`
`ObjectAdapter`	`getAdapter()`
`int`	`getBackgroundType()` Returns the background type.
`ProgressBarManager`	`getProgressBarManager()` Returns the ProgressBarManager that will show or hide progress bar in `onBufferingStateChanged(boolean)`.
`void`	`hideControlsOverlay(boolean runAnimation)` Hide controls overlay.
`boolean`	`isControlsOverlayAutoHideEnabled()` Returns true if controls will be auto hidden after a delay when fragment is resumed.
`boolean`	`isControlsOverlayVisible()` Returns true if controls overlay is visible, false otherwise.
`boolean`	`isFadingEnabled()` This method is deprecated. Uses `isControlsOverlayAutoHideEnabled()`
`boolean`	`isShowOrHideControlsOverlayOnUserInteraction()` Returns true if showing and auto-hiding controls when user interacts; false otherwise.
`void`	`notifyPlaybackRowChanged()` Updates the ui when the row data changes.
`void`	`onCreate(Bundle savedInstanceState)` Called to do initial creation of a fragment.
`View`	`onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)` Called to have the fragment instantiate its user interface view.
`void`	`onDestroy()` Called when the fragment is no longer in use.
`void`	`onDestroyView()` Called when the view previously created by `onCreateView(LayoutInflater, ViewGroup, Bundle)` has been detached from the fragment.
`void`	`onPause()` Called when the Fragment is no longer resumed.
`void`	`onResume()` Called when the fragment is visible to the user and actively running.
`void`	`onStart()` Called when the Fragment is visible to the user.
`void`	`onStop()` Called when the Fragment is no longer started.
`void`	`onViewCreated(View view, Bundle savedInstanceState)` Called immediately after `onCreateView(LayoutInflater, ViewGroup, Bundle)` has returned, but before any saved state has been restored in to the view.
`void`	`setAdapter(ObjectAdapter adapter)` Sets the list of rows for the fragment.
`void`	`setBackgroundType(int type)` Sets the background type.
`void`	`setControlsOverlayAutoHideEnabled(boolean enabled)` Enables or disables auto hiding controls overlay after a short delay fragment is resumed.
`void`	`setFadingEnabled(boolean enabled)` This method is deprecated. Uses `setControlsOverlayAutoHideEnabled(boolean)`
`void`	`setHostCallback(PlaybackGlueHost.HostCallback hostCallback)` Sets the `PlaybackGlueHost.HostCallback`.
`void`	`setOnItemViewClickedListener(BaseOnItemViewClickedListener listener)` This listener is called every time there is a click in `RowsSupportFragment`.
`void`	`setOnItemViewSelectedListener(BaseOnItemViewSelectedListener listener)` This listener is called every time there is a selection in `RowsSupportFragment`.
`final void`	`setOnKeyInterceptListener(View.OnKeyListener handler)` Sets the input event handler.
`void`	`setOnPlaybackItemViewClickedListener(BaseOnItemViewClickedListener listener)` Sets the `BaseOnItemViewClickedListener` that would be invoked for clicks only on `PlaybackRowPresenter.ViewHolder`.
`void`	`setPlaybackRow(Row row)` Sets the playback row for the playback controls.
`void`	`setPlaybackRowPresenter(PlaybackRowPresenter presenter)` Sets the presenter for rendering the playback row set by `setPlaybackRow(Row)`.
`void`	`setPlaybackSeekUiClient(PlaybackSeekUi.Client client)` Interface to be implemented by UI widget to support PlaybackSeekUi.
`void`	`setSelectedPosition(int position)` Sets the selected row position with smooth animation.
`void`	`setSelectedPosition(int position, boolean smooth)` Sets the selected row position.
`void`	`setShowOrHideControlsOverlayOnUserInteraction(boolean showOrHideControlsOverlayOnUserInteraction)` Enables or disables showing and auto-hiding controls when user interacts.
`void`	`showControlsOverlay(boolean runAnimation)` Show controls overlay.
`void`	`tickle()` Tickles the playback controls.

Protected methods
`void`	`onBufferingStateChanged(boolean start)` Called when media has start or stop buffering.
`void`	`onError(int errorCode, CharSequence errorMessage)` Called when media has error.
`void`	`onVideoSizeChanged(int videoWidth, int videoHeight)` Called when size of the video changes.

Inherited methods

From class


        
          androidx.fragment.app.Fragment

`void`	`dump(String prefix, FileDescriptor fd, PrintWriter writer, String[] args)` Print the Fragments's state into the given stream.
`final boolean`	`equals(Object o)` Subclasses can not override equals().
`final FragmentActivity`	`getActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`boolean`	`getAllowEnterTransitionOverlap()` Returns whether the the exit transition and enter transition overlap or not.
`boolean`	`getAllowReturnTransitionOverlap()` Returns whether the the return transition and reenter transition overlap or not.
`final Bundle`	`getArguments()` Return the arguments supplied when the fragment was instantiated, if any.
`final FragmentManager`	`getChildFragmentManager()` Return a private FragmentManager for placing and managing Fragments inside of this Fragment.
`Context`	`getContext()` Return the `Context` this fragment is currently associated with.
`ViewModelProvider.Factory`	`getDefaultViewModelProviderFactory()` Returns the default `ViewModelProvider.Factory` that should be used when no custom `Factory` is provided to the `ViewModelProvider` constructors. The `Fragment's arguments` when this is first called will be used as the defaults to any `SavedStateHandle` passed to a view model created using this factory.
`Object`	`getEnterTransition()` Returns the Transition that will be used to move Views into the initial scene.
`Object`	`getExitTransition()` Returns the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`final FragmentManager`	`getFragmentManager()` This method is deprecated. This has been removed in favor of `getParentFragmentManager()` which throws an `IllegalStateException` if the FragmentManager is null. Check if `isAdded()` returns `false` to determine if the FragmentManager is `null`.
`final Object`	`getHost()` Return the host object of this fragment.
`final int`	`getId()` Return the identifier this fragment is known by.
`final LayoutInflater`	`getLayoutInflater()` Returns the cached LayoutInflater used to inflate Views of this Fragment.
`Lifecycle`	`getLifecycle()` Returns the Lifecycle of the provider. Overriding this method is no longer supported and this method will be made `final` in a future version of Fragment.
`LoaderManager`	`getLoaderManager()` This method is deprecated. Use `LoaderManager.getInstance(this)`.
`final Fragment`	`getParentFragment()` Returns the parent Fragment containing this Fragment.
`final FragmentManager`	`getParentFragmentManager()` Return the FragmentManager for interacting with fragments associated with this fragment's activity.
`Object`	`getReenterTransition()` Returns the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`final Resources`	`getResources()` Return `requireActivity().getResources()`.
`final boolean`	`getRetainInstance()` This method is deprecated. Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment. The ViewModel's constructor and its onCleared() callback provide the signal for initial creation and final destruction of the retained state.
`Object`	`getReturnTransition()` Returns the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
`final SavedStateRegistry`	`getSavedStateRegistry()` Returns owned `SavedStateRegistry`
`Object`	`getSharedElementEnterTransition()` Returns the Transition that will be used for shared elements transferred into the content Scene.
`Object`	`getSharedElementReturnTransition()` Return the Transition that will be used for shared elements transferred back during a pop of the back stack.
`final String`	`getString(int resId, Object... formatArgs)` Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `Formatter` and `String.format(String, Object...)`.
`final String`	`getString(int resId)` Return a localized string from the application's package's default string table.
`final String`	`getTag()` Get the tag name of the fragment, if specified.
`final Fragment`	`getTargetFragment()` This method is deprecated. Instead of using a target fragment to pass results, use `FragmentManager.setFragmentResult(String, Bundle)` to deliver results to `FragmentResultListener` instances registered by other fragments via `FragmentManager.setFragmentResultListener(String, LifecycleOwner, FragmentResultListener)`.
`final int`	`getTargetRequestCode()` This method is deprecated. When using the target fragment replacement of `FragmentManager.setFragmentResultListener(String, LifecycleOwner, FragmentResultListener)` and `FragmentManager.setFragmentResult(String, Bundle)`, consider using `setArguments(Bundle)` to pass a `requestKey` if you need to support dynamic request keys.
`final CharSequence`	`getText(int resId)` Return a localized, styled CharSequence from the application's package's default string table.
`boolean`	`getUserVisibleHint()` This method is deprecated. Use `FragmentTransaction.setMaxLifecycle(Fragment, Lifecycle.State)` instead.
`View`	`getView()` Get the root view for the fragment's layout (the one returned by `onCreateView(LayoutInflater, ViewGroup, Bundle)`), if provided.
`LifecycleOwner`	`getViewLifecycleOwner()` Get a `LifecycleOwner` that represents the `Fragment's View` lifecycle.
`LiveData<LifecycleOwner>`	`getViewLifecycleOwnerLiveData()` Retrieve a `LiveData` which allows you to observe the `lifecycle of the Fragment's View`.
`ViewModelStore`	`getViewModelStore()` Returns the `ViewModelStore` associated with this Fragment Overriding this method is no longer supported and this method will be made `final` in a future version of Fragment.
`final int`	`hashCode()` Subclasses can not override hashCode().
`static Fragment`	`instantiate(Context context, String fname)` This method is deprecated. Use `FragmentManager.getFragmentFactory()` and `FragmentFactory.instantiate(ClassLoader, String)`
`static Fragment`	`instantiate(Context context, String fname, Bundle args)` This method is deprecated. Use `FragmentManager.getFragmentFactory()` and `FragmentFactory.instantiate(ClassLoader, String)`, manually calling `setArguments(Bundle)` on the returned Fragment.
`final boolean`	`isAdded()` Return true if the fragment is currently added to its activity.
`final boolean`	`isDetached()` Return true if the fragment has been explicitly detached from the UI.
`final boolean`	`isHidden()` Return true if the fragment has been hidden.
`final boolean`	`isInLayout()` Return true if the layout is included as part of an activity view hierarchy via the <fragment> tag.
`final boolean`	`isRemoving()` Return true if this fragment is currently being removed from its activity.
`final boolean`	`isResumed()` Return true if the fragment is in the resumed state.
`final boolean`	`isStateSaved()` Returns true if this fragment is added and its state has already been saved by its host.
`final boolean`	`isVisible()` Return true if the fragment is currently visible to the user.
`void`	`onActivityCreated(Bundle savedInstanceState)` This method is deprecated. use `onViewCreated(View, Bundle)` for code touching the Fragment's view and `onCreate(Bundle)` for other initialization. To get a callback specifically when a Fragment activity's `Activity.onCreate(Bundle)` is called, register a `LifecycleObserver` on the Activity's `Lifecycle` in `onAttach(Context)`, removing it when it receives the `Lifecycle.State.CREATED` callback.
`void`	`onActivityResult(int requestCode, int resultCode, Intent data)` This method is deprecated. use `registerForActivityResult(ActivityResultContract, ActivityResultCallback)` with the appropriate `ActivityResultContract` and handling the result in the `callback`.
`void`	`onAttach(Activity activity)` This method is deprecated. See `onAttach(Context)`.
`void`	`onAttach(Context context)` Called when a fragment is first attached to its context.
`void`	`onAttachFragment(Fragment childFragment)` This method is deprecated. The responsibility for listening for fragments being attached has been moved to FragmentManager. You can add a listener to `getChildFragmentManager()` the child FragmentManager} by calling `FragmentManager.addFragmentOnAttachListener(FragmentOnAttachListener)` in `onAttach(Context)` to get callbacks when a child fragment is attached.
`void`	`onConfigurationChanged(Configuration newConfig)`
`boolean`	`onContextItemSelected(MenuItem item)` This hook is called whenever an item in a context menu is selected.
`void`	`onCreate(Bundle savedInstanceState)` Called to do initial creation of a fragment.
`Animation`	`onCreateAnimation(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animation.
`Animator`	`onCreateAnimator(int transit, boolean enter, int nextAnim)` Called when a fragment loads an animator.
`void`	`onCreateContextMenu(ContextMenu menu, View v, ContextMenu.ContextMenuInfo menuInfo)` Called when a context menu for the `view` is about to be shown.
`void`	`onCreateOptionsMenu(Menu menu, MenuInflater inflater)` Initialize the contents of the Fragment host's standard options menu.
`View`	`onCreateView(LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState)` Called to have the fragment instantiate its user interface view.
`void`	`onDestroy()` Called when the fragment is no longer in use.
`void`	`onDestroyOptionsMenu()` Called when this fragment's option menu items are no longer being included in the overall options menu.
`void`	`onDestroyView()` Called when the view previously created by `onCreateView(LayoutInflater, ViewGroup, Bundle)` has been detached from the fragment.
`void`	`onDetach()` Called when the fragment is no longer attached to its activity.
`LayoutInflater`	`onGetLayoutInflater(Bundle savedInstanceState)` Returns the LayoutInflater used to inflate Views of this Fragment.
`void`	`onHiddenChanged(boolean hidden)` Called when the hidden state (as returned by `isHidden()` of the fragment has changed.
`void`	`onInflate(Activity activity, AttributeSet attrs, Bundle savedInstanceState)` This method is deprecated. See `onInflate(Context, AttributeSet, Bundle)`.
`void`	`onInflate(Context context, AttributeSet attrs, Bundle savedInstanceState)` Called when a fragment is being created as part of a view layout inflation, typically from setting the content view of an activity.
`void`	`onLowMemory()`
`void`	`onMultiWindowModeChanged(boolean isInMultiWindowMode)` Called when the Fragment's activity changes from fullscreen mode to multi-window mode and visa-versa.
`boolean`	`onOptionsItemSelected(MenuItem item)` This hook is called whenever an item in your options menu is selected.
`void`	`onOptionsMenuClosed(Menu menu)` This hook is called whenever the options menu is being closed (either by the user canceling the menu with the back/menu button, or when an item is selected).
`void`	`onPause()` Called when the Fragment is no longer resumed.
`void`	`onPictureInPictureModeChanged(boolean isInPictureInPictureMode)` Called by the system when the activity changes to and from picture-in-picture mode.
`void`	`onPrepareOptionsMenu(Menu menu)` Prepare the Fragment host's standard options menu to be displayed.
`void`	`onPrimaryNavigationFragmentChanged(boolean isPrimaryNavigationFragment)` Callback for when the primary navigation state of this Fragment has changed.
`void`	`onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults)` This method is deprecated. use `registerForActivityResult(ActivityResultContract, ActivityResultCallback)` passing in a `ActivityResultContracts.RequestMultiplePermissions` object for the `ActivityResultContract` and handling the result in the `callback`.
`void`	`onResume()` Called when the fragment is visible to the user and actively running.
`void`	`onSaveInstanceState(Bundle outState)` Called to ask the fragment to save its current dynamic state, so it can later be reconstructed in a new instance if its process is restarted.
`void`	`onStart()` Called when the Fragment is visible to the user.
`void`	`onStop()` Called when the Fragment is no longer started.
`void`	`onViewCreated(View view, Bundle savedInstanceState)` Called immediately after `onCreateView(LayoutInflater, ViewGroup, Bundle)` has returned, but before any saved state has been restored in to the view.
`void`	`onViewStateRestored(Bundle savedInstanceState)` Called when all saved state has been restored into the view hierarchy of the fragment.
`void`	`postponeEnterTransition()` Postpone the entering Fragment transition until `startPostponedEnterTransition()` or `FragmentManager.executePendingTransactions()` has been called.
`final void`	`postponeEnterTransition(long duration, TimeUnit timeUnit)` Postpone the entering Fragment transition for a given amount of time and then call `startPostponedEnterTransition()`.
`final <I, O> ActivityResultLauncher<I>`	`registerForActivityResult(ActivityResultContract<I, O> contract, ActivityResultCallback<O> callback)` Register a request to `start an activity for result`, designated by the given `contract`. If the host of this fragment is an `ActivityResultRegistryOwner` the `ActivityResultRegistry` of the host will be used.
`final <I, O> ActivityResultLauncher<I>`	`registerForActivityResult(ActivityResultContract<I, O> contract, ActivityResultRegistry registry, ActivityResultCallback<O> callback)` Register a request to `start an activity for result`, designated by the given `contract`.
`void`	`registerForContextMenu(View view)` Registers a context menu to be shown for the given view (multiple views can show the context menu).
`final void`	`requestPermissions(String[] permissions, int requestCode)` This method is deprecated. use `registerForActivityResult(ActivityResultContract, ActivityResultCallback)` passing in a `ActivityResultContracts.RequestMultiplePermissions` object for the `ActivityResultContract` and handling the result in the `callback`.
`final FragmentActivity`	`requireActivity()` Return the `FragmentActivity` this fragment is currently associated with.
`final Bundle`	`requireArguments()` Return the arguments supplied when the fragment was instantiated.
`final Context`	`requireContext()` Return the `Context` this fragment is currently associated with.
`final FragmentManager`	`requireFragmentManager()` This method is deprecated. This has been renamed to `getParentFragmentManager()` to make it clear that you are accessing the FragmentManager that contains this Fragment and not the FragmentManager associated with child Fragments.
`final Object`	`requireHost()` Return the host object of this fragment.
`final Fragment`	`requireParentFragment()` Returns the parent Fragment containing this Fragment.
`final View`	`requireView()` Get the root view for the fragment's layout (the one returned by `onCreateView(LayoutInflater, ViewGroup, Bundle)`).
`void`	`setAllowEnterTransitionOverlap(boolean allow)` Sets whether the the exit transition and enter transition overlap or not.
`void`	`setAllowReturnTransitionOverlap(boolean allow)` Sets whether the the return transition and reenter transition overlap or not.
`void`	`setArguments(Bundle args)` Supply the construction arguments for this fragment.
`void`	`setEnterSharedElementCallback(SharedElementCallback callback)` When custom transitions are used with Fragments, the enter transition callback is called when this Fragment is attached or detached when not popping the back stack.
`void`	`setEnterTransition(Object transition)` Sets the Transition that will be used to move Views into the initial scene.
`void`	`setExitSharedElementCallback(SharedElementCallback callback)` When custom transitions are used with Fragments, the exit transition callback is called when this Fragment is attached or detached when popping the back stack.
`void`	`setExitTransition(Object transition)` Sets the Transition that will be used to move Views out of the scene when the fragment is removed, hidden, or detached when not popping the back stack.
`void`	`setHasOptionsMenu(boolean hasMenu)` Report that this fragment would like to participate in populating the options menu by receiving a call to `onCreateOptionsMenu(Menu, MenuInflater)` and related methods.
`void`	`setInitialSavedState(Fragment.SavedState state)` Set the initial saved state that this Fragment should restore itself from when first being constructed, as returned by `FragmentManager.saveFragmentInstanceState`.
`void`	`setMenuVisibility(boolean menuVisible)` Set a hint for whether this fragment's menu should be visible.
`void`	`setReenterTransition(Object transition)` Sets the Transition that will be used to move Views in to the scene when returning due to popping a back stack.
`void`	`setRetainInstance(boolean retain)` This method is deprecated. Instead of retaining the Fragment itself, use a non-retained Fragment and keep retained state in a ViewModel attached to that Fragment. The ViewModel's constructor and its onCleared() callback provide the signal for initial creation and final destruction of the retained state.
`void`	`setReturnTransition(Object transition)` Sets the Transition that will be used to move Views out of the scene when the Fragment is preparing to be removed, hidden, or detached because of popping the back stack.
`void`	`setSharedElementEnterTransition(Object transition)` Sets the Transition that will be used for shared elements transferred into the content Scene.
`void`	`setSharedElementReturnTransition(Object transition)` Sets the Transition that will be used for shared elements transferred back during a pop of the back stack.
`void`	`setTargetFragment(Fragment fragment, int requestCode)` This method is deprecated. Instead of using a target fragment to pass results, the fragment requesting a result should use `FragmentManager.setFragmentResultListener(String, LifecycleOwner, FragmentResultListener)` to register a `FragmentResultListener` with a `requestKey` using its `parent fragment manager`. The fragment delivering a result should then call `FragmentManager.setFragmentResult(String, Bundle)` using the same `requestKey`. Consider using `setArguments(Bundle)` to pass the `requestKey` if you need to support dynamic request keys.
`void`	`setUserVisibleHint(boolean isVisibleToUser)` This method is deprecated. If you are manually calling this method, use `FragmentTransaction.setMaxLifecycle(Fragment, Lifecycle.State)` instead. If overriding this method, behavior implemented when passing in `true` should be moved to `onResume()`, and behavior implemented when passing in `false` should be moved to `onPause()`.
`boolean`	`shouldShowRequestPermissionRationale(String permission)` Gets whether you should show UI with rationale before requesting a permission.
`void`	`startActivity(Intent intent)` Call `Activity.startActivity(Intent)` from the fragment's containing Activity.
`void`	`startActivity(Intent intent, Bundle options)` Call `Activity.startActivity(Intent, Bundle)` from the fragment's containing Activity.
`void`	`startActivityForResult(Intent intent, int requestCode)` This method is deprecated. use `registerForActivityResult(ActivityResultContract, ActivityResultCallback)` passing in a `ActivityResultContracts.StartActivityForResult` object for the `ActivityResultContract`.
`void`	`startActivityForResult(Intent intent, int requestCode, Bundle options)` This method is deprecated. use `registerForActivityResult(ActivityResultContract, ActivityResultCallback)` passing in a `ActivityResultContracts.StartActivityForResult` object for the `ActivityResultContract`.
`void`	`startIntentSenderForResult(IntentSender intent, int requestCode, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options)` This method is deprecated. use `registerForActivityResult(ActivityResultContract, ActivityResultCallback)` passing in a `ActivityResultContracts.StartIntentSenderForResult` object for the `ActivityResultContract`.
`void`	`startPostponedEnterTransition()` Begin postponed transitions after `postponeEnterTransition()` was called.
`String`	`toString()`
`void`	`unregisterForContextMenu(View view)` Prevents a context menu to be shown for the given view.

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

From interface


        
          android.content.ComponentCallbacks

`abstract void`	`onConfigurationChanged(Configuration arg0)`
`abstract void`	`onLowMemory()`

From interface


        
          android.view.View.OnCreateContextMenuListener

abstract void onCreateContextMenu(ContextMenu arg0, View arg1, ContextMenu.ContextMenuInfo arg2)

From interface


        
          androidx.lifecycle.LifecycleOwner


        abstract
        
        
        
        
        Lifecycle


      getLifecycle()

Returns the Lifecycle of the provider.

From interface


        
          androidx.lifecycle.ViewModelStoreOwner


        abstract
        
        
        
        
        ViewModelStore


      getViewModelStore()

Returns owned ViewModelStore

From interface


        
          androidx.lifecycle.HasDefaultViewModelProviderFactory


        abstract
        
        
        
        
        ViewModelProvider.Factory


      getDefaultViewModelProviderFactory()

Returns the default ViewModelProvider.Factory that should be used when no custom Factory is provided to the ViewModelProvider constructors.

From interface


        
          androidx.savedstate.SavedStateRegistryOwner


        abstract
        
        
        
        
        SavedStateRegistry


      getSavedStateRegistry()

Returns owned SavedStateRegistry

From interface


        
          androidx.activity.result.ActivityResultCaller

`abstract <I, O> ActivityResultLauncher<I>`	`registerForActivityResult(ActivityResultContract<I, O> contract, ActivityResultCallback<O> callback)` Register a request to `start an activity for result`, designated by the given `contract`.
`abstract <I, O> ActivityResultLauncher<I>`	`registerForActivityResult(ActivityResultContract<I, O> contract, ActivityResultRegistry registry, ActivityResultCallback<O> callback)` Register a request to `start an activity for result`, designated by the given `contract`.

Constants

BG_DARK

public static final int BG_DARK

A dark translucent background.

Constant Value: 1 (0x00000001)

BG_LIGHT

public static final int BG_LIGHT

A light translucent background.

Constant Value: 2 (0x00000002)

BG_NONE

public static final int BG_NONE

No background.

Constant Value: 0 (0x00000000)

Public constructors

PlaybackSupportFragment

public PlaybackSupportFragment ()

Public methods

fadeOut

public void fadeOut ()

This method is deprecated.
Call hideControlsOverlay(boolean)

Fades out the playback overlay immediately.

getAdapter

public ObjectAdapter getAdapter ()

Returns
`ObjectAdapter`

getBackgroundType

public int getBackgroundType ()

Returns the background type.

Returns
`int`

getProgressBarManager

public ProgressBarManager getProgressBarManager ()

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

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

hideControlsOverlay

public void hideControlsOverlay (boolean runAnimation)

Hide controls overlay.

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

isControlsOverlayAutoHideEnabled

public boolean isControlsOverlayAutoHideEnabled ()

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

Returns
`boolean`

isControlsOverlayVisible

public boolean isControlsOverlayVisible ()

Returns true if controls overlay is visible, false otherwise.

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

See also:

isFadingEnabled

public boolean isFadingEnabled ()

This method is deprecated.
Uses isControlsOverlayAutoHideEnabled()

Returns
`boolean`

isShowOrHideControlsOverlayOnUserInteraction

public boolean isShowOrHideControlsOverlayOnUserInteraction ()

Returns true if showing and auto-hiding controls when user interacts; false otherwise.

Returns
`boolean`

notifyPlaybackRowChanged

public void notifyPlaybackRowChanged ()

Updates the ui when the row data changes.

onCreate

public void onCreate (Bundle savedInstanceState)

Called to do initial creation of a fragment. This is called after onAttach(Activity) and before onCreateView(LayoutInflater, ViewGroup, Bundle).

Note that this can be called while the fragment's activity is still in the process of being created. As such, you can not rely on things like the activity's content view hierarchy being initialized at this point. If you want to do work once the activity itself is created, add a LifecycleObserver on the activity's Lifecycle, removing it when it receives the Lifecycle.State.CREATED callback.

Any restored child fragments will be created before the base Fragment.onCreate method returns.

Parameters
`savedInstanceState`	`Bundle`: If the fragment is being re-created from a previous saved state, this is the state.

onCreateView

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

Called to have the fragment instantiate its user interface view. This is optional, and non-graphical fragments can return null. This will be called between onCreate(Bundle) and onViewCreated(View, Bundle).

A default View can be returned by calling Fragment(int) in your constructor. Otherwise, this method returns null.

It is recommended to only inflate the layout in this method and move logic that operates on the returned View to onViewCreated(View, Bundle).

If you return a View from here, you will later be called in onDestroyView() when the view is being released.

Parameters
`inflater`	`LayoutInflater`: The LayoutInflater object that can be used to inflate any views in the fragment,
`container`	`ViewGroup`: If non-null, this is the parent view that the fragment's UI should be attached to. The fragment should not add the view itself, but this can be used to generate the LayoutParams of the view.
`savedInstanceState`	`Bundle`: If non-null, this fragment is being re-constructed from a previous saved state as given here.

Returns
`View`	Return the View for the fragment's UI, or null.

onDestroy

public void onDestroy ()

Called when the fragment is no longer in use. This is called after onStop() and before onDetach().

onDestroyView

public void onDestroyView ()

Called when the view previously created by onCreateView(LayoutInflater, ViewGroup, Bundle) has been detached from the fragment. The next time the fragment needs to be displayed, a new view will be created. This is called after onStop() and before onDestroy(). It is called regardless of whether onCreateView(LayoutInflater, ViewGroup, Bundle) returned a non-null view. Internally it is called after the view's state has been saved but before it has been removed from its parent.

onPause

public void onPause ()

Called when the Fragment is no longer resumed. This is generally tied to Activity.onPause of the containing Activity's lifecycle.

onResume

public void onResume ()

Called when the fragment is visible to the user and actively running. This is generally tied to Activity.onResume of the containing Activity's lifecycle.

onStart

public void onStart ()

Called when the Fragment is visible to the user. This is generally tied to Activity.onStart of the containing Activity's lifecycle.

onStop

public void onStop ()

Called when the Fragment is no longer started. This is generally tied to Activity.onStop of the containing Activity's lifecycle.

onViewCreated

public void onViewCreated (View view, 
                Bundle savedInstanceState)

Called immediately after onCreateView(LayoutInflater, ViewGroup, Bundle) has returned, but before any saved state has been restored in to the view. This gives subclasses a chance to initialize themselves once they know their view hierarchy has been completely created. The fragment's view hierarchy is not however attached to its parent at this point.

Parameters
`view`	`View`: The View returned by `onCreateView(LayoutInflater, ViewGroup, Bundle)`.
`savedInstanceState`	`Bundle`: If non-null, this fragment is being re-constructed from a previous saved state as given here.

public void setAdapter (ObjectAdapter adapter)

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

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

setBackgroundType

public void setBackgroundType (int type)

Sets the background type.

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

setControlsOverlayAutoHideEnabled

public 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. User interaction will kill the timer, next time fragment is resumed, the timer will be started again if isControlsOverlayAutoHideEnabled() is true.

In most cases app should not directly call setControlsOverlayAutoHideEnabled() as it's called by PlaybackBaseControlGlue on play or pause.

Parameters
`enabled`	`boolean`

setFadingEnabled

public void setFadingEnabled (boolean enabled)

This method is deprecated.
Uses setControlsOverlayAutoHideEnabled(boolean)

Parameters
`enabled`	`boolean`

setHostCallback

public void setHostCallback (PlaybackGlueHost.HostCallback hostCallback)

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

Parameters
`hostCallback`	`PlaybackGlueHost.HostCallback`

public void setOnItemViewClickedListener (BaseOnItemViewClickedListener listener)

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

Parameters
`listener`	`BaseOnItemViewClickedListener`

public void setOnItemViewSelectedListener (BaseOnItemViewSelectedListener listener)

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

Parameters
`listener`	`BaseOnItemViewSelectedListener`

setOnKeyInterceptListener

public final void setOnKeyInterceptListener (View.OnKeyListener handler)

Sets the input event handler.

Parameters
`handler`	`View.OnKeyListener`

public void setOnPlaybackItemViewClickedListener (BaseOnItemViewClickedListener listener)

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

Parameters
`listener`	`BaseOnItemViewClickedListener`

public void setPlaybackRow (Row row)

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

Parameters
`row`	`Row`: The row that represents the playback.

public void setPlaybackRowPresenter (PlaybackRowPresenter presenter)

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

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

public void setPlaybackSeekUiClient (PlaybackSeekUi.Client client)

Interface to be implemented by UI widget to support PlaybackSeekUi.

Parameters
`client`	`PlaybackSeekUi.Client`

setSelectedPosition

public void setSelectedPosition (int position)

Sets the selected row position with smooth animation.

Parameters
`position`	`int`

setSelectedPosition

public void setSelectedPosition (int position, 
                boolean smooth)

Sets the selected row position.

Parameters
`position`	`int`
`smooth`	`boolean`

setShowOrHideControlsOverlayOnUserInteraction

public void setShowOrHideControlsOverlayOnUserInteraction (boolean showOrHideControlsOverlayOnUserInteraction)

Enables or disables showing and auto-hiding controls when user interacts. Enabled by default. Auto-hide timer length is defined by R.attr.playbackControlsAutoHideTickleTimeout.

Parameters
`showOrHideControlsOverlayOnUserInteraction`	`boolean`

showControlsOverlay

public void showControlsOverlay (boolean runAnimation)

Show controls overlay.

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

tickle

public void tickle ()

Tickles the playback controls. Fades in the view if it was faded out. tickle() will kill and re-create a timer if R.attr.playbackControlsAutoHideTickleTimeout is positive.

In most cases app does not need call tickle() as it's automatically called on user interactions.

Protected methods

onBufferingStateChanged

protected void onBufferingStateChanged (boolean start)

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

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

onError

protected void onError (int errorCode, 
                CharSequence errorMessage)

Called when media has error. App may override.

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

onVideoSizeChanged

protected void onVideoSizeChanged (int videoWidth, 
                int videoHeight)

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

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