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

Commit 88ae4a18 authored by Phil Burk's avatar Phil Burk
Browse files

aaudio: clarify setDeviceId() behavior 

Note that the app may not get the device it requested.

Bug: 221114221
Test: just a doc change
Change-Id: Ida6ceef9435379a6d53ee921f8ce0d8dfdbbe7d8
parent 18b6ea1a

media/libaaudio/include/aaudio/AAudio.h

+10 −2
Original line number Diff line number Diff line
@@ -778,8 +778,16 @@ AAUDIO_API aaudio_result_t AAudio_createStreamBuilder(AAudioStreamBuilder** buil 
        __INTRODUCED_IN(26);



/**

 * Request an audio device identified device using an ID.

 * On Android, for example, the ID could be obtained from the Java AudioManager.

 * Request an audio device identified by an ID.

 *

 * The ID could be obtained from the Java AudioManager.

 * AudioManager.getDevices() returns an array of {@link AudioDeviceInfo},

 * which contains a getId() method. That ID can be passed to this function.

 *

 * It is possible that you may not get the device that you requested.

 * So if it is important to you, you should call

 * AAudioStream_getDeviceId() after the stream is opened to

 * verify the actual ID.

 *

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

 * in which case the primary device will be used.