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

Commit 519e00d7 authored by Robert Wu's avatar Robert Wu
Browse files

AAudio: Document setVolumeControlStream() 

After setting usage and content type, call setVolumeControlStream().

Bug: 329674722
Test: presubmit
Flag: DOCS_ONLY
Change-Id: Ifde943f94bae4bb5a5bf9994a31975e91a1e2b2e
parent 1c3a5f28

media/libaaudio/include/aaudio/AAudio.h

+22 −0
Original line number Diff line number Diff line
@@ -1115,6 +1115,17 @@ AAUDIO_API void AAudioStreamBuilder_setPerformanceMode(AAudioStreamBuilder* _Non 
 *

 * The default, if you do not call this function, is {@link #AAUDIO_USAGE_MEDIA}.

 *

 * If you set Usage then you will need to associate the volume keys with the resulting stream.

 * Otherwise the volume keys may not work correctly.

 * This is done in Java with the following code block.

 *

 * <pre><code>if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {

 *     AudioAttributes attributes = new AudioAttributes.Builder().setUsage(usage)

 *             .setContentType(contentType).build();

 *     setVolumeControlStream(attributes.getVolumeControlStream());

 * }

 * </code></pre>

 *

 * Available since API level 28.

 *

 * @param builder reference provided by AAudio_createStreamBuilder()
@@ -1132,6 +1143,17 @@ AAUDIO_API void AAudioStreamBuilder_setUsage(AAudioStreamBuilder* _Nonnull build 
 *

 * The default, if you do not call this function, is {@link #AAUDIO_CONTENT_TYPE_MUSIC}.

 *

 * If you set ContentType then you will need to associate the volume keys with the resulting stream.

 * Otherwise the volume keys may not work correctly.

 * This is done in Java with the following code block.

 *

 * <pre><code>if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {

 *     AudioAttributes attributes = new AudioAttributes.Builder().setUsage(usage)

 *             .setContentType(contentType).build();

 *     setVolumeControlStream(attributes.getVolumeControlStream());

 * }

 * </code></pre>

 *

 * Available since API level 28.

 *

 * @param builder reference provided by AAudio_createStreamBuilder()