sjs/media
1
0
Fork 0
mirror of https://github.com/samsonjs/media.git synced 2026-04-27 15:07:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clarify CommandButton javadoc around iconResId and ICON_UNDEFINED

Browse source 
PiperOrigin-RevId: 701898620
This commit is contained in:
ibaker 2024-12-02 02:56:34 -08:00 committed by Copybara-Service
parent f113a78e0d
commit 77d33645cc
1 changed files with 27 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
libraries/session/src/main/java/androidx/media3/session/CommandButton.java
View file

@ -549,8 +549,11 @@ public final class CommandButton {
/** /**
* [will be deprecated] The icon should be defined with the constructor {@link Icon} parameter * [will be deprecated] The icon should be defined with the constructor {@link Icon} parameter
* in {@link #Builder(int)} instead. Only in case the existing list of icons is not sufficient, * in {@link #Builder(int)} instead.
* use {@link #ICON_UNDEFINED} and set a separate resource id with {@link #setCustomIconResId}. *
* <p>If the existing list of icons is not sufficient, use {@link #ICON_UNDEFINED} for the
* constructor {@link Icon} parameter, and set a separate resource id with {@link
* #setCustomIconResId}.
*/ */
@CanIgnoreReturnValue @CanIgnoreReturnValue
public Builder setIconResId(@DrawableRes int resId) { public Builder setIconResId(@DrawableRes int resId) {
@ -558,8 +561,10 @@ public final class CommandButton {
} }
/** /**
* Sets the resource id of an icon that is used when the predefined {@link Icon} is not * Sets the fallback resource ID of an icon.
* available or set to {@link #ICON_UNDEFINED}. *
* <p>This is used when either the predefined {@link #icon} is not available, or it's set to
* {@link #ICON_UNDEFINED}.
* *
* @param resId The resource id of a custom icon. * @param resId The resource id of a custom icon.
* @return This builder for chaining. * @return This builder for chaining.
@ -572,12 +577,13 @@ public final class CommandButton {
} }
/** /**
* Sets a {@linkplain ContentResolver#SCHEME_CONTENT content} or {@linkplain * Sets a fallback {@linkplain ContentResolver#SCHEME_CONTENT content} or {@linkplain
* ContentResolver#SCHEME_ANDROID_RESOURCE resource} {@link Uri} for the icon of this button. * ContentResolver#SCHEME_ANDROID_RESOURCE resource} {@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 * <p>Note that this {@link Uri} may be used when either the predefined {@link
* or set to {@link #ICON_UNDEFINED}. It can be used in addition to {@link #setCustomIconResId} * CommandButton#icon} is not available, or it's set to {@link #ICON_UNDEFINED}. It can be used
* for consumers that are capable of loading the content or resource {@link Uri}. * in addition to {@link #setCustomIconResId} for consumers that are capable of loading the
* content or resource {@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.
@ -708,16 +714,23 @@ public final class CommandButton {
@UnstableApi public final @Icon int icon; @UnstableApi public final @Icon int icon;
/** /**
* The icon resource id of the button that is used when the predefined {@link #icon} is not * The fallback icon resource ID of the button.
* available or set to {@link #ICON_UNDEFINED}. Can be {@code 0} if not needed. *
* <p>This is used when either the predefined {@link #icon} is not available, or it's set to
* {@link #ICON_UNDEFINED}.
*
* <p>Can be {@code 0} if not needed.
*/ */
@DrawableRes public final int iconResId; @DrawableRes public final int iconResId;
/** /**
* The {@linkplain ContentResolver#SCHEME_CONTENT content} or {@linkplain * The fallback {@linkplain ContentResolver#SCHEME_CONTENT content} or {@linkplain
* ContentResolver#SCHEME_ANDROID_RESOURCE resource} {@link Uri} for the icon of the button that * ContentResolver#SCHEME_ANDROID_RESOURCE resource} {@link Uri} for the icon of the button.
* is used when the predefined {@link #icon} is not available or set to {@link #ICON_UNDEFINED}. *
* Can be {@code null}. * <p>This is used when either the predefined {@link #icon} is not available, or it's set to
* {@link #ICON_UNDEFINED}.
*
* <p>Can be {@code null}.
* *
* <p>Note that this value can be used in addition to {@link #iconResId} for consumers that are * <p>Note that this value can be used in addition to {@link #iconResId} for consumers that are
* capable of loading the content or resource {@link Uri}. * capable of loading the content or resource {@link Uri}.