loliball/media3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Make the media notification controller marker key visible

Browse Source 
An app that uses the `MediaSession` without a `MediaSessionService` may
want to connect a media notification controller on it own. To avoid apps
using a string literal, the key should be exposed as public.

PiperOrigin-RevId: 589875603
This commit is contained in:
bachinger 2023-12-11 10:54:12 -08:00 committed by Copybara-Service
parent 3e5ef51594
commit 7f9b02080a
11 changed files with 39 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
libraries/session/src/main/java/androidx/media3/session/MediaController.java
View File

@ -175,6 +175,24 @@ public class MediaController implements Player {
*/ */
@UnstableApi public static final long RELEASE_UNBIND_TIMEOUT_MS = 30_000; @UnstableApi public static final long RELEASE_UNBIND_TIMEOUT_MS = 30_000;
/**
* Key to mark the connection hints of the media notification controller.
*
* <p>For a controller to be {@linkplain
* MediaSession#isMediaNotificationController(MediaSession.ControllerInfo) recognized by the
* session as the media notification controller}, this key needs to be used to {@linkplain
* Bundle#putBoolean(String, boolean) set a boolean flag} in the connection hints to true. Only an
* internal controller that has the same package name as the session can be used as a media
* notification controller.
*
* <p>When using a session within a {@link MediaSessionService} or {@link MediaLibraryService},
* the service connects a media notification controller automatically. Apps can do this for
* standalone session to configure the platform session in the same way.
*/
@UnstableApi
public static final String KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG =
"androidx.media3.session.MediaNotificationManager";
private static final String TAG = "MediaController"; private static final String TAG = "MediaController";
private static final String WRONG_THREAD_ERROR_MESSAGE = private static final String WRONG_THREAD_ERROR_MESSAGE =

4
libraries/session/src/main/java/androidx/media3/session/MediaNotificationManager.java
View File

@ -55,8 +55,6 @@ import java.util.concurrent.TimeoutException;
*/ */
/* package */ final class MediaNotificationManager { /* package */ final class MediaNotificationManager {
/* package */ static final String KEY_MEDIA_NOTIFICATION_MANAGER =
"androidx.media3.session.MediaNotificationManager";
private static final String TAG = "MediaNtfMng"; private static final String TAG = "MediaNtfMng";
private final MediaSessionService mediaSessionService; private final MediaSessionService mediaSessionService;
@ -92,7 +90,7 @@ import java.util.concurrent.TimeoutException;
} }
MediaControllerListener listener = new MediaControllerListener(mediaSessionService, session); MediaControllerListener listener = new MediaControllerListener(mediaSessionService, session);
Bundle connectionHints = new Bundle(); Bundle connectionHints = new Bundle();
connectionHints.putBoolean(KEY_MEDIA_NOTIFICATION_MANAGER, true); connectionHints.putBoolean(MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG, true);
ListenableFuture<MediaController> controllerFuture = ListenableFuture<MediaController> controllerFuture =
new MediaController.Builder(mediaSessionService, session.getToken()) new MediaController.Builder(mediaSessionService, session.getToken())
.setConnectionHints(connectionHints) .setConnectionHints(connectionHints)

2
libraries/session/src/main/java/androidx/media3/session/MediaSessionImpl.java
View File

@ -387,7 +387,7 @@ import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
&& controllerInfo && controllerInfo
.getConnectionHints() .getConnectionHints()
.getBoolean( .getBoolean(
MediaNotificationManager.KEY_MEDIA_NOTIFICATION_MANAGER, /* defaultValue= */ false); MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG, /* defaultValue= */ false);
} }
/** /**

6
libraries/session/src/test/java/androidx/media3/session/MediaSessionUnitTest.java
View File

@ -153,7 +153,7 @@ public class MediaSessionUnitTest { // Avoid naming collision with session_curre
/* pid= */ MediaSessionManager.RemoteUserInfo.UNKNOWN_PID, /* pid= */ MediaSessionManager.RemoteUserInfo.UNKNOWN_PID,
/* uid= */ MediaSessionManager.RemoteUserInfo.UNKNOWN_UID); /* uid= */ MediaSessionManager.RemoteUserInfo.UNKNOWN_UID);
Bundle connectionHints = new Bundle(); Bundle connectionHints = new Bundle();
connectionHints.putBoolean(MediaNotificationManager.KEY_MEDIA_NOTIFICATION_MANAGER, true); connectionHints.putBoolean(MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG, true);
MediaSession.ControllerInfo controllerInfo = MediaSession.ControllerInfo controllerInfo =
new MediaSession.ControllerInfo( new MediaSession.ControllerInfo(
remoteUserInfo, remoteUserInfo,
@ -174,7 +174,7 @@ public class MediaSessionUnitTest { // Avoid naming collision with session_curre
/* pid= */ MediaSessionManager.RemoteUserInfo.UNKNOWN_PID, /* pid= */ MediaSessionManager.RemoteUserInfo.UNKNOWN_PID,
/* uid= */ MediaSessionManager.RemoteUserInfo.UNKNOWN_UID); /* uid= */ MediaSessionManager.RemoteUserInfo.UNKNOWN_UID);
Bundle connectionHints = new Bundle(); Bundle connectionHints = new Bundle();
connectionHints.putBoolean(MediaNotificationManager.KEY_MEDIA_NOTIFICATION_MANAGER, true); connectionHints.putBoolean(MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG, true);
MediaSession.ControllerInfo controllerInfo = MediaSession.ControllerInfo controllerInfo =
new MediaSession.ControllerInfo( new MediaSession.ControllerInfo(
remoteUserInfo, remoteUserInfo,
@ -214,7 +214,7 @@ public class MediaSessionUnitTest { // Avoid naming collision with session_curre
/* pid= */ MediaSessionManager.RemoteUserInfo.UNKNOWN_PID, /* pid= */ MediaSessionManager.RemoteUserInfo.UNKNOWN_PID,
/* uid= */ MediaSessionManager.RemoteUserInfo.UNKNOWN_UID); /* uid= */ MediaSessionManager.RemoteUserInfo.UNKNOWN_UID);
Bundle connectionHints = new Bundle(); Bundle connectionHints = new Bundle();
connectionHints.putBoolean(MediaNotificationManager.KEY_MEDIA_NOTIFICATION_MANAGER, true); connectionHints.putBoolean(MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG, true);
MediaSession.ControllerInfo controllerInfo = MediaSession.ControllerInfo controllerInfo =
new MediaSession.ControllerInfo( new MediaSession.ControllerInfo(
remoteUserInfo, remoteUserInfo,

2
libraries/test_session_current/src/androidTest/java/androidx/media3/session/MediaControllerCompatPlaybackStateCompatActionsWithMediaSessionTest.java
View File

@ -1616,7 +1616,7 @@ public class MediaControllerCompatPlaybackStateCompatActionsWithMediaSessionTest
throws InterruptedException { throws InterruptedException {
CountDownLatch connectionLatch = new CountDownLatch(1); CountDownLatch connectionLatch = new CountDownLatch(1);
Bundle connectionHints = new Bundle(); Bundle connectionHints = new Bundle();
connectionHints.putBoolean(MediaNotificationManager.KEY_MEDIA_NOTIFICATION_MANAGER, true); connectionHints.putBoolean(MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG, true);
ListenableFuture<MediaController> mediaNotificationControllerFuture = ListenableFuture<MediaController> mediaNotificationControllerFuture =
new MediaController.Builder( new MediaController.Builder(
ApplicationProvider.getApplicationContext(), mediaSession.getToken()) ApplicationProvider.getApplicationContext(), mediaSession.getToken())

4
libraries/test_session_current/src/androidTest/java/androidx/media3/session/MediaSessionCallbackWithMediaControllerCompatTest.java
View File

@ -780,7 +780,7 @@ public class MediaSessionCallbackWithMediaControllerCompatTest {
/* waitForConnection= */ true); /* waitForConnection= */ true);
KeyEvent keyEvent = new KeyEvent(KeyEvent.ACTION_DOWN, KeyEvent.KEYCODE_MEDIA_PLAY); KeyEvent keyEvent = new KeyEvent(KeyEvent.ACTION_DOWN, KeyEvent.KEYCODE_MEDIA_PLAY);
Bundle connectionHints = new Bundle(); Bundle connectionHints = new Bundle();
connectionHints.putBoolean(MediaNotificationManager.KEY_MEDIA_NOTIFICATION_MANAGER, true); connectionHints.putBoolean(MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG, true);
new MediaController.Builder( new MediaController.Builder(
ApplicationProvider.getApplicationContext(), session.get().getToken()) ApplicationProvider.getApplicationContext(), session.get().getToken())
.setConnectionHints(connectionHints) .setConnectionHints(connectionHints)
@ -889,7 +889,7 @@ public class MediaSessionCallbackWithMediaControllerCompatTest {
.setId("dispatchMediaButtonEvent") .setId("dispatchMediaButtonEvent")
.build())); .build()));
Bundle connectionHints = new Bundle(); Bundle connectionHints = new Bundle();
connectionHints.putBoolean(MediaNotificationManager.KEY_MEDIA_NOTIFICATION_MANAGER, true); connectionHints.putBoolean(MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG, true);
new MediaController.Builder( new MediaController.Builder(
ApplicationProvider.getApplicationContext(), session.get().getToken()) ApplicationProvider.getApplicationContext(), session.get().getToken())
.setConnectionHints(connectionHints) .setConnectionHints(connectionHints)

6
libraries/test_session_current/src/androidTest/java/androidx/media3/session/MediaSessionKeyEventTest.java
View File

@ -192,7 +192,7 @@ public class MediaSessionKeyEventTest {
.get(0) .get(0)
.getConnectionHints() .getConnectionHints()
.getBoolean( .getBoolean(
MediaNotificationManager.KEY_MEDIA_NOTIFICATION_MANAGER, MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG,
/* defaultValue= */ false)) /* defaultValue= */ false))
.isTrue(); .isTrue();
threadTestRule.getHandler().postAndSync(controller::release); threadTestRule.getHandler().postAndSync(controller::release);
@ -234,7 +234,7 @@ public class MediaSessionKeyEventTest {
.get(0) .get(0)
.getConnectionHints() .getConnectionHints()
.getBoolean( .getBoolean(
MediaNotificationManager.KEY_MEDIA_NOTIFICATION_MANAGER, MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG,
/* defaultValue= */ false)) /* defaultValue= */ false))
.isTrue(); .isTrue();
threadTestRule.getHandler().postAndSync(controller::release); threadTestRule.getHandler().postAndSync(controller::release);
@ -351,7 +351,7 @@ public class MediaSessionKeyEventTest {
() -> { () -> {
Bundle connectionHints = new Bundle(); Bundle connectionHints = new Bundle();
connectionHints.putBoolean( connectionHints.putBoolean(
MediaNotificationManager.KEY_MEDIA_NOTIFICATION_MANAGER, /* value= */ true); MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG, /* value= */ true);
return new MediaController.Builder( return new MediaController.Builder(
ApplicationProvider.getApplicationContext(), session.getToken()) ApplicationProvider.getApplicationContext(), session.getToken())
.setConnectionHints(connectionHints) .setConnectionHints(connectionHints)

2
libraries/test_session_current/src/androidTest/java/androidx/media3/session/MediaSessionServiceTest.java
View File

@ -312,7 +312,7 @@ public class MediaSessionServiceTest {
.get(0) .get(0)
.getConnectionHints() .getConnectionHints()
.getBoolean( .getBoolean(
MediaNotificationManager.KEY_MEDIA_NOTIFICATION_MANAGER, MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG,
/* defaultValue= */ false)) /* defaultValue= */ false))
.isTrue(); .isTrue();
assertThat(TestUtils.equals(controllerInfoList.get(1).getConnectionHints(), testHints)) assertThat(TestUtils.equals(controllerInfoList.get(1).getConnectionHints(), testHints))

12
libraries/test_session_current/src/androidTest/java/androidx/media3/session/MediaSessionTest.java
View File

@ -529,7 +529,7 @@ public class MediaSessionTest {
}) })
.build())); .build()));
Bundle connectionHints = new Bundle(); Bundle connectionHints = new Bundle();
connectionHints.putBoolean(MediaNotificationManager.KEY_MEDIA_NOTIFICATION_MANAGER, true); connectionHints.putBoolean(MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG, true);
new MediaController.Builder( new MediaController.Builder(
ApplicationProvider.getApplicationContext(), session.get().getToken()) ApplicationProvider.getApplicationContext(), session.get().getToken())
.setConnectionHints(connectionHints) .setConnectionHints(connectionHints)
@ -740,7 +740,7 @@ public class MediaSessionTest {
}) })
.build()); .build());
Bundle connectionHints = new Bundle(); Bundle connectionHints = new Bundle();
connectionHints.putBoolean(MediaNotificationManager.KEY_MEDIA_NOTIFICATION_MANAGER, true); connectionHints.putBoolean(MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG, true);
new MediaController.Builder(ApplicationProvider.getApplicationContext(), session.getToken()) new MediaController.Builder(ApplicationProvider.getApplicationContext(), session.getToken())
.setConnectionHints(connectionHints) .setConnectionHints(connectionHints)
.buildAsync() .buildAsync()
@ -779,7 +779,7 @@ public class MediaSessionTest {
public void onMediaButtonEvent_noKeyEvent_mediaNotificationControllerConnected_returnsFalse() public void onMediaButtonEvent_noKeyEvent_mediaNotificationControllerConnected_returnsFalse()
throws Exception { throws Exception {
Bundle connectionHints = new Bundle(); Bundle connectionHints = new Bundle();
connectionHints.putBoolean(MediaNotificationManager.KEY_MEDIA_NOTIFICATION_MANAGER, true); connectionHints.putBoolean(MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG, true);
new MediaController.Builder(ApplicationProvider.getApplicationContext(), session.getToken()) new MediaController.Builder(ApplicationProvider.getApplicationContext(), session.getToken())
.setConnectionHints(connectionHints) .setConnectionHints(connectionHints)
.buildAsync() .buildAsync()
@ -809,7 +809,7 @@ public class MediaSessionTest {
public void onMediaButtonEvent_invalidKeyEvent_mediaNotificationControllerConnected_returnsFalse() public void onMediaButtonEvent_invalidKeyEvent_mediaNotificationControllerConnected_returnsFalse()
throws Exception { throws Exception {
Bundle connectionHints = new Bundle(); Bundle connectionHints = new Bundle();
connectionHints.putBoolean(MediaNotificationManager.KEY_MEDIA_NOTIFICATION_MANAGER, true); connectionHints.putBoolean(MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG, true);
new MediaController.Builder(ApplicationProvider.getApplicationContext(), session.getToken()) new MediaController.Builder(ApplicationProvider.getApplicationContext(), session.getToken())
.setConnectionHints(connectionHints) .setConnectionHints(connectionHints)
.buildAsync() .buildAsync()
@ -839,7 +839,7 @@ public class MediaSessionTest {
public void onMediaButtonEvent_invalidAction_mediaNotificationControllerConnected_returnsFalse() public void onMediaButtonEvent_invalidAction_mediaNotificationControllerConnected_returnsFalse()
throws Exception { throws Exception {
Bundle connectionHints = new Bundle(); Bundle connectionHints = new Bundle();
connectionHints.putBoolean(MediaNotificationManager.KEY_MEDIA_NOTIFICATION_MANAGER, true); connectionHints.putBoolean(MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG, true);
new MediaController.Builder(ApplicationProvider.getApplicationContext(), session.getToken()) new MediaController.Builder(ApplicationProvider.getApplicationContext(), session.getToken())
.setConnectionHints(connectionHints) .setConnectionHints(connectionHints)
.buildAsync() .buildAsync()
@ -869,7 +869,7 @@ public class MediaSessionTest {
onMediaButtonEvent_invalidComponent_mediaNotificationControllerConnected_returnsFalse() onMediaButtonEvent_invalidComponent_mediaNotificationControllerConnected_returnsFalse()
throws Exception { throws Exception {
Bundle connectionHints = new Bundle(); Bundle connectionHints = new Bundle();
connectionHints.putBoolean(MediaNotificationManager.KEY_MEDIA_NOTIFICATION_MANAGER, true); connectionHints.putBoolean(MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG, true);
new MediaController.Builder(ApplicationProvider.getApplicationContext(), session.getToken()) new MediaController.Builder(ApplicationProvider.getApplicationContext(), session.getToken())
.setConnectionHints(connectionHints) .setConnectionHints(connectionHints)
.buildAsync() .buildAsync()

2
libraries/test_session_current/src/androidTest/java/androidx/media3/session/MediaSessionWithMediaControllerCompatTest.java
View File

@ -124,7 +124,7 @@ public class MediaSessionWithMediaControllerCompatTest {
sessionTestRule.ensureReleaseAfterTest( sessionTestRule.ensureReleaseAfterTest(
new MediaSession.Builder(context, player).setId(TAG).setCallback(callback).build()); new MediaSession.Builder(context, player).setId(TAG).setCallback(callback).build());
Bundle connectionHints = new Bundle(); Bundle connectionHints = new Bundle();
connectionHints.putBoolean(MediaNotificationManager.KEY_MEDIA_NOTIFICATION_MANAGER, true); connectionHints.putBoolean(MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG, true);
new MediaController.Builder(context.getApplicationContext(), session.getToken()) new MediaController.Builder(context.getApplicationContext(), session.getToken())
.setConnectionHints(connectionHints) .setConnectionHints(connectionHints)
.buildAsync() .buildAsync()

3
libraries/test_session_current/src/main/java/androidx/media3/session/MediaSessionProviderService.java
View File

@ -328,7 +328,8 @@ public class MediaSessionProviderService extends Service {
session.setSessionPositionUpdateDelayMs(0L); session.setSessionPositionUpdateDelayMs(0L);
if (useFakeMediaNotificationManagerController) { if (useFakeMediaNotificationManagerController) {
Bundle connectionHints = new Bundle(); Bundle connectionHints = new Bundle();
connectionHints.putBoolean("androidx.media3.session.MediaNotificationManager", true); connectionHints.putBoolean(
MediaController.KEY_MEDIA_NOTIFICATION_CONTROLLER_FLAG, true);
//noinspection unused //noinspection unused
ListenableFuture<MediaController> unusedFuture = ListenableFuture<MediaController> unusedFuture =
new MediaController.Builder(getApplicationContext(), session.getToken()) new MediaController.Builder(getApplicationContext(), session.getToken())