diff --git a/media/java/android/media/projection/MediaProjectionManager.java b/media/java/android/media/projection/MediaProjectionManager.java index f327e4e76f16b..30fccf485b24a 100644 --- a/media/java/android/media/projection/MediaProjectionManager.java +++ b/media/java/android/media/projection/MediaProjectionManager.java @@ -35,6 +35,27 @@ import java.util.Map; /** * Manages the retrieval of certain types of {@link MediaProjection} tokens. + * + *

    An example flow of starting a media projection will be: + *
  1. Declare a foreground service with the type {@code mediaProjection} in + * the {@code AndroidManifest.xml}. + *
  2. + *
  3. Create an intent by calling {@link MediaProjectionManager#createScreenCaptureIntent()} + * and pass this intent to {@link Activity#startActivityForResult(Intent, int)}. + *
  4. + *
  5. On getting {@link Activity#onActivityResult(int, int, Intent)}, + * start the foreground service with the type + * {@link android.content.pm.ServiceInfo#FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION}. + *
  6. + *
  7. Retrieve the media projection token by calling + * {@link MediaProjectionManager#getMediaProjection(int, Intent)} with the result code and + * intent from the {@link Activity#onActivityResult(int, int, Intent)} above. + *
  8. + *
  9. Start the screen capture session for media projection by calling + * {@link MediaProjection#createVirtualDisplay(String, int, int, int, int, Surface, + * android.hardware.display.VirtualDisplay.Callback, Handler)}. + *
  10. + *
*/ @SystemService(Context.MEDIA_PROJECTION_SERVICE) public final class MediaProjectionManager { @@ -170,6 +191,17 @@ public final class MediaProjectionManager { * <service> element of * the app's manifest file. *

+ *

+ * For an app targeting SDK version {@link android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE U} or + * later, the user must have granted the app with the permission to start a projection, + * before the app starts a foreground service with the type + * {@link android.content.pm.ServiceInfo#FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION}. + * Additionally, the app must have started the foreground service with that type before calling + * this API here, or else it'll receive a {@link SecurityException} from this API call, unless + * it's a privileged app. Apps can request the permission via the + * {@link #createScreenCaptureIntent()} and {@link Activity#startActivityForResult(Intent, int)} + * (or similar APIs). + *

* * @param resultCode The result code from {@link Activity#onActivityResult(int, int, Intent) * onActivityResult(int, int, Intent)}.