summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarc Wilson <marcwilson@google.com>2013-09-11 03:52:45 -0700
committerAndroid Git Automerger <android-git-automerger@android.com>2013-09-11 03:52:45 -0700
commit02ff99c83942cdeae59e2e0abdc9b1493fe87006 (patch)
treed6bc58617eb9ee1be79264e8215ec366d10055d4
parenta339f2e5bbcfa94e9ba2cee9734a699816f3a413 (diff)
parente3af2dd7a7883c5ae60fd6b9f6fb8d434e12d66a (diff)
downloadframeworks_base-02ff99c83942cdeae59e2e0abdc9b1493fe87006.zip
frameworks_base-02ff99c83942cdeae59e2e0abdc9b1493fe87006.tar.gz
frameworks_base-02ff99c83942cdeae59e2e0abdc9b1493fe87006.tar.bz2
am e3af2dd7: Merge "Update documentation for speech APIs." into klp-dev
* commit 'e3af2dd7a7883c5ae60fd6b9f6fb8d434e12d66a': Update documentation for speech APIs.
-rw-r--r--core/java/android/speech/RecognizerIntent.java5
-rw-r--r--core/java/android/speech/SpeechRecognizer.java10
2 files changed, 12 insertions, 3 deletions
diff --git a/core/java/android/speech/RecognizerIntent.java b/core/java/android/speech/RecognizerIntent.java
index 457e66c..e991d84 100644
--- a/core/java/android/speech/RecognizerIntent.java
+++ b/core/java/android/speech/RecognizerIntent.java
@@ -55,7 +55,10 @@ public class RecognizerIntent {
* <p>Starting this intent with just {@link Activity#startActivity(Intent)} is not supported.
* You must either use {@link Activity#startActivityForResult(Intent, int)}, or provide a
* PendingIntent, to receive recognition results.
- *
+ *
+ * <p>The implementation of this API is likely to stream audio to remote servers to perform
+ * speech recognition which can use a substantial amount of bandwidth.
+ *
* <p>Required extras:
* <ul>
* <li>{@link #EXTRA_LANGUAGE_MODEL}
diff --git a/core/java/android/speech/SpeechRecognizer.java b/core/java/android/speech/SpeechRecognizer.java
index 8fee41d..94aedbd 100644
--- a/core/java/android/speech/SpeechRecognizer.java
+++ b/core/java/android/speech/SpeechRecognizer.java
@@ -39,8 +39,14 @@ import java.util.Queue;
* This class provides access to the speech recognition service. This service allows access to the
* speech recognizer. Do not instantiate this class directly, instead, call
* {@link SpeechRecognizer#createSpeechRecognizer(Context)}. This class's methods must be
- * invoked only from the main application thread. Please note that the application must have
- * {@link android.Manifest.permission#RECORD_AUDIO} permission to use this class.
+ * invoked only from the main application thread.
+ *
+ * <p>The implementation of this API is likely to stream audio to remote servers to perform speech
+ * recognition. As such this API is not intended to be used for continuous recognition, which would
+ * consume a significant amount of battery and bandwidth.
+ *
+ * <p>Please note that the application must have {@link android.Manifest.permission#RECORD_AUDIO}
+ * permission to use this class.
*/
public class SpeechRecognizer {
/** DEBUG value to enable verbose debug prints */