PlaybackFragment

Added in 1.1.0

Deprecated in 1.1.0

Kotlin |Java

class PlaybackFragment : Fragment

kotlin.Any
↳	android.app.Fragment
	↳	androidx.leanback.app.PlaybackFragment

Known direct subclasses

VideoFragment

VideoFragment

This class is deprecated.

use VideoSupportFragment

A fragment for displaying playback controls and related content.

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

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

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 or hideControlsOverlay 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 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 playbackControlsAutoHideTickleTimeout. To disable the fade in and fade out behavior, call setShowOrHideControlsOverlayOnUserInteraction with false.

Summary

Constants
`const Int`	`BG_DARK = 1` A dark translucent background.
`const Int`	`BG_LIGHT = 2` A light translucent background.
`const Int`	`BG_NONE = 0` No background.

Public constructors
`PlaybackFragment()`

Public functions
`Unit`	`fadeOut()` This function is deprecated. Call `hideControlsOverlay`
`ObjectAdapter!`	`getAdapter()`
`Int`	`getBackgroundType()` Returns the background type.
`ProgressBarManager!`	`getProgressBarManager()` Returns the ProgressBarManager that will show or hide progress bar in `onBufferingStateChanged`.
`Unit`	`hideControlsOverlay(runAnimation: Boolean)` 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 function is deprecated. Uses `isControlsOverlayAutoHideEnabled`
`Boolean`	`isShowOrHideControlsOverlayOnUserInteraction()` Returns true if showing and auto-hiding controls when user interacts; false otherwise.
`Unit`	`notifyPlaybackRowChanged()` Updates the ui when the row data changes.
`Unit`	`onCreate(savedInstanceState: Bundle!)` This function is deprecated.
`View?`	`onCreateView( inflater: LayoutInflater!, container: ViewGroup?, savedInstanceState: Bundle! )` This function is deprecated.
`Unit`	`onDestroy()` This function is deprecated.
`Unit`	`onDestroyView()` This function is deprecated.
`Unit`	`onPause()` This function is deprecated.
`Unit`	`onResume()` This function is deprecated.
`Unit`	`onStart()` This function is deprecated.
`Unit`	`onStop()` This function is deprecated.
`Unit`	`onViewCreated(view: View, savedInstanceState: Bundle?)` This function is deprecated.
`Unit`	`setAdapter(adapter: ObjectAdapter!)` Sets the list of rows for the fragment.
`Unit`	`setBackgroundType(type: Int)` Sets the background type.
`Unit`	`setControlsOverlayAutoHideEnabled(enabled: Boolean)` Enables or disables auto hiding controls overlay after a short delay fragment is resumed.
`Unit`	`setFadingEnabled(enabled: Boolean)` This function is deprecated. Uses `setControlsOverlayAutoHideEnabled`
`Unit`	`setHostCallback(hostCallback: PlaybackGlueHost.HostCallback!)` Sets the `PlaybackGlueHost.HostCallback`.
`Unit`	`setOnItemViewClickedListener(listener: BaseOnItemViewClickedListener!)` This listener is called every time there is a click in `RowsFragment`.
`Unit`	`setOnItemViewSelectedListener(listener: BaseOnItemViewSelectedListener!)` This listener is called every time there is a selection in `RowsFragment`.
`Unit`	`setOnKeyInterceptListener(handler: View.OnKeyListener!)` Sets the input event handler.
`Unit`	`setOnPlaybackItemViewClickedListener( listener: BaseOnItemViewClickedListener! )` Sets the `BaseOnItemViewClickedListener` that would be invoked for clicks only on `androidx.leanback.widget.PlaybackRowPresenter.ViewHolder`.
`Unit`	`setPlaybackRow(row: Row!)` Sets the playback row for the playback controls.
`Unit`	`setPlaybackRowPresenter(presenter: PlaybackRowPresenter!)` Sets the presenter for rendering the playback row set by `setPlaybackRow`.
`Unit`	`setPlaybackSeekUiClient(client: PlaybackSeekUi.Client!)` Interface to be implemented by UI widget to support PlaybackSeekUi.
`Unit`	`setSelectedPosition(position: Int)` Sets the selected row position with smooth animation.
`Unit`	`setSelectedPosition(position: Int, smooth: Boolean)` Sets the selected row position.
`Unit`	`setShowOrHideControlsOverlayOnUserInteraction( showOrHideControlsOverlayOnUserInteraction: Boolean )` Enables or disables showing and auto-hiding controls when user interacts.
`Unit`	`showControlsOverlay(runAnimation: Boolean)` Show controls overlay.
`Unit`	`tickle()` Tickles the playback controls.

Protected functions
`Unit`	`onBufferingStateChanged(start: Boolean)` Called when media has start or stop buffering.
`Unit`	`onError(errorCode: Int, errorMessage: CharSequence!)` Called when media has error.
`Unit`	`onVideoSizeChanged(videoWidth: Int, videoHeight: Int)` Called when size of the video changes.

Inherited Constants

From android.content.ComponentCallbacks2

`const Int`	`TRIM_MEMORY_BACKGROUND = 40`
`const Int`	`TRIM_MEMORY_COMPLETE = 80`
`const Int`	`TRIM_MEMORY_MODERATE = 60`
`const Int`	`TRIM_MEMORY_RUNNING_CRITICAL = 15`
`const Int`	`TRIM_MEMORY_RUNNING_LOW = 10`
`const Int`	`TRIM_MEMORY_RUNNING_MODERATE = 5`
`const Int`	`TRIM_MEMORY_UI_HIDDEN = 20`

Inherited functions

From android.app.Fragment

`Unit`	`dump( prefix: String!, fd: FileDescriptor!, writer: PrintWriter!, args: Array<String!>! )` This function is deprecated.
`Boolean`	`equals(o: Any!)` This function is deprecated.
`Activity!`	`getActivity()` This function is deprecated.
`Boolean`	`getAllowEnterTransitionOverlap()` This function is deprecated.
`Boolean`	`getAllowReturnTransitionOverlap()` This function is deprecated.
`Bundle!`	`getArguments()` This function is deprecated.
`FragmentManager!`	`getChildFragmentManager()` This function is deprecated.
`Context!`	`getContext()` This function is deprecated.
`Transition!`	`getEnterTransition()` This function is deprecated.
`Transition!`	`getExitTransition()` This function is deprecated.
`FragmentManager!`	`getFragmentManager()` This function is deprecated.
`Any!`	`getHost()` This function is deprecated.
`Int`	`getId()` This function is deprecated.
`LayoutInflater!`	`getLayoutInflater()` This function is deprecated.
`LoaderManager!`	`getLoaderManager()` This function is deprecated.
`Fragment!`	`getParentFragment()` This function is deprecated.
`Transition!`	`getReenterTransition()` This function is deprecated.
`Resources!`	`getResources()` This function is deprecated.
`Boolean`	`getRetainInstance()` This function is deprecated.
`Transition!`	`getReturnTransition()` This function is deprecated.
`Transition!`	`getSharedElementEnterTransition()` This function is deprecated.
`Transition!`	`getSharedElementReturnTransition()` This function is deprecated.
`String!`	`getString(resId: Int)` This function is deprecated.
`String!`	`getTag()` This function is deprecated.
`Fragment!`	`getTargetFragment()` This function is deprecated.
`Int`	`getTargetRequestCode()` This function is deprecated.
`CharSequence!`	`getText(resId: Int)` This function is deprecated.
`Boolean`	`getUserVisibleHint()` This function is deprecated.
`View!`	`getView()` This function is deprecated.
`Int`	`hashCode()` This function is deprecated.
`java-static Fragment!`	`instantiate(context: Context!, fname: String!)` This function is deprecated.
`Boolean`	`isAdded()` This function is deprecated.
`Boolean`	`isDetached()` This function is deprecated.
`Boolean`	`isHidden()` This function is deprecated.
`Boolean`	`isInLayout()` This function is deprecated.
`Boolean`	`isRemoving()` This function is deprecated.
`Boolean`	`isResumed()` This function is deprecated.
`Boolean`	`isStateSaved()` This function is deprecated.
`Boolean`	`isVisible()` This function is deprecated.
`Unit`	`onActivityCreated(savedInstanceState: Bundle!)` This function is deprecated.
`Unit`	`onActivityResult(requestCode: Int, resultCode: Int, data: Intent!)` This function is deprecated.
`Unit`	`onAttach(context: Context!)` This function is deprecated.
`Unit`	`onAttachFragment(childFragment: Fragment!)` This function is deprecated.
`Unit`	`onConfigurationChanged(newConfig: Configuration!)` This function is deprecated.
`Boolean`	`onContextItemSelected(item: MenuItem!)` This function is deprecated.
`Animator!`	`onCreateAnimator(transit: Int, enter: Boolean, nextAnim: Int)` This function is deprecated.
`Unit`	`onCreateContextMenu( menu: ContextMenu!, v: View!, menuInfo: ContextMenu.ContextMenuInfo! )` This function is deprecated.
`Unit`	`onCreateOptionsMenu(menu: Menu!, inflater: MenuInflater!)` This function is deprecated.
`Unit`	`onDestroyOptionsMenu()` This function is deprecated.
`Unit`	`onDetach()` This function is deprecated.
`LayoutInflater!`	`onGetLayoutInflater(savedInstanceState: Bundle!)` This function is deprecated.
`Unit`	`onHiddenChanged(hidden: Boolean)` This function is deprecated.
`Unit`	`onInflate(attrs: AttributeSet!, savedInstanceState: Bundle!)` This function is deprecated.
`Unit`	`onLowMemory()` This function is deprecated.
`Unit`	`onMultiWindowModeChanged( isInMultiWindowMode: Boolean, newConfig: Configuration! )` This function is deprecated.
`Boolean`	`onOptionsItemSelected(item: MenuItem!)` This function is deprecated.
`Unit`	`onOptionsMenuClosed(menu: Menu!)` This function is deprecated.
`Unit`	`onPictureInPictureModeChanged( isInPictureInPictureMode: Boolean, newConfig: Configuration! )` This function is deprecated.
`Unit`	`onPrepareOptionsMenu(menu: Menu!)` This function is deprecated.
`Unit`	`onRequestPermissionsResult( requestCode: Int, permissions: Array<String!>!, grantResults: IntArray! )` This function is deprecated.
`Unit`	`onSaveInstanceState(outState: Bundle!)` This function is deprecated.
`Unit`	`onTrimMemory(level: Int)` This function is deprecated.
`Unit`	`onViewStateRestored(savedInstanceState: Bundle!)` This function is deprecated.
`Unit`	`postponeEnterTransition()` This function is deprecated.
`Unit`	`registerForContextMenu(view: View!)` This function is deprecated.
`Unit`	`requestPermissions(permissions: Array<String!>!, requestCode: Int)` This function is deprecated.
`Unit`	`setAllowEnterTransitionOverlap(allow: Boolean)` This function is deprecated.
`Unit`	`setAllowReturnTransitionOverlap(allow: Boolean)` This function is deprecated.
`Unit`	`setArguments(args: Bundle!)` This function is deprecated.
`Unit`	`setEnterSharedElementCallback(callback: SharedElementCallback!)` This function is deprecated.
`Unit`	`setEnterTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setExitSharedElementCallback(callback: SharedElementCallback!)` This function is deprecated.
`Unit`	`setExitTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setHasOptionsMenu(hasMenu: Boolean)` This function is deprecated.
`Unit`	`setInitialSavedState(state: Fragment.SavedState!)` This function is deprecated.
`Unit`	`setMenuVisibility(menuVisible: Boolean)` This function is deprecated.
`Unit`	`setReenterTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setRetainInstance(retain: Boolean)` This function is deprecated.
`Unit`	`setReturnTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setSharedElementEnterTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setSharedElementReturnTransition(transition: Transition!)` This function is deprecated.
`Unit`	`setTargetFragment(fragment: Fragment!, requestCode: Int)` This function is deprecated.
`Unit`	`setUserVisibleHint(isVisibleToUser: Boolean)` This function is deprecated.
`Boolean`	`shouldShowRequestPermissionRationale(permission: String!)` This function is deprecated.
`Unit`	`startActivity(intent: Intent!)` This function is deprecated.
`Unit`	`startActivityForResult(intent: Intent!, requestCode: Int)` This function is deprecated.
`Unit`	`startIntentSenderForResult( intent: IntentSender!, requestCode: Int, fillInIntent: Intent!, flagsMask: Int, flagsValues: Int, extraFlags: Int, options: Bundle! )` This function is deprecated.
`Unit`	`startPostponedEnterTransition()` This function is deprecated.
`String!`	`toString()` This function is deprecated.
`Unit`	`unregisterForContextMenu(view: View!)` This function is deprecated.

Constants

BG_DARK

Added in 1.1.0

Deprecated in 1.1.0

const val BG_DARK = 1: Int

A dark translucent background.

BG_LIGHT

Added in 1.1.0

Deprecated in 1.1.0

const val BG_LIGHT = 2: Int

A light translucent background.

BG_NONE

Added in 1.1.0

Deprecated in 1.1.0

const val BG_NONE = 0: Int

No background.

Public constructors

PlaybackFragment

Added in 1.1.0

Deprecated in 1.1.0

PlaybackFragment()

Public functions

fadeOut

Added in 1.1.0

Deprecated in 1.1.0

fun fadeOut(): Unit

Fades out the playback overlay immediately.

getAdapter

Added in 1.1.0

Deprecated in 1.1.0

fun getAdapter(): ObjectAdapter!

getBackgroundType

Added in 1.1.0

Deprecated in 1.1.0

fun getBackgroundType(): Int

Returns the background type.

getProgressBarManager

Added in 1.1.0

Deprecated in 1.1.0

fun getProgressBarManager(): ProgressBarManager!

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

Returns
`ProgressBarManager!`	The ProgressBarManager that will show or hide progress bar in `onBufferingStateChanged`.

hideControlsOverlay

Added in 1.1.0

Deprecated in 1.1.0

fun hideControlsOverlay(runAnimation: Boolean): Unit

Hide controls overlay.

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

isControlsOverlayAutoHideEnabled

Added in 1.1.0

Deprecated in 1.1.0

fun isControlsOverlayAutoHideEnabled(): Boolean

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

isControlsOverlayVisible

Added in 1.1.0

Deprecated in 1.1.0

fun isControlsOverlayVisible(): Boolean

Returns true if controls overlay is visible, false otherwise.

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

See also
`showControlsOverlay`
`hideControlsOverlay`

isFadingEnabled

Added in 1.1.0

Deprecated in 1.1.0

fun isFadingEnabled(): Boolean

isShowOrHideControlsOverlayOnUserInteraction

Added in 1.1.0

Deprecated in 1.1.0

fun isShowOrHideControlsOverlayOnUserInteraction(): Boolean

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

notifyPlaybackRowChanged

Added in 1.1.0

Deprecated in 1.1.0

fun notifyPlaybackRowChanged(): Unit

Updates the ui when the row data changes.

onCreate

Added in 1.1.0

Deprecated in 1.1.0

fun onCreate(savedInstanceState: Bundle!): Unit

onCreateView

Added in 1.1.0

Deprecated in 1.1.0

fun onCreateView(
    inflater: LayoutInflater!,
    container: ViewGroup?,
    savedInstanceState: Bundle!
): View?

onDestroy

Added in 1.1.0

Deprecated in 1.1.0

fun onDestroy(): Unit

onDestroyView

Added in 1.1.0

Deprecated in 1.1.0

fun onDestroyView(): Unit

onPause

Added in 1.1.0

Deprecated in 1.1.0

fun onPause(): Unit

onResume

Added in 1.1.0

Deprecated in 1.1.0

fun onResume(): Unit

onStart

Added in 1.1.0

Deprecated in 1.1.0

fun onStart(): Unit

onStop

Added in 1.1.0

Deprecated in 1.1.0

fun onStop(): Unit

onViewCreated

Added in 1.1.0

Deprecated in 1.1.0

fun onViewCreated(view: View, savedInstanceState: Bundle?): Unit

Added in 1.1.0

Deprecated in 1.1.0

fun setAdapter(adapter: ObjectAdapter!): Unit

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

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

setBackgroundType

Added in 1.1.0

Deprecated in 1.1.0

fun setBackgroundType(type: Int): Unit

Sets the background type.

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

setControlsOverlayAutoHideEnabled

Added in 1.1.0

Deprecated in 1.1.0

fun setControlsOverlayAutoHideEnabled(enabled: Boolean): Unit

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 androidx.leanback.media.PlaybackBaseControlGlue on play or pause.

setFadingEnabled

Added in 1.1.0

Deprecated in 1.1.0

fun setFadingEnabled(enabled: Boolean): Unit

setHostCallback

Added in 1.1.0

Deprecated in 1.1.0

fun setHostCallback(hostCallback: PlaybackGlueHost.HostCallback!): Unit

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

Added in 1.1.0

Deprecated in 1.1.0

fun setOnItemViewClickedListener(listener: BaseOnItemViewClickedListener!): Unit

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

Added in 1.1.0

Deprecated in 1.1.0

fun setOnItemViewSelectedListener(listener: BaseOnItemViewSelectedListener!): Unit

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

setOnKeyInterceptListener

Added in 1.1.0

Deprecated in 1.1.0

fun setOnKeyInterceptListener(handler: View.OnKeyListener!): Unit

Sets the input event handler.

Added in 1.1.0

Deprecated in 1.1.0

fun setOnPlaybackItemViewClickedListener(
    listener: BaseOnItemViewClickedListener!
): Unit

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

Added in 1.1.0

Deprecated in 1.1.0

fun setPlaybackRow(row: Row!): Unit

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.

Added in 1.1.0

Deprecated in 1.1.0

fun setPlaybackRowPresenter(presenter: PlaybackRowPresenter!): Unit

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

Parameters
`presenter: PlaybackRowPresenter!`	Presenter used to render `setPlaybackRow`.

Added in 1.1.0

Deprecated in 1.1.0

fun setPlaybackSeekUiClient(client: PlaybackSeekUi.Client!): Unit

Interface to be implemented by UI widget to support PlaybackSeekUi.

setSelectedPosition

Added in 1.1.0

Deprecated in 1.1.0

fun setSelectedPosition(position: Int): Unit

Sets the selected row position with smooth animation.

setSelectedPosition

Added in 1.1.0

Deprecated in 1.1.0

fun setSelectedPosition(position: Int, smooth: Boolean): Unit

Sets the selected row position.

setShowOrHideControlsOverlayOnUserInteraction

Added in 1.1.0

Deprecated in 1.1.0

fun setShowOrHideControlsOverlayOnUserInteraction(
    showOrHideControlsOverlayOnUserInteraction: Boolean
): Unit

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

showControlsOverlay

Added in 1.1.0

Deprecated in 1.1.0

fun showControlsOverlay(runAnimation: Boolean): Unit

Show controls overlay.

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

tickle

Added in 1.1.0

Deprecated in 1.1.0

fun tickle(): Unit

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

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

Protected functions

onBufferingStateChanged

Added in 1.1.0

Deprecated in 1.1.0

protected fun onBufferingStateChanged(start: Boolean): Unit

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

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

onError

Added in 1.1.0

Deprecated in 1.1.0

protected fun onError(errorCode: Int, errorMessage: CharSequence!): Unit

Called when media has error. App may override.

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

onVideoSizeChanged

Added in 1.1.0

Deprecated in 1.1.0

protected fun onVideoSizeChanged(videoWidth: Int, videoHeight: Int): Unit

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

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