VideoView

Kotlin |Java

open class VideoView : SelectiveLayout

androidx.media2.widget.VideoView

A high level view for media playback that can be integrated with either a SessionPlayer or a MediaController. Developers can easily implement a video rendering application using this class. By default, a is attached so the playback control buttons are displayed on top of VideoView.

Contents:

1. Using VideoView with SessionPlayer or MediaController
2. Using VideoView with MediaControlView
3. Choosing a view type
4. Comparison with android.widget.VideoView
5. Displaying Metadata

Using VideoView with SessionPlayer or MediaController

• For simple use cases that do not require communication with a MediaSession, apps need to create a player instance that extends SessionPlayer (e.g. androidx.media2.player.MediaPlayer) and link it to this view by calling setPlayer.
• For more advanced use cases that require a MediaSession (e.g. handling media key events, integrating with other MediaSession apps as Assistant), apps need to create a MediaController that's attached to the MediaSession and link it to this view by calling setMediaController.

Using VideoView with MediaControlView

VideoView is working with MediaControlView and a MediaControlView instance is attached to VideoView by default.

If you want to attach a custom MediaControlView, assign the custom media control widget using setMediaControlView.

If you don't want to use MediaControlView, set the VideoView attribute androidx.media2.widget.R.attr#enableControlView to false.

Choosing a view type

VideoView can render videos on a TextureView or SurfaceView. The default is SurfaceView which can be changed by using the setViewType(int) method or by setting the androidx.media2.widget.R.attr#viewType attribute in the layout file.

SurfaceView is recommended in most cases for saving battery life. TextureView might be preferred for supporting various UIs such as animation and translucency.

Comparison with android.widget.VideoView

These are the main differences between the media2 VideoView widget and the older android widget:

• android.widget.VideoView creates a android.media.MediaPlayer instance internally and wraps playback APIs around it.

  androidx.media2.widget.VideoView does not create a player instance internally. Instead, either a SessionPlayer or a MediaController instance should be created externally and link to VideoView using setPlayer(SessionPlayer) or setMediaController(MediaController), respectively.

• android.widget.VideoView inherits from the SurfaceView class.

  androidx.media2.widget.VideoView inherits from ViewGroup and can render videos using SurfaceView or TextureView, depending on your choice.

• A VideoView can respond to media key events if you call setMediaController to link it to a MediaController that's connected to an active MediaSession.

Displaying Metadata

When you play music only (sound with no video), VideoView can display album art and other metadata by calling MediaItem#setMetadata(MediaMetadata). The following table shows the metadata displayed by the VideoView, and the default values assigned if the keys are not set:

Key	Default
MediaMetadata#METADATA_KEY_TITLE	androidx.media2.widget.R.string#mcv2_music_title_unknown_text
MediaMetadata#METADATA_KEY_ARTIST	androidx.media2.widget.R.string#mcv2_music_artist_unknown_text
MediaMetadata#METADATA_KEY_ALBUM_ART	androidx.media2.widget.R.drawable#media2_widget_ic_default_album_image

Note: VideoView does not retain its full state when going into the background. In particular, it does not save, and does not restore the current play state, play position, selected tracks. Applications should save and restore these on their own in android.app.Activity#onSaveInstanceState and android.app.Activity#onRestoreInstanceState.

Attributes :

• androidx.media2.widget.R.attr#enableControlView
• androidx.media2.widget.R.attr#viewType

Example of attributes for a VideoView with TextureView and no attached control view:

<code>&lt;androidx.media2.widget.VideoView
       android:id="@+id/video_view"
       widget:enableControlView="false"
       widget:viewType="textureView"
   /&gt;</code>

Summary

Nested classes
abstract	OnViewTypeChangedListener Interface definition of a callback to be invoked when the view type has been changed.

Constants
static Int	VIEW_TYPE_SURFACEVIEW Indicates video is rendering on SurfaceView.
static Int	VIEW_TYPE_TEXTUREVIEW Indicates video is rendering on TextureView.

Public constructors
<init>(@NonNull context: Context)
<init>(@NonNull context: Context, @Nullable attrs: AttributeSet?)
<init>(@NonNull context: Context, @Nullable attrs: AttributeSet?, defStyleAttr: Int)

Public methods
open CharSequence!	getAccessibilityClassName()
open MediaControlView?	getMediaControlView() Returns MediaControlView instance which is currently attached to VideoView by default or by setMediaControlView method.
open Int	getViewType() Returns view type.
open Unit	setMediaControlView(@NonNull mediaControlView: MediaControlView, intervalMs: Long) Sets MediaControlView instance.
open Unit	setMediaController(@NonNull controller: MediaController) Sets MediaController to display media content.
open Unit	setOnViewTypeChangedListener(@Nullable listener: VideoView.OnViewTypeChangedListener?) Sets a listener to be called when a view type change is done.
open Unit	setPlayer(@NonNull player: SessionPlayer) Sets SessionPlayer to display media content.
open Unit	setViewType(viewType: Int) Selects which view will be used to render video between SurfaceView and TextureView.

Protected methods
open Unit	onAttachedToWindow()
open Unit	onDetachedFromWindow()

Constants

VIEW_TYPE_SURFACEVIEW

static val VIEW_TYPE_SURFACEVIEW: Int

Indicates video is rendering on SurfaceView.

Value: 0

See Also

• #setViewType

VIEW_TYPE_TEXTUREVIEW

static val VIEW_TYPE_TEXTUREVIEW: Int

Indicates video is rendering on TextureView.

Value: 1

See Also

• #setViewType

Public constructors

<init>

VideoView(@NonNull context: Context)

<init>

VideoView(
    @NonNull context: Context, 
    @Nullable attrs: AttributeSet?)

<init>

VideoView(
    @NonNull context: Context, 
    @Nullable attrs: AttributeSet?, 
    defStyleAttr: Int)

Public methods

getAccessibilityClassName

open fun getAccessibilityClassName(): CharSequence!

getMediaControlView

@Nullable open fun getMediaControlView(): MediaControlView?

Returns MediaControlView instance which is currently attached to VideoView by default or by setMediaControlView method.

getViewType

open fun getViewType(): Int

Returns view type.

Return
Int	view type. See {@see setViewType}.

setMediaControlView

open fun setMediaControlView(
    @NonNull mediaControlView: MediaControlView, 
    intervalMs: Long
): Unit

Sets MediaControlView instance. It will replace the previously assigned MediaControlView instance if any.

If a MediaController or a SessionPlayer instance has been set to VideoView, the same instance will be set to MediaControlView.

Parameters
mediaControlView	MediaControlView: a MediaControlView instance.
intervalMs	Long: time interval in milliseconds until MediaControlView transitions into a different mode. -1 can be set to disable all UI transitions. See MediaControlView Javadoc Section "UI transitions" for details.

setMediaController

open fun setMediaController(@NonNull controller: MediaController): Unit

Sets MediaController to display media content. Setting a MediaController will unset any MediaController or SessionPlayer that was previously set.

If VideoView has a MediaControlView instance, this controller will also be set to it.

Calling this method will automatically set VideoView's surface to MediaController by calling MediaController#setSurface(Surface). If the MediaController is connected to a MediaSession and that MediaSession is associated with a SessionPlayer, VideoView's surface will be set to that SessionPlayer.

Parameters
controller	MediaController: the controller

See Also

• #setPlayer

setOnViewTypeChangedListener

open fun setOnViewTypeChangedListener(@Nullable listener: VideoView.OnViewTypeChangedListener?): Unit

Sets a listener to be called when a view type change is done.

Parameters
listener	VideoView.OnViewTypeChangedListener?: The listener to be called. A value of null removes any existing listener.

See Also

• #setViewType(int)

setPlayer

open fun setPlayer(@NonNull player: SessionPlayer): Unit

Sets SessionPlayer to display media content. Setting a SessionPlayer will unset any MediaController or SessionPlayer that was previously set.

If VideoView has a MediaControlView instance, this player will also be set to it.

Calling this method will automatically set VideoView's surface to SessionPlayer by calling SessionPlayer#setSurface(Surface).

Parameters
player	SessionPlayer: the player

See Also

• #setMediaController

setViewType

open fun setViewType(viewType: Int): Unit

Selects which view will be used to render video between SurfaceView and TextureView.

Note: There are two known issues on API level 28+ devices.

• When changing view type to SurfaceView from TextureView in "paused" playback state, a blank screen can be shown.
• When changing view type to TextureView from SurfaceView repeatedly in "paused" playback state, the lastly rendered frame on TextureView can be shown.

Parameters
viewType	Int: the view type to render video VIEW_TYPE_SURFACEVIEW VIEW_TYPE_TEXTUREVIEW

Protected methods

onAttachedToWindow

protected open fun onAttachedToWindow(): Unit

onDetachedFromWindow

protected open fun onDetachedFromWindow(): Unit