aaudio: more docs for AAudioStream_release
Describe a reason for calling it.
Bug: 148954731
Test: just a comment change
Change-Id: I0bfe53de84590c8ad72178a21c109af13c3b7e93
diff --git a/media/libaaudio/include/aaudio/AAudio.h b/media/libaaudio/include/aaudio/AAudio.h
index 2f43b22..edc09a9 100644
--- a/media/libaaudio/include/aaudio/AAudio.h
+++ b/media/libaaudio/include/aaudio/AAudio.h
@@ -1030,6 +1030,10 @@
*
* After this call, the stream will be in {@link #AAUDIO_STREAM_STATE_CLOSING}
*
+ * This function is useful if you want to release the audio resources immediately,
+ * but still allow queries to the stream to occur from other threads. This often
+ * happens if you are monitoring stream progress from a UI thread.
+ *
* @param stream reference provided by AAudioStreamBuilder_openStream()
* @return {@link #AAUDIO_OK} or a negative error.
*/