Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public class

RecognitionService.Callback

extends Object
java.lang.Object
   ↳ android.speech.RecognitionService.Callback

Class Overview

This class receives callbacks from the speech recognition service and forwards them to the user. An instance of this class is passed to the onStartListening(Intent, Callback) method. Recognizers may call these methods on any thread.

Summary

Public Methods
void beginningOfSpeech ()
The service should call this method when the user has started to speak.
void bufferReceived (byte[] buffer)
The service should call this method when sound has been received.
void endOfSpeech ()
The service should call this method after the user stops speaking.
void error (int error)
The service should call this method when a network or recognition error occurred.
void partialResults ( Bundle partialResults)
The service should call this method when partial recognition results are available.
void readyForSpeech ( Bundle params)
The service should call this method when the endpointer is ready for the user to start speaking.
void results ( Bundle results)
The service should call this method when recognition results are ready.
void rmsChanged (float rmsdB)
The service should call this method when the sound level in the audio stream has changed.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public void beginningOfSpeech ()

Added in API level 8

The service should call this method when the user has started to speak.

Throws
RemoteException

public void bufferReceived (byte[] buffer)

Added in API level 8

The service should call this method when sound has been received. The purpose of this function is to allow giving feedback to the user regarding the captured audio.

Parameters
buffer a buffer containing a sequence of big-endian 16-bit integers representing a single channel audio stream. The sample rate is implementation dependent.
Throws
RemoteException

public void endOfSpeech ()

Added in API level 8

The service should call this method after the user stops speaking.

Throws
RemoteException

public void error (int error)

Added in API level 8

The service should call this method when a network or recognition error occurred.

Parameters
error code is defined in SpeechRecognizer
Throws
RemoteException

public void partialResults ( Bundle partialResults)

Added in API level 8

The service should call this method when partial recognition results are available. This method can be called at any time between beginningOfSpeech() and results(Bundle) when partial results are ready. This method may be called zero, one or multiple times for each call to startListening(Intent) , depending on the speech recognition service implementation.

Parameters
partialResults the returned results. To retrieve the results in ArrayList<String> format use getStringArrayList(String) with RESULTS_RECOGNITION as a parameter
Throws
RemoteException

public void readyForSpeech ( Bundle params)

Added in API level 8

The service should call this method when the endpointer is ready for the user to start speaking.

Parameters
params parameters set by the recognition service. Reserved for future use.
Throws
RemoteException

public void results ( Bundle results)

Added in API level 8

The service should call this method when recognition results are ready.

Parameters
results the recognition results. To retrieve the results in ArrayList<String> format use getStringArrayList(String) with RESULTS_RECOGNITION as a parameter
Throws
RemoteException

public void rmsChanged (float rmsdB)

Added in API level 8

The service should call this method when the sound level in the audio stream has changed. There is no guarantee that this method will be called.

Parameters
rmsdB the new RMS dB value
Throws
RemoteException