summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Jean-Michel Trivi <jmtrivi@google.com> 2012-01-24 16:20:31 -0800
committer Jean-Michel Trivi <jmtrivi@google.com> 2012-01-24 16:53:57 -0800
commita701da8ebabb3d63ac57b7718055698abb21804a (patch)
treec53336ca3d5a99e3a96134a4298dc5a376b7c6a6
parentd215ddf3d95b0d009ea7fc50c0d36647ebaa1c14 (diff)
Update AudioTrack.stop() javadoc
Add more information on the behavior of android.media.AudioTrack.stop() Change-Id: Id0f968e6bb8fe38765a86c43fc065908ee84edf1
-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 7b2f1b7dca59..7d4c28285851 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
*/