Remove built-in support for stop() in Notification

PiperOrigin-RevId: 414321900

Remove built-in support for stop() in Notification
PiperOrigin-RevId: 414321900
21bbdb58 · jaewan · Ian Baker · 8bd5d8bc · 21bbdb58 · 8bd5d8bc
Commit 21bbdb58 authored Dec 06, 2021 by jaewan Committed by Ian Baker Dec 07, 2021
Showing with 4 additions and 86 deletions
libraries/session/src/main/java/androidx/media3/session/PlayerNotificationManager.java
libraries/session/src/main/res/drawable/exo_icon_stop.xml
libraries/session/src/main/res/values/drawables.xml
libraries/session/src/main/res/values/strings.xml
--- a/libraries/session/src/main/java/androidx/media3/session/PlayerNotificationManager.java
+++ b/libraries/session/src/main/java/androidx/media3/session/PlayerNotificationManager.java
@@ -134,11 +134,6 @@ import java.util.Map;
 *         <li>Corresponding setter: {@link #setUseNextActionInCompactView(boolean)}
 *         <li>Default: {@code false}
 *       </ul>
- *   <li><b>{@code useStopAction}</b> - Sets whether the stop action is used.
- *       <ul>
- *         <li>Corresponding setter: {@link #setUseStopAction(boolean)}
- *         <li>Default: {@code false}
- *       </ul>
 * </ul>
 *
 * <h2>Overriding drawables</h2>
@@ -156,7 +151,6 @@ import java.util.Map;
 *   <li><b>{@code exo_notification_fastforward}</b> - The fast forward icon.
 *   <li><b>{@code exo_notification_previous}</b> - The previous icon.
 *   <li><b>{@code exo_notification_next}</b> - The next icon.
- *   <li><b>{@code exo_notification_stop}</b> - The stop icon.
 * </ul>
 *
 * <p>Alternatively, the action icons can be set programatically by using the {@link Builder}.
@@ -320,7 +314,6 @@ public class PlayerNotificationManager {
    protected int rewindActionIconResourceId;
    protected int playActionIconResourceId;
    protected int pauseActionIconResourceId;
-    protected int stopActionIconResourceId;
    protected int fastForwardActionIconResourceId;
    protected int previousActionIconResourceId;
    protected int nextActionIconResourceId;
@@ -357,7 +350,6 @@ public class PlayerNotificationManager {
      smallIconResourceId = R.drawable.exo_notification_small_icon;
      playActionIconResourceId = R.drawable.exo_notification_play;
      pauseActionIconResourceId = R.drawable.exo_notification_pause;
-      stopActionIconResourceId = R.drawable.exo_notification_stop;
      rewindActionIconResourceId = R.drawable.exo_notification_rewind;
      fastForwardActionIconResourceId = R.drawable.exo_notification_fastforward;
      previousActionIconResourceId = R.drawable.exo_notification_previous;
@@ -468,18 +460,6 @@ public class PlayerNotificationManager {
    }
    /**
-     * The resource id of the drawable to be used as the icon of action {@link #ACTION_STOP}.
-     *
-     * <p>The default is {@code R.drawable#exo_notification_stop}.
-     *
-     * @return This builder.
-     */
-    public Builder setStopActionIconResourceId(int stopActionIconResourceId) {
-      this.stopActionIconResourceId = stopActionIconResourceId;
-      return this;
-    }
-    /**
     * The resource id of the drawable to be used as the icon of action {@link #ACTION_REWIND}.
     *
     * <p>The default is {@code R.drawable#exo_notification_rewind}.
@@ -573,7 +553,6 @@ public class PlayerNotificationManager {
          smallIconResourceId,
          playActionIconResourceId,
          pauseActionIconResourceId,
-          stopActionIconResourceId,
          rewindActionIconResourceId,
          fastForwardActionIconResourceId,
          previousActionIconResourceId,
@@ -615,8 +594,6 @@ public class PlayerNotificationManager {
  public static final String ACTION_FAST_FORWARD = "androidx.media3.ui.notification.ffwd";
  /** The action which rewinds. */
  public static final String ACTION_REWIND = "androidx.media3.ui.notification.rewind";
-  /** The action which stops playback. */
-  public static final String ACTION_STOP = "androidx.media3.ui.notification.stop";
  /** The extra key of the instance id of the player notification manager. */
  public static final String EXTRA_INSTANCE_ID = "INSTANCE_ID";
  /**
@@ -694,7 +671,6 @@ public class PlayerNotificationManager {
  private boolean useRewindActionInCompactView;
  private boolean useFastForwardActionInCompactView;
  private boolean usePlayPauseActions;
-  private boolean useStopAction;
  private int badgeIconType;
  private boolean colorized;
  private int defaults;
@@ -715,7 +691,6 @@ public class PlayerNotificationManager {
      int smallIconResourceId,
      int playActionIconResourceId,
      int pauseActionIconResourceId,
-      int stopActionIconResourceId,
      int rewindActionIconResourceId,
      int fastForwardActionIconResourceId,
      int previousActionIconResourceId,
@@ -761,7 +736,6 @@ public class PlayerNotificationManager {
            instanceId,
            playActionIconResourceId,
            pauseActionIconResourceId,
-            stopActionIconResourceId,
            rewindActionIconResourceId,
            fastForwardActionIconResourceId,
            previousActionIconResourceId,
@@ -954,19 +928,6 @@ public class PlayerNotificationManager {
  }
  /**
-   * Sets whether the stop action should be used.
-   *
-   * @param useStopAction Whether to use the stop action.
-   */
-  public final void setUseStopAction(boolean useStopAction) {
-    if (this.useStopAction == useStopAction) {
-      return;
-    }
-    this.useStopAction = useStopAction;
-    invalidate();
-  }
-  /**
   * Sets the {@link MediaSessionCompat.Token}.
   *
   * @param token The {@link MediaSessionCompat.Token}.
@@ -1293,9 +1254,9 @@ public class PlayerNotificationManager {
   * omitted:
   *
   * <pre>
-   *   +------------------------------------------------------------------------+
+   *   +-----------------------------------------------------------------+
-   *   | prev | &lt;&lt; | play/pause | &gt;&gt; | next | custom actions | stop |
+   *   | prev | &lt;&lt; | play/pause | &gt;&gt; | next | custom actions |
-   *   +------------------------------------------------------------------------+
+   *   +-----------------------------------------------------------------+
   * </pre>
   *
   * <p>This method can be safely overridden. However, the names must be of the playback actions
@@ -1333,9 +1294,6 @@ public class PlayerNotificationManager {
    if (customActionReceiver != null) {
      stringActions.addAll(customActionReceiver.getCustomActions(player));
    }
-    if (useStopAction) {
-      stringActions.add(ACTION_STOP);
-    }
    return stringActions;
  }
@@ -1427,7 +1385,6 @@ public class PlayerNotificationManager {
      int instanceId,
      int playActionIconResourceId,
      int pauseActionIconResourceId,
-      int stopActionIconResourceId,
      int rewindActionIconResourceId,
      int fastForwardActionIconResourceId,
      int previousActionIconResourceId,
@@ -1446,12 +1403,6 @@ public class PlayerNotificationManager {
            context.getString(R.string.exo_controls_pause_description),
            createBroadcastIntent(ACTION_PAUSE, context, instanceId)));
    actions.put(
-        ACTION_STOP,
-        new NotificationCompat.Action(
-            stopActionIconResourceId,
-            context.getString(R.string.exo_controls_stop_description),
-            createBroadcastIntent(ACTION_STOP, context, instanceId)));
-    actions.put(
        ACTION_REWIND,
        new NotificationCompat.Action(
            rewindActionIconResourceId,
@@ -1546,8 +1497,6 @@ public class PlayerNotificationManager {
        player.seekForward();
      } else if (ACTION_NEXT.equals(action)) {
        player.seekToNext();
-      } else if (ACTION_STOP.equals(action)) {
-        player.stop(/* reset= */ true);
      } else if (ACTION_DISMISS.equals(action)) {
        stopNotification(/* dismissedByUser= */ true);
      } else if (action != null

--- a/libraries/session/src/main/res/drawable/exo_icon_stop.xml
+++ b/libraries/session/src/main/res/drawable/exo_icon_stop.xml
-<?xml version="1.0" encoding="utf-8"?>
-<!-- Copyright 2021 The Android Open Source Project
-     Licensed under the Apache License, Version 2.0 (the "License");
-     you may not use this file except in compliance with the License.
-     You may obtain a copy of the License at
-          http://www.apache.org/licenses/LICENSE-2.0
-     Unless required by applicable law or agreed to in writing, software
-     distributed under the License is distributed on an "AS IS" BASIS,
-     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-     See the License for the specific language governing permissions and
-     limitations under the License.
-->
-<vector xmlns:android="http://schemas.android.com/apk/res/android"
-        android:width="24dp"
-        android:height="24dp"
-        android:viewportWidth="24"
-        android:viewportHeight="24">
-    <path
-        android:pathData="M0 0h24v24H0z" />
-    <path
-        android:fillColor="#000000"
-        android:pathData="M6 6h12v12H6z" />
-</vector>
--- a/libraries/session/src/main/res/values/drawables.xml
+++ b/libraries/session/src/main/res/values/drawables.xml
@@ -20,6 +20,5 @@
  <drawable name="exo_notification_previous">@drawable/exo_icon_previous</drawable>
  <drawable name="exo_notification_fastforward">@drawable/exo_icon_fastforward</drawable>
  <drawable name="exo_notification_rewind">@drawable/exo_icon_rewind</drawable>
-  <drawable name="exo_notification_stop">@drawable/exo_icon_stop</drawable>
  <drawable name="exo_notification_small_icon">@drawable/exo_icon_circular_play</drawable>
 </resources>
--- a/libraries/session/src/main/res/values/strings.xml
+++ b/libraries/session/src/main/res/values/strings.xml
@@ -36,10 +36,8 @@
    <string name="exo_controls_pause_description">Pause</string>
    <!-- Description for a media control button that causes playback to be started. [CHAR LIMIT=30] -->
    <string name="exo_controls_play_description">Play</string>
-    <!-- Description for a media control button that causes playback to be stopped. [CHAR LIMIT=30] -->
-    <string name="exo_controls_stop_description">Stop</string>
    <!-- Description for a media control button that causes playback to be rewound. [CHAR LIMIT=30] -->
    <string name="exo_controls_rewind_description">Rewind</string>
    <!-- Description for a media control button that causes playback to be fast-forwarded. [CHAR LIMIT=30] -->
    <string name="exo_controls_fastforward_description">Fast forward</string>
 </resources>
\ No newline at end of file