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 abstract class

RecognitionService

extends Service
java.lang.Object
   ↳ android.content.Context
     ↳ android.content.ContextWrapper
       ↳ android.app.Service
         ↳ android.speech.RecognitionService

Class Overview

This class provides a base class for recognition service implementations. This class should be extended only in case you wish to implement a new speech recognizer. Please note that the implementation of this service is stateless.

Summary

Nested Classes
class RecognitionService.Callback This class receives callbacks from the speech recognition service and forwards them to the user. 
Constants
String SERVICE_INTERFACE The Intent that must be declared as handled by the service.
String SERVICE_META_DATA Name under which a RecognitionService component publishes information about itself.
[Expand]
Inherited Constants
From class android.app.Service
From class android.content.Context
From interface android.content.ComponentCallbacks2
Public Constructors
RecognitionService ()
Public Methods
final IBinder onBind ( Intent intent)
Return the communication channel to the service.
void onDestroy ()
Called by the system to notify a Service that it is no longer used and is being removed.
Protected Methods
abstract void onCancel ( RecognitionService.Callback listener)
Notifies the service that it should cancel the speech recognition.
abstract void onStartListening ( Intent recognizerIntent, RecognitionService.Callback listener)
Notifies the service that it should start listening for speech.
abstract void onStopListening ( RecognitionService.Callback listener)
Notifies the service that it should stop listening for speech.
[Expand]
Inherited Methods
From class android.app.Service
From class android.content.ContextWrapper
From class android.content.Context
From class java.lang.Object
From interface android.content.ComponentCallbacks
From interface android.content.ComponentCallbacks2

Constants

public static final String SERVICE_INTERFACE

Added in API level 8

The Intent that must be declared as handled by the service.

Constant Value: "android.speech.RecognitionService"

public static final String SERVICE_META_DATA

Added in API level 8

Name under which a RecognitionService component publishes information about itself. This meta-data should reference an XML resource containing a < recognition-service > tag.

Constant Value: "android.speech"

Public Constructors

public RecognitionService ()

Added in API level 8

Public Methods

public final IBinder onBind ( Intent intent)

Added in API level 8

Return the communication channel to the service. May return null if clients can not bind to the service. The returned IBinder is usually for a complex interface that has been described using aidl .

Note that unlike other application components, calls on to the IBinder interface returned here may not happen on the main thread of the process . More information about the main thread can be found in Processes and Threads .

Parameters
intent The Intent that was used to bind to this service, as given to Context.bindService . Note that any extras that were included with the Intent at that point will not be seen here.
Returns
  • Return an IBinder through which clients can call on to the service.

public void onDestroy ()

Added in API level 8

Called by the system to notify a Service that it is no longer used and is being removed. The service should clean up any resources it holds (threads, registered receivers, etc) at this point. Upon return, there will be no more calls in to this Service object and it is effectively dead. Do not call this method directly.

Protected Methods

protected abstract void onCancel ( RecognitionService.Callback listener)

Added in API level 8

Notifies the service that it should cancel the speech recognition.

protected abstract void onStartListening ( Intent recognizerIntent, RecognitionService.Callback listener)

Added in API level 8

Notifies the service that it should start listening for speech.

Parameters
recognizerIntent 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 should be used by the recognizer.
listener that will receive the service's callbacks

protected abstract void onStopListening ( RecognitionService.Callback listener)

Added in API level 8

Notifies the service that it should stop listening for speech. Speech captured so far should be recognized as if the user had stopped speaking at this point. This method is only called if the application calls it explicitly.