summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Dirk Dougherty <ddougherty@google.com> 2013-09-13 19:53:26 -0700
committer Android Git Automerger <android-git-automerger@android.com> 2013-09-13 19:53:26 -0700
commit788fc6285a0b7f1585c5a4fa68599af7c07747e5 (patch)
tree857e4a30cd9227aaed7decb2e48ff7c91d26a86a
parent575245dc29441fc796442805caa16000f48f27cc (diff)
parent6212f6b3c5c92298fedbb37f5ceb0094b770549b (diff)
am 6212f6b3: Merge "Update documentation for speech APIs." into jb-mr2-docs
* commit '6212f6b3c5c92298fedbb37f5ceb0094b770549b': 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 457e66c6dbdd..e991d84807c1 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 8fee41d1bcb7..94aedbdf1d6a 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 */