These guides discuss the MediaCompat APIs, which are no longer updated. We strongly recommend using the Jetpack Media3 library instead.

Building a video player activity

When the activity receives the onCreate() lifecycle callback method it should perform these steps:

  • Create and initialize the media session
  • Set the media session callback
  • Set the media session's media button receiver to null so that a media button event won't restart the player when it is not visible. This only affects Android 5.0 (API level 21) and higher devices.
  • Create and initialize the media controller

The onCreate() code below demonstrates these steps:

Kotlin

privatelateinitvarmediaSession:MediaSessionCompat
publicoverridefunonCreate(savedInstanceState:Bundle?){
super.onCreate(savedInstanceState)
// Create a MediaSessionCompat
mediaSession=MediaSessionCompat(this,LOG_TAG).apply{
// Enable callbacks from MediaButtons and TransportControls
setFlags(MediaSessionCompat.FLAG_HANDLES_MEDIA_BUTTONSor
MediaSessionCompat.FLAG_HANDLES_TRANSPORT_CONTROLS)
// Do not let MediaButtons restart the player when the app is not visible
setMediaButtonReceiver(null)
// Set an initial PlaybackState with ACTION_PLAY, so media buttons can start the player
valstateBuilder=PlaybackStateCompat.Builder()
.setActions(PlaybackStateCompat.ACTION_PLAYorPlaybackStateCompat.ACTION_PLAY_PAUSE)
setPlaybackState(stateBuilder.build())
// MySessionCallback has methods that handle callbacks from a media controller
setCallback(MySessionCallback())
}
// Create a MediaControllerCompat
MediaControllerCompat(this,mediaSession).also{mediaController->
MediaControllerCompat.setMediaController(this,mediaController)
}
}

Java

MediaSessionCompatmediaSession;
PlaybackStateCompat.BuilderstateBuilder;
@Override
publicvoidonCreate(BundlesavedInstanceState){
super.onCreate(savedInstanceState);
// Create a MediaSessionCompat
mediaSession=newMediaSessionCompat(this,LOG_TAG);
// Enable callbacks from MediaButtons and TransportControls
mediaSession.setFlags(
MediaSessionCompat.FLAG_HANDLES_MEDIA_BUTTONS|
MediaSessionCompat.FLAG_HANDLES_TRANSPORT_CONTROLS);
// Do not let MediaButtons restart the player when the app is not visible
mediaSession.setMediaButtonReceiver(null);
// Set an initial PlaybackState with ACTION_PLAY, so media buttons can start the player
stateBuilder=newPlaybackStateCompat.Builder()
.setActions(
PlaybackStateCompat.ACTION_PLAY|
PlaybackStateCompat.ACTION_PLAY_PAUSE);
mediaSession.setState(stateBuilder.build());
// MySessionCallback has methods that handle callbacks from a media controller
mediaSession.setCallback(newMySessionCallback());
// Create a MediaControllerCompat
MediaControllerCompatmediaController=
newMediaControllerCompat(this,mediaSession);
MediaControllerCompat.setMediaController(this,mediaController);
}

When an app is closed, the activity receives the onPause() and onStop() callbacks in succession. If the player is playing, you must stop it before its activity goes away. The choice of which callback to use depends on what Android version you’re running.

In Android 6.0 (API level 23) and earlier there is no guarantee of when onStop() is called; it could get called 5 seconds after your activity disappears. Therefore, in Android versions earlier than 7.0, your app should stop playback in onPause(). In Android 7.0 and beyond, the system calls onStop() as soon as the activity becomes not visible, so this is not a problem.

To summarize:

  • In Android version 6.0 and earlier, stop the player in the onPause() callback.
  • In Android version 7.0 and later, stop the player in the onStop() callback.

When the activity receives the onDestroy() callback, it should release and clean up your player.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024年01月05日 UTC.