summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJean-Michel Trivi <jmtrivi@google.com>2012-01-25 09:46:01 -0800
committerAndroid (Google) Code Review <android-gerrit@google.com>2012-01-25 09:46:01 -0800
commit171070d25ee35fbd38cdbb989dab7a62df8ff8cf (patch)
tree5f64a8da691724d81f140d3c95dd2333acb9aaa1
parent00c3aaa235fe9b247d0a3cc532ee3de728b15434 (diff)
parenta701da8ebabb3d63ac57b7718055698abb21804a (diff)
downloadframeworks_base-171070d25ee35fbd38cdbb989dab7a62df8ff8cf.zip
frameworks_base-171070d25ee35fbd38cdbb989dab7a62df8ff8cf.tar.gz
frameworks_base-171070d25ee35fbd38cdbb989dab7a62df8ff8cf.tar.bz2
Merge "Update AudioTrack.stop() javadoc"
-rw-r--r--media/java/android/media/AudioTrack.java7
1 files changed, 5 insertions, 2 deletions
diff --git a/media/java/android/media/AudioTrack.java b/media/java/android/media/AudioTrack.java
index 7b2f1b7..7d4c282 100644
--- a/media/java/android/media/AudioTrack.java
+++ b/media/java/android/media/AudioTrack.java
@@ -840,7 +840,10 @@ public class AudioTrack
/**
* Stops playing the audio data.
- *
+ * When used on an instance created in {@link #MODE_STREAM} mode, audio will stop playing
+ * after the last buffer that was written has been played. For an immediate stop, use
+ * {@link #pause()}, followed by {@link #flush()} to discard audio data that hasn't been played
+ * back yet.
* @throws IllegalStateException
*/
public void stop()
@@ -859,7 +862,7 @@ public class AudioTrack
/**
* Pauses the playback of the audio data. Data that has not been played
* back will not be discarded. Subsequent calls to {@link #play} will play
- * this data back.
+ * this data back. See {@link #flush()} to discard this data.
*
* @throws IllegalStateException
*/