VideoFragment

Added in 1.1.0

Deprecated in 1.1.0

Kotlin |Java

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

Public constructors
`VideoFragment()`

Public functions
`SurfaceView!`	`getSurfaceView()` Returns the surface view.
`View?`	`onCreateView( inflater: LayoutInflater!, container: ViewGroup?, savedInstanceState: Bundle! )` This function is deprecated.
`Unit`	`onDestroyView()` This function is deprecated.
`Unit`	`setSurfaceHolderCallback(callback: SurfaceHolder.Callback!)` Adds `SurfaceHolder.Callback` to `android.view.SurfaceView`.

Protected functions
`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`

From androidx.leanback.app.PlaybackFragment

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

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.
`Unit`	`onCreate(savedInstanceState: Bundle!)` 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.
`View!`	`onCreateView( inflater: LayoutInflater!, container: ViewGroup!, savedInstanceState: Bundle! )` This function is deprecated.
`Unit`	`onDestroy()` This function is deprecated.
`Unit`	`onDestroyOptionsMenu()` This function is deprecated.
`Unit`	`onDestroyView()` 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`	`onPause()` 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`	`onResume()` This function is deprecated.
`Unit`	`onSaveInstanceState(outState: Bundle!)` This function is deprecated.
`Unit`	`onStart()` This function is deprecated.
`Unit`	`onStop()` This function is deprecated.
`Unit`	`onTrimMemory(level: Int)` This function is deprecated.
`Unit`	`onViewCreated(view: View!, savedInstanceState: Bundle!)` 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.

From androidx.leanback.app.PlaybackFragment

`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`	`onBufferingStateChanged(start: Boolean)` Called when media has start or stop buffering.
`Unit`	`onCreate(savedInstanceState: Bundle!)` This function is deprecated.
`Unit`	`onDestroy()` This function is deprecated.
`Unit`	`onError(errorCode: Int, errorMessage: CharSequence!)` Called when media has error.
`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.

Public constructors

VideoFragment

Added in 1.1.0

Deprecated in 1.1.0

VideoFragment()

Public functions

getSurfaceView

Added in 1.1.0

Deprecated in 1.1.0

fun getSurfaceView(): SurfaceView!

Returns the surface view.

onCreateView

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

onDestroyView

fun onDestroyView(): Unit

setSurfaceHolderCallback

Added in 1.1.0

Deprecated in 1.1.0

fun setSurfaceHolderCallback(callback: SurfaceHolder.Callback!): Unit

Adds SurfaceHolder.Callback to android.view.SurfaceView.

Protected functions

onVideoSizeChanged

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