summaryrefslogtreecommitdiffstats
path: root/media
diff options
context:
space:
mode:
authorGlenn Kasten <gkasten@google.com>2015-01-28 16:45:15 -0800
committerGlenn Kasten <gkasten@google.com>2015-02-02 14:16:23 -0800
commit7a121563d5c94ca0b88539afd8a7e86cc9118b60 (patch)
treeb00a6022abce7d0abcfe8128c26e0c5c2905e21f /media
parentcd4c8525fa18b5c2e96de781edf113e9972e2ba2 (diff)
downloadframeworks_base-7a121563d5c94ca0b88539afd8a7e86cc9118b60.zip
frameworks_base-7a121563d5c94ca0b88539afd8a7e86cc9118b60.tar.gz
frameworks_base-7a121563d5c94ca0b88539afd8a7e86cc9118b60.tar.bz2
Clarify that flush does not necessarily free up buffer space
Change-Id: I6f77efb6a8da5e11c0cc68f0bb3ce47a0c1cb3da
Diffstat (limited to 'media')
-rw-r--r--media/java/android/media/AudioTrack.java8
1 files changed, 7 insertions, 1 deletions
diff --git a/media/java/android/media/AudioTrack.java b/media/java/android/media/AudioTrack.java
index 1af0372..caccb6e 100644
--- a/media/java/android/media/AudioTrack.java
+++ b/media/java/android/media/AudioTrack.java
@@ -1237,8 +1237,14 @@ public class AudioTrack
/**
* Flushes the audio data currently queued for playback. Any data that has
- * not been played back will be discarded. No-op if not stopped or paused,
+ * been written but not yet presented will be discarded. No-op if not stopped or paused,
* or if the track's creation mode is not {@link #MODE_STREAM}.
+ * <BR> Note that although data written but not yet presented is discarded, there is no
+ * guarantee that all of the buffer space formerly used by that data
+ * is available for a subsequent write.
+ * For example, a call to {@link #write(byte[], int, int)} with <code>sizeInBytes</code>
+ * less than or equal to the total buffer size
+ * may return a short actual transfer count.
*/
public void flush() {
if (mState == STATE_INITIALIZED) {