commit d8772b24079b61018b455e602f3030284c30c7f5
author Glenn Kasten <gkasten@google.com> Fri Mar 20 10:59:40 2015 -0700
committer Glenn Kasten <gkasten@google.com> Mon Mar 23 08:03:35 2015 -0700
tree 1f945a16c3338faf2741325d8e08b4266df0e1c7
parent a5017872000a938667c76d760a866547c3719d09

Update AudioRecord comments to match AudioTrack

Change-Id: I02cb51af058277991ad0b1b5dce45744b8e8c129

include/media/AudioRecord.h

diff --git a/include/media/AudioRecord.h b/include/media/AudioRecord.h
index 5fd055c..c503f25 100644
--- a/include/media/AudioRecord.h
+++ b/include/media/AudioRecord.h
@@ -386,8 +386,14 @@
                                      struct timespec *elapsed = NULL, size_t *nonContig = NULL);
 public:
 
-    /* Release an emptied buffer of "audioBuffer->frameCount" frames for AudioFlinger to re-fill. */
-    // FIXME make private when obtainBuffer() for TRANSFER_OBTAIN is removed
+    /* Public API for TRANSFER_OBTAIN mode.
+     * Release an emptied buffer of "audioBuffer->frameCount" frames for AudioFlinger to re-fill.
+     *
+     * Buffer fields:
+     *  frameCount  currently ignored but recommend to set to actual number of frames consumed
+     *  size        actual number of bytes consumed, must be multiple of frameSize
+     *  raw         ignored
+     */
             void        releaseBuffer(const Buffer* audioBuffer);
 
     /* As a convenience we provide a read() interface to the audio buffer.