Commit 23c884ee by samrobinson Committed by kim-vde

Add @return to the MediaDescriptionAdapter documentation.

PiperOrigin-RevId: 383268454
parent 18ffc0f5
...@@ -176,6 +176,7 @@ public class PlayerNotificationManager { ...@@ -176,6 +176,7 @@ public class PlayerNotificationManager {
* <p>See {@link NotificationCompat.Builder#setContentTitle(CharSequence)}. * <p>See {@link NotificationCompat.Builder#setContentTitle(CharSequence)}.
* *
* @param player The {@link Player} for which a notification is being built. * @param player The {@link Player} for which a notification is being built.
* @return The content title for the current media item.
*/ */
CharSequence getCurrentContentTitle(Player player); CharSequence getCurrentContentTitle(Player player);
...@@ -185,6 +186,7 @@ public class PlayerNotificationManager { ...@@ -185,6 +186,7 @@ public class PlayerNotificationManager {
* <p>See {@link NotificationCompat.Builder#setContentIntent(PendingIntent)}. * <p>See {@link NotificationCompat.Builder#setContentIntent(PendingIntent)}.
* *
* @param player The {@link Player} for which a notification is being built. * @param player The {@link Player} for which a notification is being built.
* @return The content intent for the current media item, or null if no intent should be fired.
*/ */
@Nullable @Nullable
PendingIntent createCurrentContentIntent(Player player); PendingIntent createCurrentContentIntent(Player player);
...@@ -195,6 +197,8 @@ public class PlayerNotificationManager { ...@@ -195,6 +197,8 @@ public class PlayerNotificationManager {
* <p>See {@link NotificationCompat.Builder#setContentText(CharSequence)}. * <p>See {@link NotificationCompat.Builder#setContentText(CharSequence)}.
* *
* @param player The {@link Player} for which a notification is being built. * @param player The {@link Player} for which a notification is being built.
* @return The content text for the current media item, or null if no context text should be
* displayed.
*/ */
@Nullable @Nullable
CharSequence getCurrentContentText(Player player); CharSequence getCurrentContentText(Player player);
...@@ -205,6 +209,8 @@ public class PlayerNotificationManager { ...@@ -205,6 +209,8 @@ public class PlayerNotificationManager {
* <p>See {@link NotificationCompat.Builder#setSubText(CharSequence)}. * <p>See {@link NotificationCompat.Builder#setSubText(CharSequence)}.
* *
* @param player The {@link Player} for which a notification is being built. * @param player The {@link Player} for which a notification is being built.
* @return The content subtext for the current media item, or null if no subtext should be
* displayed.
*/ */
@Nullable @Nullable
default CharSequence getCurrentSubText(Player player) { default CharSequence getCurrentSubText(Player player) {
...@@ -223,6 +229,8 @@ public class PlayerNotificationManager { ...@@ -223,6 +229,8 @@ public class PlayerNotificationManager {
* *
* @param player The {@link Player} for which a notification is being built. * @param player The {@link Player} for which a notification is being built.
* @param callback A {@link BitmapCallback} to provide a {@link Bitmap} asynchronously. * @param callback A {@link BitmapCallback} to provide a {@link Bitmap} asynchronously.
* @return The large icon for the current media item, or null if the icon will be returned
* through the {@link BitmapCallback} or if no icon should displayed.
*/ */
@Nullable @Nullable
Bitmap getCurrentLargeIcon(Player player, BitmapCallback callback); Bitmap getCurrentLargeIcon(Player player, BitmapCallback callback);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment