From 87f4a3ca71a75113c0a2d6d9f718934073626ac4 Mon Sep 17 00:00:00 2001
From: tonihei <tonihei@google.com>
Date: Mon, 18 Mar 2024 03:40:32 -0700
Subject: [PATCH] Add some clarifications around CommandButton.iconUri to
 Javadoc

PiperOrigin-RevId: 616775044
---
 .../androidx/media3/session/CommandButton.java   | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/libraries/session/src/main/java/androidx/media3/session/CommandButton.java b/libraries/session/src/main/java/androidx/media3/session/CommandButton.java
index 42c30d88ab..61615e432d 100644
--- a/libraries/session/src/main/java/androidx/media3/session/CommandButton.java
+++ b/libraries/session/src/main/java/androidx/media3/session/CommandButton.java
@@ -410,8 +410,8 @@ public final class CommandButton implements Bundleable {
 
     /**
      * [will be deprecated] Use {@link #Builder(int)} instead to define the {@link Icon} for this
-     * button. A separate resource id via {@link #setIconResId(int)} is no longer required unless
-     * for {@link #ICON_UNDEFINED}.
+     * button. A separate resource id via {@link #setIconResId(int)} or {@link #setIconUri} is no
+     * longer required unless for {@link #ICON_UNDEFINED}.
      */
     public Builder() {
       this(ICON_UNDEFINED);
@@ -507,6 +507,10 @@ public final class CommandButton implements Bundleable {
     /**
      * Sets a {@link Uri} for the icon of this button.
      *
+     * <p>Note that this {@link Uri} may be used when the predefined {@link Icon} is not available
+     * or set to {@link #ICON_UNDEFINED}. It can be used in addition or instead of {@link
+     * #setCustomIconResId} for consumers that are capable of loading the {@link Uri}.
+     *
      * @param uri The uri to an icon.
      * @return This builder for chaining.
      */
@@ -735,7 +739,13 @@ public final class CommandButton implements Bundleable {
    */
   @DrawableRes public final int iconResId;
 
-  /** The {@link Uri} for the icon of the button. Can be {@code null}. */
+  /**
+   * The {@link Uri} for the icon of the button that is used when the predefined {@link #icon} is
+   * not available or set to {@link #ICON_UNDEFINED}. Can be {@code null}.
+   *
+   * <p>Note that this value can be used in addition or instead of {@link #iconResId} for consumers
+   * that are capable of loading the {@link Uri}.
+   */
   @UnstableApi @Nullable public final Uri iconUri;
 
   /**