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

Add some clarifications around CommandButton.iconUri to Javadoc

Browse Source 
PiperOrigin-RevId: 616775044
This commit is contained in:
tonihei 2024-03-18 03:40:32 -07:00 committed by Copybara-Service
parent cbc654a721
commit 87f4a3ca71
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
libraries/session/src/main/java/androidx/media3/session/CommandButton.java
View File

@ -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 * [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 * button. A separate resource id via {@link #setIconResId(int)} or {@link #setIconUri} is no
* for {@link #ICON_UNDEFINED}. * longer required unless for {@link #ICON_UNDEFINED}.
*/ */
public Builder() { public Builder() {
this(ICON_UNDEFINED); this(ICON_UNDEFINED);
@ -507,6 +507,10 @@ public final class CommandButton implements Bundleable {
/** /**
* Sets a {@link Uri} for the icon of this button. * 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. * @param uri The uri to an icon.
* @return This builder for chaining. * @return This builder for chaining.
*/ */
@ -735,7 +739,13 @@ public final class CommandButton implements Bundleable {
*/ */
@DrawableRes public final int iconResId; @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; @UnstableApi @Nullable public final Uri iconUri;
/** /**