PlaybackSupportFragment

open class PlaybackSupportFragment : Fragment
kotlin.Any
   ↳ androidx.fragment.app.Fragment
   ↳ androidx.leanback.app.PlaybackSupportFragment

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).

Auto hide controls upon playing: best practice is calling setControlsOverlayAutoHideEnabled(boolean) upon play/pause. Theme attribute R.attr#playbackControlsAutoHideTimeout controls how long auto-hide will wait after media starts playing. The auto hiding timer will be cancelled upon tickle() triggered by input event. By default fragment does not auto hide controls after user interaction. To enable it: set theme attribute R.attr#playbackControlsAutoHideTickleTimeout, an auto hide timer will be created when tickle() is triggered by input event.

Summary

Constants
static Int

No background.

static Int

A dark translucent background.

static Int

A light translucent background.

Public constructors

Public methods
open ObjectAdapter!

open Unit

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

open Unit

open Unit

Fades out the playback overlay immediately.

open Unit

Interface to be implemented by UI widget to support PlaybackSeekUi.

open Unit

Sets the background type.

open Unit

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

open Unit

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

open Boolean

Returns true if controls overlay is visible, false otherwise.

open Unit

Sets the selected row position with smooth animation.

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

Sets the selected row position.

open Unit

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

open Boolean

open ProgressBarManager!

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

open Unit

Sets the PlaybackGlueHost.HostCallback.

open Boolean

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

open Unit

open Unit

Show controls overlay.

open Unit
onViewCreated(@NonNull view: View, @Nullable savedInstanceState: Bundle?)

open Int

Returns the background type.

open Unit
onCreate(savedInstanceState: Bundle?)

open Unit

open Unit

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

open Unit

Sets the playback row for the playback controls.

open Unit

Sets the list of rows for the fragment.

open Unit

open Unit

Updates the ui when the row data changes.

open Unit

Unit

Sets the input event handler.

open Unit

open Unit

Tickles the playback controls.

open Unit

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

open Unit

Hide controls overlay.

Protected methods
open Unit
onError(errorCode: Int, errorMessage: CharSequence!)

Called when media has error.

open Unit
onVideoSizeChanged(videoWidth: Int, videoHeight: Int)

Called when size of the video changes.

open Unit

Called when media has start or stop buffering.

Inherited functions

Constants

BG_NONE

static val BG_NONE: Int

No background.

Value: 0

BG_DARK

static val BG_DARK: Int

A dark translucent background.

Value: 1

BG_LIGHT

static val BG_LIGHT: Int

A light translucent background.

Value: 2

Public constructors

<init>

PlaybackSupportFragment()

Public methods

getAdapter

open fun getAdapter(): ObjectAdapter!

setOnItemViewClickedListener

open fun setOnItemViewClickedListener(listener: BaseOnItemViewClickedListener<Any!>!): Unit

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.

onPause

open fun onPause(): Unit

fadeOut

open fun fadeOut(): Unit

Fades out the playback overlay immediately.

setPlaybackSeekUiClient

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

Interface to be implemented by UI widget to support PlaybackSeekUi.

setBackgroundType

open fun setBackgroundType(type: Int): Unit

Sets the background type.

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

setOnPlaybackItemViewClickedListener

open fun setOnPlaybackItemViewClickedListener(listener: BaseOnItemViewClickedListener<Any!>!): Unit

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

setOnItemViewSelectedListener

open fun setOnItemViewSelectedListener(listener: BaseOnItemViewSelectedListener<Any!>!): Unit

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.

isControlsOverlayVisible

open fun isControlsOverlayVisible(): Boolean

Returns true if controls overlay is visible, false otherwise.

Return
Boolean: True if controls overlay is visible, false otherwise.

setSelectedPosition

open fun setSelectedPosition(position: Int): Unit

Sets the selected row position with smooth animation.

setSelectedPosition

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

Sets the selected row position.

setControlsOverlayAutoHideEnabled

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

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

isFadingEnabled

open fun isFadingEnabled(): Boolean

getProgressBarManager

open fun getProgressBarManager(): ProgressBarManager!

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

Return
ProgressBarManager!: The ProgressBarManager that will show or hide progress bar in onBufferingStateChanged(boolean).

setHostCallback

open 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.

isControlsOverlayAutoHideEnabled

open fun isControlsOverlayAutoHideEnabled(): Boolean

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

onDestroy

open fun onDestroy(): Unit

showControlsOverlay

open fun showControlsOverlay(runAnimation: Boolean): Unit

Show controls overlay.

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

onViewCreated

open fun onViewCreated(@NonNull view: View, @Nullable savedInstanceState: Bundle?): Unit

getBackgroundType

open fun getBackgroundType(): Int

Returns the background type.

onCreate

open fun onCreate(savedInstanceState: Bundle?): Unit

onStart

open fun onStart(): Unit

onResume

open fun onResume(): Unit

onCreateView

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

setPlaybackRow

open 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.

setAdapter

open fun setAdapter(adapter: ObjectAdapter!): Unit

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.

setFadingEnabled

open fun setFadingEnabled(enabled: Boolean): Unit

notifyPlaybackRowChanged

open fun notifyPlaybackRowChanged(): Unit

Updates the ui when the row data changes.

onDestroyView

open fun onDestroyView(): Unit

setOnKeyInterceptListener

fun setOnKeyInterceptListener(handler: OnKeyListener!): Unit

Sets the input event handler.

onStop

open fun onStop(): Unit

tickle

open fun tickle(): Unit

Tickles the playback controls. Fades in the view if it was faded out. tickle() will also kill the timer created by setControlsOverlayAutoHideEnabled(boolean). When next time fragment is resumed, the timer will be started again if isControlsOverlayAutoHideEnabled() is true. The timer will also be restarted if app sets a positive value on theme attribute R.attr#playbackControlsAutoHideTickleTimeout.

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

setPlaybackRowPresenter

open fun setPlaybackRowPresenter(presenter: PlaybackRowPresenter!): Unit

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).

hideControlsOverlay

open fun hideControlsOverlay(runAnimation: Boolean): Unit

Hide controls overlay.

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

Protected methods

onError

protected open 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 Int: Optional error message for specific implementation.

onVideoSizeChanged

protected open 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

onBufferingStateChanged

protected open 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.