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)

Added in API level 8

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

int	TRIM_MEMORY_BACKGROUND	Level for `onTrimMemory(int)` : the process has gone on to the LRU list.
int	TRIM_MEMORY_COMPLETE	Level for `onTrimMemory(int)` : the process is nearing the end of the background LRU list, and if more memory isn't found soon it will be killed.
int	TRIM_MEMORY_MODERATE	Level for `onTrimMemory(int)` : the process is around the middle of the background LRU list; freeing memory can help the system keep other processes running later in the list for better overall performance.
int	TRIM_MEMORY_RUNNING_CRITICAL	Level for `onTrimMemory(int)` : the process is not an expendable background process, but the device is running extremely low on memory and is about to not be able to keep any background processes running.
int	TRIM_MEMORY_RUNNING_LOW	Level for `onTrimMemory(int)` : the process is not an expendable background process, but the device is running low on memory.
int	TRIM_MEMORY_RUNNING_MODERATE	Level for `onTrimMemory(int)` : the process is not an expendable background process, but the device is running moderately low on memory.
int	TRIM_MEMORY_UI_HIDDEN	Level for `onTrimMemory(int)` : the process had been showing a user interface, and is no longer doing so.

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

void	dump ( FileDescriptor fd, PrintWriter writer, String[] args) Print the Service's state into the given stream.
final Application	getApplication () Return the application that owns this service.
abstract IBinder	onBind ( Intent intent) Return the communication channel to the service.
void	onConfigurationChanged ( Configuration newConfig) Called by the system when the device configuration changes while your component is running.
void	onCreate () Called by the system when the service is first created.
void	onDestroy () Called by the system to notify a Service that it is no longer used and is being removed.
void	onLowMemory () This is called when the overall system is running low on memory, and actively running processes should trim their memory usage.
void	onRebind ( Intent intent) Called when new clients have connected to the service, after it had previously been notified that all had disconnected in its `onUnbind(Intent)` .
void	onStart ( Intent intent, int startId) This method was deprecated in API level 5. Implement `onStartCommand(Intent, int, int)` instead.
int	onStartCommand ( Intent intent, int flags, int startId) Called by the system every time a client explicitly starts the service by calling `startService(Intent)` , providing the arguments it supplied and a unique integer token representing the start request.
void	onTaskRemoved ( Intent rootIntent) This is called if the service is currently running and the user has removed a task that comes from the service's application.
void	onTrimMemory (int level) Called when the operating system has determined that it is a good time for a process to trim unneeded memory from its process.
boolean	onUnbind ( Intent intent) Called when all clients have disconnected from a particular interface published by the service.
final void	startForeground (int id, Notification notification) Make this service run in the foreground, supplying the ongoing notification to be shown to the user while in this state.
final void	stopForeground (boolean removeNotification) Remove this service from foreground state, allowing it to be killed if more memory is needed.
final void	stopSelf () Stop the service, if it was previously started.
final void	stopSelf (int startId) Old version of `stopSelfResult(int)` that doesn't return a result.
final boolean	stopSelfResult (int startId) Stop the service if the most recent time it was started was `startId` .

From class android.content.ContextWrapper

From class android.content.Context

From class java.lang.Object

Object	clone () Creates and returns a copy of this `Object` .
boolean	equals ( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize () Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class <?>	getClass () Returns the unique instance of `Class` that represents this object's class.
int	hashCode () Returns an integer hash code for this object.
final void	notify () Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll () Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString () Returns a string containing a concise, human-readable description of this object.
final void	wait () Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait (long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait (long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

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.

Results

Interfaces

Classes

RecognitionService

Class Overview

Summary

Constants

public static final String SERVICE_INTERFACE

public static final String SERVICE_META_DATA

Public Constructors

public RecognitionService ()

Public Methods

public final IBinder onBind ( Intent intent)

Parameters

Returns

public void onDestroy ()

Protected Methods

protected abstract void onCancel ( RecognitionService.Callback listener)

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

Parameters

protected abstract void onStopListening ( RecognitionService.Callback listener)