From a652c5b3f5689aabe9c817655105139ab204101a Mon Sep 17 00:00:00 2001
From: jbibik <jbibik@google.com>
Date: Thu, 30 May 2024 09:59:26 -0700
Subject: [PATCH] Add references in javadocs to relevant listeners for Player
 fields

PiperOrigin-RevId: 638688864
---
 .../main/java/androidx/media3/common/Player.java  | 15 ++++++++++++++-
 .../java/androidx/media3/exoplayer/ExoPlayer.java | 12 ++++++++++--
 2 files changed, 24 insertions(+), 3 deletions(-)

diff --git a/libraries/common/src/main/java/androidx/media3/common/Player.java b/libraries/common/src/main/java/androidx/media3/common/Player.java
index 0bcece4ea5..2da04b7397 100644
--- a/libraries/common/src/main/java/androidx/media3/common/Player.java
+++ b/libraries/common/src/main/java/androidx/media3/common/Player.java
@@ -2433,7 +2433,7 @@ public interface Player {
    * change.
    *
    * @return The currently available {@link Commands}.
-   * @see Listener#onAvailableCommandsChanged
+   * @see Listener#onAvailableCommandsChanged(Commands)
    */
   Commands getAvailableCommands();
 
@@ -2935,6 +2935,8 @@ public interface Player {
    *
    * <p>This method must only be called if {@link #COMMAND_GET_METADATA} is {@linkplain
    * #getAvailableCommands() available}.
+   *
+   * @see Listener#onMediaMetadataChanged(MediaMetadata)
    */
   MediaMetadata getMediaMetadata();
 
@@ -2944,6 +2946,8 @@ public interface Player {
    *
    * <p>This method must only be called if {@link #COMMAND_GET_METADATA} is {@linkplain
    * #getAvailableCommands() available}.
+   *
+   * @see Listener#onPlaylistMetadataChanged(MediaMetadata)
    */
   MediaMetadata getPlaylistMetadata();
 
@@ -3242,6 +3246,8 @@ public interface Player {
    *
    * <p>This method must only be called if {@link #COMMAND_GET_AUDIO_ATTRIBUTES} is {@linkplain
    * #getAvailableCommands() available}.
+   *
+   * @see Listener#onAudioAttributesChanged(AudioAttributes)
    */
   AudioAttributes getAudioAttributes();
 
@@ -3263,6 +3269,7 @@ public interface Player {
    * #getAvailableCommands() available}.
    *
    * @return The linear gain applied to all audio channels.
+   * @see Listener#onVolumeChanged(float)
    */
   @FloatRange(from = 0, to = 1.0)
   float getVolume();
@@ -3409,6 +3416,8 @@ public interface Player {
    *
    * <p>This method must only be called if {@link #COMMAND_GET_TEXT} is {@linkplain
    * #getAvailableCommands() available}.
+   *
+   * @see Listener#onCues(CueGroup)
    */
   CueGroup getCurrentCues();
 
@@ -3431,6 +3440,8 @@ public interface Player {
    *
    * <p>This method must only be called if {@link #COMMAND_GET_DEVICE_VOLUME} is {@linkplain
    * #getAvailableCommands() available}.
+   *
+   * @see Listener#onDeviceVolumeChanged(int, boolean)
    */
   @IntRange(from = 0)
   int getDeviceVolume();
@@ -3443,6 +3454,8 @@ public interface Player {
    *
    * <p>This method must only be called if {@link #COMMAND_GET_DEVICE_VOLUME} is {@linkplain
    * #getAvailableCommands() available}.
+   *
+   * @see Listener#onDeviceVolumeChanged(int, boolean)
    */
   boolean isDeviceMuted();
 
diff --git a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/ExoPlayer.java b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/ExoPlayer.java
index d79a4fdff3..60bfdfbbdc 100644
--- a/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/ExoPlayer.java
+++ b/libraries/exoplayer/src/main/java/androidx/media3/exoplayer/ExoPlayer.java
@@ -1627,7 +1627,11 @@ public interface ExoPlayer extends Player {
   @UnstableApi
   void setAudioSessionId(int audioSessionId);
 
-  /** Returns the audio session identifier, or {@link C#AUDIO_SESSION_ID_UNSET} if not set. */
+  /**
+   * Returns the audio session identifier, or {@link C#AUDIO_SESSION_ID_UNSET} if not set.
+   *
+   * @see Listener#onAudioSessionIdChanged(int)
+   */
   @UnstableApi
   int getAudioSessionId();
 
@@ -1657,7 +1661,11 @@ public interface ExoPlayer extends Player {
   @UnstableApi
   void setSkipSilenceEnabled(boolean skipSilenceEnabled);
 
-  /** Returns whether skipping silences in the audio stream is enabled. */
+  /**
+   * Returns whether skipping silences in the audio stream is enabled.
+   *
+   * @see Listener#onSkipSilenceEnabledChanged(boolean)
+   */
   @UnstableApi
   boolean getSkipSilenceEnabled();