VideoFragment

Kotlin |Java

open class VideoFragment : PlaybackFragment

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

Subclass of PlaybackFragment that is responsible for providing a SurfaceView and rendering video. See base class PlaybackFragment for how to setup controls and how to customize showing/hiding controls.

Summary

Inherited constants

From class PlaybackFragment

Int

BG_DARK

A dark translucent background.

Int

BG_LIGHT

A light translucent background.

Int

BG_NONE

No background.

Public constructors
`<init>()` Subclass of `PlaybackFragment` that is responsible for providing a `SurfaceView` and rendering video.

Public methods
open SurfaceView!	`getSurfaceView()` Returns the surface view.
open View!	`onCreateView(inflater: LayoutInflater!, container: ViewGroup!, savedInstanceState: Bundle!)`
open Unit	`onDestroyView()`
open Unit	`setSurfaceHolderCallback(callback: Callback!)` Adds `SurfaceHolder.Callback` to `android.view.SurfaceView`.

Protected methods
open Unit	`onVideoSizeChanged(width: Int, height: Int)`

Inherited functions

From class PlaybackFragment

`Unit`	`fadeOut()` Fades out the playback overlay immediately.
`ObjectAdapter!`	`getAdapter()`
`Int`	`getBackgroundType()` Returns the background type.
`ProgressBarManager!`	`getProgressBarManager()` Returns the ProgressBarManager that will show or hide progress bar in `onBufferingStateChanged(boolean)`.
`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()`
`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`	`onBufferingStateChanged(start: Boolean)` Called when media has start or stop buffering. App may override. The default initial state is not buffering.
`Unit`	`onCreate(savedInstanceState: Bundle!)`
`Unit`	`onDestroy()`
`Unit`	`onError(errorCode: Int, errorMessage: CharSequence!)` Called when media has error. App may override.
`Unit`	`onPause()`
`Unit`	`onResume()`
`Unit`	`onStart()`
`Unit`	`onStop()`
`Unit`	`onViewCreated(@NonNull view: View, @Nullable savedInstanceState: Bundle?)`
`Unit`	`setAdapter(adapter: ObjectAdapter!)` 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.
`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. 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.
`Unit`	`setFadingEnabled(enabled: Boolean)`
`Unit`	`setHostCallback(hostCallback: PlaybackGlueHost.HostCallback!)` Sets the `PlaybackGlueHost.HostCallback`. Implementor of this interface will take appropriate actions to take action when the hosting fragment starts/stops processing.
`Unit`	`setOnItemViewClickedListener(listener: BaseOnItemViewClickedListener<Any!>!)` 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.
`Unit`	`setOnItemViewSelectedListener(listener: BaseOnItemViewSelectedListener<Any!>!)` 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.
`Unit`	`setOnKeyInterceptListener(handler: OnKeyListener!)` Sets the input event handler.
`Unit`	`setOnPlaybackItemViewClickedListener(listener: BaseOnItemViewClickedListener<Any!>!)` 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. The row will be set as first element of adapter if the adapter is `ArrayObjectAdapter` or `SparseArrayObjectAdapter`.
`Unit`	`setPlaybackRowPresenter(presenter: PlaybackRowPresenter!)` 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`.
`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. Enabled by default. Auto-hide timer length is defined by R.attr#playbackControlsAutoHideTickleTimeout.
`Unit`	`showControlsOverlay(runAnimation: Boolean)` Show controls overlay.
`Unit`	`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.

Public constructors

<init>

VideoFragment()

Deprecated: use VideoSupportFragment

Public methods

getSurfaceView

open fun getSurfaceView(): SurfaceView!

Returns the surface view.

onCreateView

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

onDestroyView

open fun onDestroyView(): Unit

setSurfaceHolderCallback

open fun setSurfaceHolderCallback(callback: Callback!): Unit

Adds SurfaceHolder.Callback to android.view.SurfaceView.

Protected methods

onVideoSizeChanged

protected open fun onVideoSizeChanged(
    width: Int, 
    height: Int
): Unit