public
class
SpeechRecognizer
extends Object
| java.lang.Object | |
| ↳ | android.speech.SpeechRecognizer |
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
createSpeechRecognizer(Context). This class's methods must be
invoked only from the main application thread.
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.
Please note that the application must have RECORD_AUDIO
permission to use this class.
Constants | |
|---|---|
String |
CONFIDENCE_SCORES
Key used to retrieve a float array from the |
int |
ERROR_AUDIO
Audio recording error. |
int |
ERROR_CLIENT
Other client side errors. |
int |
ERROR_INSUFFICIENT_PERMISSIONS
Insufficient permissions |
int |
ERROR_NETWORK
Other network related errors. |
int |
ERROR_NETWORK_TIMEOUT
Network operation timed out. |
int |
ERROR_NO_MATCH
No recognition result matched. |
int |
ERROR_RECOGNIZER_BUSY
RecognitionService busy. |
int |
ERROR_SERVER
Server sends error status. |
int |
ERROR_SPEECH_TIMEOUT
No speech input |
String |
RESULTS_RECOGNITION
Key used to retrieve an |
Public methods | |
|---|---|
void
|
cancel()
Cancels the speech recognition. |
static
SpeechRecognizer
|
createSpeechRecognizer(Context context)
Factory method to create a new |
static
SpeechRecognizer
|
createSpeechRecognizer(Context context, ComponentName serviceComponent)
Factory method to create a new |
void
|
destroy()
Destroys the |
static
boolean
|
isRecognitionAvailable(Context context)
Checks whether a speech recognition service is available on the system. |
void
|
setRecognitionListener(RecognitionListener listener)
Sets the listener that will receive all the callbacks. |
void
|
startListening(Intent recognizerIntent)
Starts listening for speech. |
void
|
stopListening()
Stops listening for speech. |
Inherited methods | |
|---|---|
 From
class
java.lang.Object
| |
String CONFIDENCE_SCORES
Key used to retrieve a float array from the Bundle passed to the
onResults(Bundle) and
onPartialResults(Bundle) methods. The array should be
the same size as the ArrayList provided in RESULTS_RECOGNITION, and should contain
values ranging from 0.0 to 1.0, or -1 to represent an unavailable confidence score.
Confidence values close to 1.0 indicate high confidence (the speech recognizer is confident that the recognition result is correct), while values close to 0.0 indicate low confidence.
This value is optional and might not be provided.
Constant Value: "confidence_scores"
int ERROR_AUDIO
Audio recording error.
Constant Value: 3 (0x00000003)
int ERROR_CLIENT
Other client side errors.
Constant Value: 5 (0x00000005)
int ERROR_INSUFFICIENT_PERMISSIONS
Insufficient permissions
Constant Value: 9 (0x00000009)
int ERROR_NETWORK
Other network related errors.
Constant Value: 2 (0x00000002)
int ERROR_NETWORK_TIMEOUT
Network operation timed out.
Constant Value: 1 (0x00000001)
int ERROR_NO_MATCH
No recognition result matched.
Constant Value: 7 (0x00000007)
int ERROR_RECOGNIZER_BUSY
RecognitionService busy.
Constant Value: 8 (0x00000008)
int ERROR_SERVER
Server sends error status.
Constant Value: 4 (0x00000004)
int ERROR_SPEECH_TIMEOUT
No speech input
Constant Value: 6 (0x00000006)
String RESULTS_RECOGNITION
Key used to retrieve an ArrayList<String> from the Bundle passed to the
onResults(Bundle) and
onPartialResults(Bundle) methods. These strings are the possible
recognition results, where the first element is the most likely candidate.
Constant Value: "results_recognition"
void cancel ()
Cancels the speech recognition. Please note that
setRecognitionListener(RecognitionListener) should be called beforehand, otherwise
no notifications will be received.
SpeechRecognizer createSpeechRecognizer (Context context)
Factory method to create a new SpeechRecognizer. Please note that
setRecognitionListener(RecognitionListener) should be called before dispatching any
command to the created SpeechRecognizer, otherwise no notifications will be
received.
| Parameters | |
|---|---|
context |
Context:
in which to create SpeechRecognizer |
| Returns | |
|---|---|
SpeechRecognizer |
a new SpeechRecognizer
|
SpeechRecognizer createSpeechRecognizer (Context context, ComponentName serviceComponent)
Factory method to create a new SpeechRecognizer. Please note that
setRecognitionListener(RecognitionListener) should be called before dispatching any
command to the created SpeechRecognizer, otherwise no notifications will be
received.
Use this version of the method to specify a specific service to direct this
SpeechRecognizer to. Normally you would not use this; use
createSpeechRecognizer(Context) instead to use the system default recognition
service.
| Parameters | |
|---|---|
context |
Context:
in which to create SpeechRecognizer |
serviceComponent |
ComponentName:
the ComponentName of a specific service to direct this
SpeechRecognizer to |
| Returns | |
|---|---|
SpeechRecognizer |
a new SpeechRecognizer
|
boolean isRecognitionAvailable (Context context)
Checks whether a speech recognition service is available on the system. If this method
returns false, createSpeechRecognizer(Context) will
fail.
| Parameters | |
|---|---|
context |
Context:
with which SpeechRecognizer will be created |
| Returns | |
|---|---|
boolean |
true if recognition is available, false otherwise
|
void setRecognitionListener (RecognitionListener listener)
Sets the listener that will receive all the callbacks. The previous unfinished commands will be executed with the old listener, while any following command will be executed with the new listener.
| Parameters | |
|---|---|
listener |
RecognitionListener:
listener that will receive all the callbacks from the created
SpeechRecognizer, this must not be null.
|
void startListening (Intent recognizerIntent)
Starts listening for speech. Please note that
setRecognitionListener(RecognitionListener) should be called beforehand, otherwise
no notifications will be received.
| Parameters | |
|---|---|
recognizerIntent |
Intent:
contains parameters for the recognition to be performed. The intent
may also contain optional extras, see RecognizerIntent. If these values are
not set explicitly, default values will be used by the recognizer.
|
void stopListening ()
Stops listening for speech. Speech captured so far will be recognized as if the user had
stopped speaking at this point. Note that in the default case, this does not need to be
called, as the speech endpointer will automatically stop the recognizer listening when it
determines speech has completed. However, you can manipulate endpointer parameters directly
using the intent extras defined in RecognizerIntent, in which case you may sometimes
want to manually call this method to stop listening sooner. Please note that
setRecognitionListener(RecognitionListener) should be called beforehand, otherwise
no notifications will be received.
Developers