Make setSessionActivity accept null

Issue: #2109
PiperOrigin-RevId: 728160580
(cherry picked from commit 2b8700b)

Author: marcbaechinger

RELEASENOTES.md

@@ -35,6 +35,8 @@ This release includes the following changes since the
         to stop the foreground service before `stopSelf()` when overriding
         `onTaskRemoved`, use `MediaSessionService.pauseAllPlayersAndStopSelf()`
         instead.
+    *   Make `MediaSession.setSessionActivity(PendingIntent)` accept null
+        ([#2109](https://github.com/androidx/media/issues/2109)).
     *   Keep notification visible when playback enters an error or stopped
         state. The notification is only removed if the playlist is cleared or
         the player is released.

libraries/session/src/main/aidl/androidx/media3/session/IMediaController.aidl

@@ -48,7 +48,7 @@ oneway interface IMediaController {
       int seq, in Bundle sessionCommandsBundle, in Bundle playerCommandsBundle) = 3009;
   void onRenderedFirstFrame(int seq) = 3010;
   void onExtrasChanged(int seq, in Bundle extras) = 3011;
-  void onSessionActivityChanged(int seq, in PendingIntent pendingIntent) = 3013;
+  void onSessionActivityChanged(int seq, in @nullable PendingIntent pendingIntent) = 3013;
   void onError(int seq, in Bundle sessionError) = 3014;
   void onSetMediaButtonPreferences(int seq, in List<Bundle> commandButtonList) = 3015;
   // Next Id for MediaController: 3016

libraries/session/src/main/java/androidx/media3/session/MediaController.java

@@ -493,7 +493,7 @@ default void onExtrasChanged(MediaController controller, Bundle extras) {}
      */
     @UnstableApi
     default void onSessionActivityChanged(
-        MediaController controller, PendingIntent sessionActivity) {}
+        MediaController controller, @Nullable PendingIntent sessionActivity) {}
 
     /**
      * Called when an non-fatal error {@linkplain

libraries/session/src/main/java/androidx/media3/session/MediaControllerImplBase.java

@@ -93,6 +93,7 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
+import java.util.Objects;
 import java.util.concurrent.CancellationException;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeoutException;
@@ -3079,8 +3080,8 @@ public void onExtrasChanged(Bundle extras) {
             });
   }
 
-  public void onSetSessionActivity(int seq, PendingIntent sessionActivity) {
-    if (!isConnected()) {
+  public void onSetSessionActivity(int seq, @Nullable PendingIntent sessionActivity) {
+    if (!isConnected() || Objects.equals(this.sessionActivity, sessionActivity)) {
       return;
     }
     this.sessionActivity = sessionActivity;

libraries/session/src/main/java/androidx/media3/session/MediaControllerStub.java

@@ -214,10 +214,6 @@ public void onCustomCommand(int seq, @Nullable Bundle commandBundle, @Nullable B
   @Override
   public void onSessionActivityChanged(int seq, @Nullable PendingIntent sessionActivity)
       throws RemoteException {
-    if (sessionActivity == null) {
-      Log.w(TAG, "Ignoring null session activity intent");
-      return;
-    }
     dispatchControllerTaskOnHandler(
         controller -> controller.onSetSessionActivity(seq, sessionActivity));
   }

libraries/session/src/main/java/androidx/media3/session/MediaSession.java

@@ -789,13 +789,16 @@ public final PendingIntent getSessionActivity() {
    * Updates the session activity that was set when {@linkplain
    * Builder#setSessionActivity(PendingIntent) building the session}.
    *
-   * @param activityPendingIntent The pending intent to start the session activity.
+   * <p>Note: When a controller is connected to the session that has a version smaller than 1.6.0,
+   * then setting the session activity to null has no effect on the controller side.
+   *
+   * @param activityPendingIntent The pending intent to start the session activity or null.
    * @throws IllegalArgumentException if the {@link PendingIntent} passed into this method is
    *     {@linkplain PendingIntent#getActivity(Context, int, Intent, int) not an activity}.
    */
   @UnstableApi
-  public final void setSessionActivity(PendingIntent activityPendingIntent) {
-    if (Util.SDK_INT >= 31) {
+  public final void setSessionActivity(@Nullable PendingIntent activityPendingIntent) {
+    if (Util.SDK_INT >= 31 && activityPendingIntent != null) {
       checkArgument(Api31.isActivity(activityPendingIntent));
     }
     impl.setSessionActivity(activityPendingIntent);
@@ -818,8 +821,8 @@ public final void setSessionActivity(PendingIntent activityPendingIntent) {
    */
   @UnstableApi
   public final void setSessionActivity(
-      ControllerInfo controller, PendingIntent activityPendingIntent) {
-    if (Util.SDK_INT >= 31) {
+      ControllerInfo controller, @Nullable PendingIntent activityPendingIntent) {
+    if (Util.SDK_INT >= 31 && activityPendingIntent != null) {
       checkArgument(Api31.isActivity(activityPendingIntent));
     }
     impl.setSessionActivity(controller, activityPendingIntent);
@@ -2088,7 +2091,7 @@ default void setCustomLayout(int seq, List<CommandButton> layout) throws RemoteE
     default void setMediaButtonPreferences(int seq, List<CommandButton> mediaButtonPreferences)
         throws RemoteException {}
 
-    default void onSessionActivityChanged(int seq, PendingIntent sessionActivity)
+    default void onSessionActivityChanged(int seq, @Nullable PendingIntent sessionActivity)
         throws RemoteException {}
 
     default void onSessionExtrasChanged(int seq, Bundle sessionExtras) throws RemoteException {}

libraries/session/src/main/java/androidx/media3/session/MediaSessionImpl.java

@@ -95,7 +95,6 @@
 import java.util.Objects;
 import java.util.concurrent.ExecutionException;
 import org.checkerframework.checker.initialization.qual.Initialized;
-import org.checkerframework.checker.nullness.qual.MonotonicNonNull;
 
 /* package */ class MediaSessionImpl {
 
@@ -136,7 +135,7 @@
 
   private PlayerInfo playerInfo;
   private PlayerWrapper playerWrapper;
-  private @MonotonicNonNull PendingIntent sessionActivity;
+  @Nullable private PendingIntent sessionActivity;
   @Nullable private PlayerListener playerListener;
   @Nullable private MediaSession.Listener mediaSessionListener;
   @Nullable private ControllerInfo controllerForCurrentRequest;
@@ -850,7 +849,7 @@ protected PendingIntent getSessionActivity() {
   }
 
   @UnstableApi
-  protected void setSessionActivity(PendingIntent sessionActivity) {
+  protected void setSessionActivity(@Nullable PendingIntent sessionActivity) {
     this.sessionActivity = sessionActivity;
     ImmutableList<ControllerInfo> connectedControllers =
         sessionStub.getConnectedControllersManager().getConnectedControllers();
@@ -860,7 +859,8 @@ protected void setSessionActivity(PendingIntent sessionActivity) {
   }
 
   @UnstableApi
-  protected void setSessionActivity(ControllerInfo controller, PendingIntent sessionActivity) {
+  protected void setSessionActivity(
+      ControllerInfo controller, @Nullable PendingIntent sessionActivity) {
     if (controller.getControllerVersion() >= 3
         && sessionStub.getConnectedControllersManager().isConnected(controller)) {
       dispatchRemoteControllerTaskWithoutReturn(

libraries/session/src/main/java/androidx/media3/session/MediaSessionLegacyStub.java

@@ -1137,7 +1137,7 @@ public void onSessionExtrasChanged(int seq, Bundle sessionExtras) {
     }
 
     @Override
-    public void onSessionActivityChanged(int seq, PendingIntent sessionActivity) {
+    public void onSessionActivityChanged(int seq, @Nullable PendingIntent sessionActivity) {
       sessionCompat.setSessionActivity(sessionActivity);
     }
 

libraries/session/src/main/java/androidx/media3/session/MediaSessionStub.java

@@ -2098,9 +2098,10 @@ public void setMediaButtonPreferences(
       }
     }
 
+    @SuppressWarnings("nullness:argument") // sessionActivity can be null.
     @Override
-    public void onSessionActivityChanged(int sequenceNumber, PendingIntent sessionActivity)
-        throws RemoteException {
+    public void onSessionActivityChanged(
+        int sequenceNumber, @Nullable PendingIntent sessionActivity) throws RemoteException {
       iController.onSessionActivityChanged(sequenceNumber, sessionActivity);
     }
 

libraries/session/src/main/java/androidx/media3/session/legacy/MediaSessionCompat.java

@@ -550,7 +550,7 @@ public void setRegistrationCallback(@Nullable RegistrationCallback callback, Han
    *
    * @param pi The intent to launch to show UI for this Session.
    */
-  public void setSessionActivity(PendingIntent pi) {
+  public void setSessionActivity(@Nullable PendingIntent pi) {
     mImpl.setSessionActivity(pi);
   }
 
@@ -2219,7 +2219,7 @@ interface MediaSessionImpl {
 
     void setMetadata(@Nullable MediaMetadataCompat metadata);
 
-    void setSessionActivity(PendingIntent pi);
+    void setSessionActivity(@Nullable PendingIntent pi);
 
     void setMediaButtonReceiver(@Nullable PendingIntent mbr);
 
@@ -2700,7 +2700,7 @@ RemoteControlClient.MetadataEditor buildRccMetadata(@Nullable Bundle metadata) {
     }
 
     @Override
-    public void setSessionActivity(PendingIntent pi) {
+    public void setSessionActivity(@Nullable PendingIntent pi) {
       synchronized (mLock) {
         mSessionActivity = pi;
       }
@@ -4053,7 +4053,7 @@ public void setMetadata(@Nullable MediaMetadataCompat metadata) {
     }
 
     @Override
-    public void setSessionActivity(PendingIntent pi) {
+    public void setSessionActivity(@Nullable PendingIntent pi) {
       mSessionFwk.setSessionActivity(pi);
     }