Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[MediaProjection] Clarify createVirtualDisplay exception javadoc

Browse Source 
The SecurityException has been present for several releases, but
undocumented until earlier in Android U development.

Ensure that token re-use throws SecurityException, and only
a missing callback results in IllegalStateException.

Clarify that the SecurityException is only thrown when an app
invokes MediaProjection#stop before attempting to capture again.
Since an app does not have to invoke that method to end a
recording (for example, they may stop the MediaRecorder instance
only), the IllegalStateException is thrown in this scenario.

Bug: 286252090
Test:  atest FrameworksServicesTests:MediaProjectionManagerServiceTest
Change-Id: I2c6f151e806430330a76482d7c6e3c89adfc19a0
This commit is contained in:
Naomi Musgrave
2023-06-19 15:47:07 +00:00
parent 9fda153a29
commit 744507478f
3 changed files with 22 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
media/java/android/media/projection/MediaProjection.java
View File

@@ -171,25 +171,30 @@ public final class MediaProjection {
* @param handler The {@link android.os.Handler} on which the callback should be invoked, or
* null if the callback should be invoked on the calling thread's main
* {@link android.os.Looper}.
* @throws IllegalStateException In the following scenarios, if the target SDK is {@link
* android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE U} and up:
* @throws IllegalStateException If the target SDK is {@link
* android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE U} and up, and
* if no {@link Callback} is registered.
* @throws SecurityException In any of the following scenarios:
* <ol>
* <li>If no {@link Callback} is registered.</li>
* <li>If {@link MediaProjectionManager#getMediaProjection}
* <li>If attempting to create a new virtual display
* associated with this MediaProjection instance after it has
* been stopped by invoking {@link #stop()}.
* <li>If the target SDK is {@link
* android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE U} and up,
* and if this instance has already taken a recording through
* {@code #createVirtualDisplay}, but {@link #stop()} wasn't
* invoked to end the recording.
* <li>If the target SDK is {@link
* android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE U} and up,
* and if {@link MediaProjectionManager#getMediaProjection}
* was invoked more than once to get this
* {@code MediaProjection} instance.
* <li>If this instance has already taken a recording through
* {@code #createVirtualDisplay}.
* </ol>
* However, if the target SDK is less than
* {@link android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE U}, no
* exception is thrown. In case 1, recording begins even without
* the callback. In case 2 & 3, recording doesn't begin
* until the user re-grants consent in the dialog.
* @throws SecurityException If attempting to create a new virtual display associated with this
* MediaProjection instance after it has been stopped by invoking
* {@link #stop()}.
*
* In cases 2 & 3, no exception is thrown if the target SDK is
* less than
* {@link android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE U}.
* Instead, recording doesn't begin until the user re-grants
* consent in the dialog.
* @see VirtualDisplay
* @see VirtualDisplay.Callback
*/

2
services/core/java/com/android/server/media/projection/MediaProjectionManagerService.java
View File

@@ -1078,7 +1078,7 @@ public final class MediaProjectionManagerService extends SystemService
// Tear down projection here; necessary to ensure (among other reasons) that
// stop is dispatched to client and cast icon disappears from status bar.
mProjectionGrant.stop();
throw new IllegalStateException("Don't re-use the resultData to retrieve "
throw new SecurityException("Don't re-use the resultData to retrieve "
+ "the same projection instance, and don't use a token that has "
+ "timed out. Don't take multiple captures by invoking "
+ "MediaProjection#createVirtualDisplay multiple times on the "

2
services/tests/servicestests/src/com/android/server/media/projection/MediaProjectionManagerServiceTest.java
View File

@@ -344,7 +344,7 @@ public class MediaProjectionManagerServiceTest {
// Second start - so not valid.
projection.start(mIMediaProjectionCallback);
assertThrows(IllegalStateException.class, projection::isValid);
assertThrows(SecurityException.class, projection::isValid);
}
// TODO(269273190): Test flag using compat annotations instead.