Android 12 Developer Preview is here! Try it out, and give us your feedback!

VideoView

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

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:

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 :

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

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

Constants
static Int

Indicates video is rendering on SurfaceView.

static Int

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!

open MediaControlView?

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

open Int

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

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

open Unit