Merge "[MediaProjection] Improve foreground service documentation" (217c896b) · Commits · e / os / android_frameworks_base

core/java/android/content/pm/ServiceInfo.java

+11 −2

Original line number	Diff line number	Diff line
		@@ -246,8 +246,17 @@ public class ServiceInfo extends ComponentInfo

		/**
		* Constant corresponding to {@code mediaProjection} in
		* the {@link android.R.attr#foregroundServiceType} attribute.
		* Managing a media projection session, e.g for screen recording or taking screenshots.
		* the {@link android.R.attr#foregroundServiceType foregroundServiceType} attribute.
		*
		* <p>
		* To capture through {@link android.media.projection.MediaProjection}, an app must start a
		* foreground service with the type corresponding to this constant. This type should only be
		* used for {@link android.media.projection.MediaProjection}. Capturing screen contents via
		* {@link android.media.projection.MediaProjection#createVirtualDisplay(String, int, int, int,
		* int, android.view.Surface, android.hardware.display.VirtualDisplay.Callback,
		* android.os.Handler) createVirtualDisplay} conveniently allows recording, presenting screen
		* contents into a meeting, taking screenshots, or several other scenarios.
		* </p>
		*
		* <p>Starting foreground service with this type from apps targeting API level
		* {@link android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE} and later, will require permission

core/res/res/values/attrs_manifest.xml

+18 −7

Original line number	Diff line number	Diff line
		@@ -1648,12 +1648,23 @@
		or has been granted the access to one of the attached USB devices/accessories.
		-->
		<flag name="connectedDevice" value="0x10" />
		<!-- Managing a media projection session, e.g, for screen recording or taking
		screenshots.
		<!-- Managing a {@link android.media.projection.MediaProjection MediaProjection} session,
		e.g., for screen recording or takingscreenshots.

		<p>
		To capture through {@link android.media.projection.MediaProjection}, an app must start
		a foreground service with the type corresponding to this constant. This type should
		only be used for {@link android.media.projection.MediaProjection}. Capturing screen
		contents via
		{@link android.media.projection.MediaProjection#createVirtualDisplay(String, int, int,
		int, int, android.view.Surface, android.hardware.display.VirtualDisplay.Callback,
		android.os.Handler) createVirtualDisplay} conveniently allows recording, presenting
		screen contents into a meeting, taking screenshots, or several other scenarios.
		</p>

		<p>For apps with <code>targetSdkVersion</code>
		{@link android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE} and above, starting a foreground
		service with this type will require permission
		{@link android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE} and above, starting a
		foreground service with this type will require permission
		{@link android.Manifest.permission#FOREGROUND_SERVICE_MEDIA_PROJECTION}, and the user
		must have allowed the screen capture request from this app.
		-->

media/java/android/media/projection/MediaProjectionManager.java

+44 −41

Original line number	Diff line number	Diff line
		@@ -29,6 +29,7 @@ import android.os.RemoteException;
		import android.os.ServiceManager;
		import android.util.ArrayMap;
		import android.util.Log;
		import android.view.Surface;

		import java.util.Map;

		@@ -74,8 +75,9 @@ public final class MediaProjectionManager {
		* Returns an {@link Intent} that <b>must</b> be passed to
		* {@link Activity#startActivityForResult(Intent, int)} (or similar) in order to start screen
		* capture. The activity will prompt the user whether to allow screen capture. The result of
		* this activity (received by overriding {@link Activity#onActivityResult(int, int, Intent)}
		* should be passed to {@link #getMediaProjection(int, Intent)}.
		* this activity (received by overriding {@link Activity#onActivityResult(int, int, Intent)
		* onActivityResult(int, int, Intent)}) should be passed to
		* {@link #getMediaProjection(int, Intent)}.
		* <p>
		* Identical to calling {@link #createScreenCaptureIntent(MediaProjectionConfig)} with
		* a {@link MediaProjectionConfig#createConfigForUserChoice()}.
		@@ -102,8 +104,8 @@ public final class MediaProjectionManager {
		* capture. Customizes the activity and resulting {@link MediaProjection} session based up
		* the provided {@code config}. The activity will prompt the user whether to allow screen
		* capture. The result of this activity (received by overriding
		* {@link Activity#onActivityResult(int, int, Intent)}) should be passed to
		* {@link #getMediaProjection(int, Intent)}.
		* {@link Activity#onActivityResult(int, int, Intent) onActivityResult(int, int, Intent)})
		* should be passed to {@link #getMediaProjection(int, Intent)}.
		*
		* <p>
		* If {@link MediaProjectionConfig} was created from:
		@@ -146,47 +148,48 @@ public final class MediaProjectionManager {

		/**
		* Retrieves the {@link MediaProjection} obtained from a successful screen
		* capture request. The result code and data from the request are provided
		* by overriding {@link Activity#onActivityResult(int, int, Intent)
		* onActivityResult(int, int, Intent)}, which is called after starting an
		* activity using {@link #createScreenCaptureIntent()}.
		*
		* <p>Starting from Android {@link android.os.Build.VERSION_CODES#R}, if
		* your application requests the
		* {@link android.Manifest.permission#SYSTEM_ALERT_WINDOW
		* SYSTEM_ALERT_WINDOW} permission, and the user has not explicitly denied
		* it, the permission will be automatically granted until the projection is
		* stopped. The permission allows your app to display user controls on top
		* of the screen being captured.
		*
		* <p>Apps targeting SDK version {@link android.os.Build.VERSION_CODES#Q} or
		* later must set the
		* {@link android.R.attr#foregroundServiceType foregroundServiceType}
		* attribute to {@code mediaProjection} in the
		* <a href="/guide/topics/manifest/service-element">
		* <code><service></code></a> element of the app's manifest file;
		* {@code mediaProjection} is equivalent to
		* capture request. The result code and data from the request are provided by overriding
		* {@link Activity#onActivityResult(int, int, Intent) onActivityResult(int, int, Intent)},
		* which is called after starting an activity using {@link #createScreenCaptureIntent()}.
		* <p>
		* Starting from Android {@link android.os.Build.VERSION_CODES#R R}, if your application
		* requests the {@link android.Manifest.permission#SYSTEM_ALERT_WINDOW SYSTEM_ALERT_WINDOW}
		* permission, and the user has not explicitly denied it, the permission will be automatically
		* granted until the projection is stopped. The permission allows your app to display user
		* controls on top of the screen being captured.
		* </p>
		* <p>
		* An app targeting SDK version {@link android.os.Build.VERSION_CODES#Q Q} or later must
		* invoke {@code getMediaProjection} and maintain the capture session
		* ({@link MediaProjection#createVirtualDisplay(String, int, int, int, int, Surface,
		* android.hardware.display.VirtualDisplay.Callback, Handler)
		* MediaProjection#createVirtualDisplay}) while running a foreground service. The app must set
		* the {@link android.R.attr#foregroundServiceType foregroundServiceType} attribute to
		* {@link android.content.pm.ServiceInfo#FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION
		* FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION}.
		*
		* @see <a href="/guide/components/foreground-services">
		* Foreground services developer guide</a>
		* @see <a href="/guide/topics/large-screens/media-projection">
		* Media projection developer guide</a>
		* FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION} in the
		* <a href="/guide/topics/manifest/service-element"><code><service></code></a> element of
		* the app's manifest file.
		* </p>
		*
		* @param resultCode The result code from
		* {@link android.app.Activity#onActivityResult(int, int, android.content.Intent)
		* @param resultCode The result code from {@link Activity#onActivityResult(int, int, Intent)
		* onActivityResult(int, int, Intent)}.
		* @param resultData The result data from
		* {@link android.app.Activity#onActivityResult(int, int, android.content.Intent)
		* @param resultData The result data from {@link Activity#onActivityResult(int, int, Intent)
		* onActivityResult(int, int, Intent)}.
		* @return The media projection obtained from a successful screen capture
		* request, or null if the result of the screen capture request is not
		* {@link Activity#RESULT_OK RESULT_OK}.
		* @return The media projection obtained from a successful screen capture request, or null if
		* the result of the screen capture request is not {@link Activity#RESULT_OK RESULT_OK}.
		* @throws IllegalStateException On
		* pre-{@link android.os.Build.VERSION_CODES#Q Q} devices if a
		* previously obtained {@code MediaProjection} from the same
		* {@code resultData} has not yet been stopped.
		* @throws SecurityException On {@link android.os.Build.VERSION_CODES#Q Q}+ devices if not
		* invoked from a foreground service with type
		* {@link android.content.pm.ServiceInfo#FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION
		* FOREGROUND_SERVICE_TYPE_MEDIA_PROJECTION}, unless caller is a
		* privileged app.
		* @see <a href="/guide/components/foreground-services">
		* Foreground services developer guide</a>
		* @see <a href="/guide/topics/large-screens/media-projection">
		* Media projection developer guide</a>
		*/
		public MediaProjection getMediaProjection(int resultCode, @NonNull Intent resultData) {
		if (resultCode != Activity.RESULT_OK \|\| resultData == null) {