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

Commit 0f0da49f authored by Eric Laurent's avatar Eric Laurent
Browse files

Fix JAVA doc for AudioRecord and AudioTrack Builder 

The default sampling rate chosen for an AudioTrack or AudioRecord
constructed with a Builder not specifying a sampling rate is not
the primary output sampling rate but depends on the device actually
selected.

Bug: 29541155
Change-Id: Ifcab65418b816b7321b6e9542b9e4bb95f748f95
parent 97fb7a73

media/java/android/media/AudioRecord.java

+3 −3
Original line number Diff line number Diff line
@@ -467,11 +467,11 @@ public class AudioRecord implements AudioRouting 
     * <p>

     * If the audio source is not set with {@link #setAudioSource(int)},

     * {@link MediaRecorder.AudioSource#DEFAULT} is used.

     * <br>If the audio format is not specified or is incomplete, its sample rate will be the

     * default output sample rate of the device (see

     * {@link AudioManager#PROPERTY_OUTPUT_SAMPLE_RATE}), its channel configuration will be

     * <br>If the audio format is not specified or is incomplete, its channel configuration will be

     * {@link AudioFormat#CHANNEL_IN_MONO}, and the encoding will be

     * {@link AudioFormat#ENCODING_PCM_16BIT}.

     * The sample rate will depend on the device actually selected for capture and can be queried

     * with {@link #getSampleRate()} method.

     * <br>If the buffer size is not specified with {@link #setBufferSizeInBytes(int)},

     * the minimum buffer size for the source is used.

     */

media/java/android/media/AudioTrack.java

+3 −3
Original line number Diff line number Diff line
@@ -619,11 +619,11 @@ public class AudioTrack extends PlayerBase 
     * <p>

     * If the audio attributes are not set with {@link #setAudioAttributes(AudioAttributes)},

     * attributes comprising {@link AudioAttributes#USAGE_MEDIA} will be used.

     * <br>If the audio format is not specified or is incomplete, its sample rate will be the

     * default output sample rate of the device (see

     * {@link AudioManager#PROPERTY_OUTPUT_SAMPLE_RATE}), its channel configuration will be

     * <br>If the audio format is not specified or is incomplete, its channel configuration will be

     * {@link AudioFormat#CHANNEL_OUT_STEREO} and the encoding will be

     * {@link AudioFormat#ENCODING_PCM_16BIT}.

     * The sample rate will depend on the device actually selected for playback and can be queried

     * with {@link #getSampleRate()} method.

     * <br>If the buffer size is not specified with {@link #setBufferSizeInBytes(int)},

     * and the mode is {@link AudioTrack#MODE_STREAM}, the minimum buffer size is used.

     * <br>If the transfer mode is not specified with {@link #setTransferMode(int)},