BluetoothProfileConnectionInfo: javadoc update for LE factory methods
Update the javadoc of createLeAudioInfo and createLeAudioOutputInfo
to clarify when one is to be used over the other.
Bug: 243514151
Test: javadoc
Change-Id: Ice8bb4ff69c5ba53edb2a0bc9459f2b77cc67ebb
Merged-In: Ice8bb4ff69c5ba53edb2a0bc9459f2b77cc67ebb
diff --git a/media/java/android/media/BluetoothProfileConnectionInfo.java b/media/java/android/media/BluetoothProfileConnectionInfo.java
index a316c21..e4dc152 100644
--- a/media/java/android/media/BluetoothProfileConnectionInfo.java
+++ b/media/java/android/media/BluetoothProfileConnectionInfo.java
@@ -112,8 +112,10 @@
}
/**
- * constructor for le audio info
- *
+ * Factory method for <code>BluetoothProfileConnectionInfo</code> for an LE device
+ * Use this method for an input device connection,
+ * or for an output device connection if the connection volume is unknown,
+ * otherwise use {@link #createLeAudioOutputInfo(boolean, int)}.
* @param suppressNoisyIntent if true the {@link AudioManager.ACTION_AUDIO_BECOMING_NOISY}
* intent will not be sent.
*
@@ -127,6 +129,8 @@
/**
* Factory method for <code>BluetoothProfileConnectionInfo</code> for an LE output device
+ * Use this method for an output device connection with a volume to be used at connection
+ * time.
* @param suppressNoisyIntent if true the {@link AudioManager.ACTION_AUDIO_BECOMING_NOISY}
* intent will not be sent.
* @param volume the volume index of the device, -1 if unknown or to be ignored