Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 3adf7876 authored by Jean-Michel Trivi's avatar Jean-Michel Trivi
Browse files

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
parent 23f249a0

media/java/android/media/BluetoothProfileConnectionInfo.java

+6 −2
Original line number Diff line number Diff line
@@ -112,8 +112,10 @@ public final class BluetoothProfileConnectionInfo implements Parcelable { 
    }



    /**

     * 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 @@ public final class BluetoothProfileConnectionInfo implements Parcelable { 


    /**

     * 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