am e3af2dd7: Merge "Update documentation for speech APIs." into klp-dev

* commit 'e3af2dd7a7883c5ae60fd6b9f6fb8d434e12d66a':
  Update documentation for speech APIs.
This commit is contained in:
Marc Wilson
2013-09-11 03:52:45 -07:00
committed by Android Git Automerger
2 changed files with 12 additions and 3 deletions

View File

@@ -55,7 +55,10 @@ public class RecognizerIntent {
* <p>Starting this intent with just {@link Activity#startActivity(Intent)} is not supported. * <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 * You must either use {@link Activity#startActivityForResult(Intent, int)}, or provide a
* PendingIntent, to receive recognition results. * 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: * <p>Required extras:
* <ul> * <ul>
* <li>{@link #EXTRA_LANGUAGE_MODEL} * <li>{@link #EXTRA_LANGUAGE_MODEL}

View File

@@ -39,8 +39,14 @@ import java.util.Queue;
* This class provides access to the speech recognition service. This service allows access to the * 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 * speech recognizer. Do not instantiate this class directly, instead, call
* {@link SpeechRecognizer#createSpeechRecognizer(Context)}. This class's methods must be * {@link SpeechRecognizer#createSpeechRecognizer(Context)}. This class's methods must be
* invoked only from the main application thread. Please note that the application must have * invoked only from the main application thread.
* {@link android.Manifest.permission#RECORD_AUDIO} permission to use this class. *
* <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 { public class SpeechRecognizer {
/** DEBUG value to enable verbose debug prints */ /** DEBUG value to enable verbose debug prints */