Most visited

Recently visited

Results for

Summary: Constants | Methods | Inherited Methods

SpeechRecognizer

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 SpeechRecognizer#createSpeechRecognizer(Context), or SpeechRecognizer#createOnDeviceSpeechRecognizer(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 Manifest.permission.RECORD_AUDIO permission to use this class.

Summary

Constants
`String`	`CONFIDENCE_SCORES` Key used to retrieve a float array from the `Bundle` passed to the `RecognitionListener#onResults(Bundle)` and `RecognitionListener#onPartialResults(Bundle)` methods.
`int`	`ERROR_AUDIO` Audio recording error.
`int`	`ERROR_CLIENT` Other client side errors.
`int`	`ERROR_INSUFFICIENT_PERMISSIONS` Insufficient permissions
`int`	`ERROR_LANGUAGE_NOT_SUPPORTED` Requested language is not available to be used with the current recognizer.
`int`	`ERROR_LANGUAGE_UNAVAILABLE` Requested language is supported, but not available currently (e.g. not downloaded yet).
`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_SERVER_DISCONNECTED` Server has been disconnected, e.g. because the app has crashed.
`int`	`ERROR_SPEECH_TIMEOUT` No speech input
`int`	`ERROR_TOO_MANY_REQUESTS` Too many requests from the same client.
`String`	`RESULTS_RECOGNITION` Key used to retrieve an `ArrayList<String>` from the `Bundle` passed to the `RecognitionListener#onResults(Bundle)` and `RecognitionListener#onPartialResults(Bundle)` methods.

Public methods
`void`	`cancel()` Cancels the speech recognition.
`static SpeechRecognizer`	`createOnDeviceSpeechRecognizer(Context context)` Factory method to create a new `SpeechRecognizer`.
`static SpeechRecognizer`	`createSpeechRecognizer(Context context)` Factory method to create a new `SpeechRecognizer`.
`static SpeechRecognizer`	`createSpeechRecognizer(Context context, ComponentName serviceComponent)` Factory method to create a new `SpeechRecognizer`.
`void`	`destroy()` Destroys the `SpeechRecognizer` object.
`static boolean`	`isOnDeviceRecognitionAvailable(Context context)` Checks whether an on-device speech recognition service is available on the system.
`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

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Constants

CONFIDENCE_SCORES

public static final String CONFIDENCE_SCORES

Key used to retrieve a float array from the Bundle passed to the RecognitionListener#onResults(Bundle) and RecognitionListener#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"

ERROR_AUDIO

public static final int ERROR_AUDIO

Audio recording error.

Constant Value: 3 (0x00000003)

ERROR_CLIENT

public static final int ERROR_CLIENT

Other client side errors.

Constant Value: 5 (0x00000005)

ERROR_INSUFFICIENT_PERMISSIONS

public static final int ERROR_INSUFFICIENT_PERMISSIONS

Insufficient permissions

Constant Value: 9 (0x00000009)

ERROR_LANGUAGE_NOT_SUPPORTED

public static final int ERROR_LANGUAGE_NOT_SUPPORTED

Requested language is not available to be used with the current recognizer.

Constant Value: 12 (0x0000000c)

ERROR_LANGUAGE_UNAVAILABLE

public static final int ERROR_LANGUAGE_UNAVAILABLE

Requested language is supported, but not available currently (e.g. not downloaded yet).

Constant Value: 13 (0x0000000d)

ERROR_NETWORK

public static final int ERROR_NETWORK

Other network related errors.

Constant Value: 2 (0x00000002)

ERROR_NETWORK_TIMEOUT

public static final int ERROR_NETWORK_TIMEOUT

Network operation timed out.

Constant Value: 1 (0x00000001)

ERROR_NO_MATCH

public static final int ERROR_NO_MATCH

No recognition result matched.

Constant Value: 7 (0x00000007)

ERROR_RECOGNIZER_BUSY

public static final int ERROR_RECOGNIZER_BUSY

RecognitionService busy.

Constant Value: 8 (0x00000008)

ERROR_SERVER

public static final int ERROR_SERVER

Server sends error status.

Constant Value: 4 (0x00000004)

ERROR_SERVER_DISCONNECTED

public static final int ERROR_SERVER_DISCONNECTED

Server has been disconnected, e.g. because the app has crashed.

Constant Value: 11 (0x0000000b)

ERROR_SPEECH_TIMEOUT

public static final int ERROR_SPEECH_TIMEOUT

No speech input

Constant Value: 6 (0x00000006)

ERROR_TOO_MANY_REQUESTS

public static final int ERROR_TOO_MANY_REQUESTS

Too many requests from the same client.

Constant Value: 10 (0x0000000a)

RESULTS_RECOGNITION

public static final String RESULTS_RECOGNITION

Key used to retrieve an ArrayList<String> from the Bundle passed to the RecognitionListener#onResults(Bundle) and RecognitionListener#onPartialResults(Bundle) methods. These strings are the possible recognition results, where the first element is the most likely candidate.

Constant Value: "results_recognition"

Public methods

cancel

public void cancel ()

Cancels the speech recognition. Please note that setRecognitionListener(android.speech.RecognitionListener) should be called beforehand, otherwise no notifications will be received.
This method must be called from the main thread of your app.

createOnDeviceSpeechRecognizer

public static SpeechRecognizer createOnDeviceSpeechRecognizer (Context context)

Factory method to create a new SpeechRecognizer.

Please note that setRecognitionListener(android.speech.RecognitionListener) should be called before dispatching any command to the created SpeechRecognizer, otherwise no notifications will be received.
This method must be called from the main thread of your app.

Parameters
`context`	`Context`: in which to create `SpeechRecognizer` This value cannot be `null`.

Returns
`SpeechRecognizer`	a new on-device `SpeechRecognizer`. This value cannot be `null`.

Throws
`UnsupportedOperationException`	iff `isOnDeviceRecognitionAvailable(android.content.Context)` is false

createSpeechRecognizer

public static SpeechRecognizer createSpeechRecognizer (Context context)

Factory method to create a new SpeechRecognizer. Please note that setRecognitionListener(android.speech.RecognitionListener) should be called before dispatching any command to the created SpeechRecognizer, otherwise no notifications will be received.

For apps targeting Android 11 (API level 30) interaction with a speech recognition service requires element to be added to the manifest file:

<queries>
   <intent>
     <action
        android:name="android.speech.RecognitionService" />
   </intent>
 </queries>

This method must be called from the main thread of your app.

Parameters
`context`	`Context`: in which to create `SpeechRecognizer`

Returns
`SpeechRecognizer`	a new `SpeechRecognizer`

createSpeechRecognizer

public static SpeechRecognizer createSpeechRecognizer (Context context, 
                ComponentName serviceComponent)

Important: before calling this method, please check via PackageManager.queryIntentServices(Intent, int) that serviceComponent actually exists and provides RecognitionService#SERVICE_INTERFACE. Normally you would not use this; call createSpeechRecognizer(android.content.Context) to use the system default recognition service instead or createOnDeviceSpeechRecognizer(android.content.Context) to use on-device recognition.

For apps targeting Android 11 (API level 30) interaction with a speech recognition service requires element to be added to the manifest file:

<queries>
   <intent>
     <action
        android:name="android.speech.RecognitionService" />
   </intent>
 </queries>

This method must be called from the main thread of your app.

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`

destroy

public void destroy ()

Destroys the SpeechRecognizer object.

isOnDeviceRecognitionAvailable

public static boolean isOnDeviceRecognitionAvailable (Context context)

Checks whether an on-device speech recognition service is available on the system. If this method returns false, SpeechRecognizer#createOnDeviceSpeechRecognizer(Context) will fail.

Parameters
`context`	`Context`: with which on-device `SpeechRecognizer` will be created This value cannot be `null`.

Returns
`boolean`	`true` if on-device recognition is available, `false` otherwise

isRecognitionAvailable

public static boolean isRecognitionAvailable (Context context)

Checks whether a speech recognition service is available on the system. If this method returns false, SpeechRecognizer#createSpeechRecognizer(Context) will fail.

Parameters
`context`	`Context`: with which `SpeechRecognizer` will be created This value cannot be `null`.

Returns
`boolean`	`true` if recognition is available, `false` otherwise

setRecognitionListener

public 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.
This method must be called from the main thread of your app.

Parameters
`listener`	`RecognitionListener`: listener that will receive all the callbacks from the created `SpeechRecognizer`, this must not be null.

startListening

public void startListening (Intent recognizerIntent)

Starts listening for speech. Please note that setRecognitionListener(android.speech.RecognitionListener) should be called beforehand, otherwise no notifications will be received.
This method must be called from the main thread of your app.

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.

stopListening

public 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.

Upon invocation clients must wait until RecognitionListener#onResults or RecognitionListener#onError are invoked before calling SpeechRecognizer#startListening again. Otherwise such an attempt would be rejected by recognition service.

Please note that setRecognitionListener(android.speech.RecognitionListener) should be called beforehand, otherwise no notifications will be received.
This method must be called from the main thread of your app.

Interfaces

Classes

Most visited

Recently visited

Results for

SpeechRecognizer

Summary

Constants

Public methods

Inherited methods

Constants

CONFIDENCE_SCORES

ERROR_AUDIO

ERROR_CLIENT

ERROR_INSUFFICIENT_PERMISSIONS

ERROR_LANGUAGE_NOT_SUPPORTED

ERROR_LANGUAGE_UNAVAILABLE

ERROR_NETWORK

ERROR_NETWORK_TIMEOUT

ERROR_NO_MATCH

ERROR_RECOGNIZER_BUSY

ERROR_SERVER

ERROR_SERVER_DISCONNECTED

ERROR_SPEECH_TIMEOUT

ERROR_TOO_MANY_REQUESTS

RESULTS_RECOGNITION

Public methods

cancel

createOnDeviceSpeechRecognizer

createSpeechRecognizer

createSpeechRecognizer

destroy

isOnDeviceRecognitionAvailable

isRecognitionAvailable

setRecognitionListener

startListening

stopListening