VideoView
public
class
VideoView
extends ViewGroup
| java.lang.Object | |||
| ↳ | android.view.View | ||
| ↳ | android.view.ViewGroup | ||
| ↳ | 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 MediaControlView is attached so the playback
control buttons are displayed on top of VideoView.
Contents:
- Using VideoView with SessionPlayer or MediaController
- Using VideoView with MediaControlView
- Choosing a view type
- Comparison with android.widget.VideoView
- 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 extendsSessionPlayer(e.g.MediaPlayer) and link it to this view by callingsetPlayer(SessionPlayer). - 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 aMediaControllerthat's attached to theMediaSessionand link it to this view by callingsetMediaController(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(MediaControlView, long).
If you don't want to use MediaControlView, set
the VideoView attribute 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 thesetViewType(int) method or
by setting the 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.VideoViewcreates aMediaPlayerinstance internally and wraps playback APIs around it.androidx.media2.widget.VideoViewdoes not create a player instance internally. Instead, either aSessionPlayeror aMediaControllerinstance should be created externally and link toVideoViewusingsetPlayer(SessionPlayer)orsetMediaController(MediaController), respectively. -
android.widget.VideoViewinherits from the SurfaceView class.androidx.media2.widget.VideoViewinherits from ViewGroup and can render videos using SurfaceView or TextureView, depending on your choice. -
A
VideoViewcan respond to media key events if you callsetMediaController(MediaController)to link it to aMediaControllerthat's connected to an activeMediaSession.
Displaying Metadata
When you play music only (sound with no video), VideoView can display album art and other metadata by callingMediaItem.setMetadata(MediaMetadata).
The following table shows the metadata displayed by the VideoView, and the default values
assigned if the keys are not set:
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
Activity.onSaveInstanceState(Bundle) and
Activity.onRestoreInstanceState(Bundle).
Attributes :
Example of attributes for a VideoView with TextureView and no attached control view:
<androidx.media2.widget.VideoView
android:id="@+id/video_view"
widget:enableControlView="false"
widget:viewType="textureView"
/>
Summary
Nested classes | |
|---|---|
interface |
VideoView.OnViewTypeChangedListener
Interface definition of a callback to be invoked when the view type has been changed. |
Constants | |
|---|---|
int |
VIEW_TYPE_SURFACEVIEW
Indicates video is rendering on SurfaceView. |
int |
VIEW_TYPE_TEXTUREVIEW
Indicates video is rendering on TextureView. |
Inherited constants |
|---|