Added in API level 14

public abstract class

TextToSpeechService

extends Service

java.lang.Object
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.Service
			↳	android.speech.tts.TextToSpeechService

Class Overview

Abstract base class for TTS engine implementations. The following methods need to be implemented:

The first three deal primarily with language management, and are used to query the engine for it's support for a given language and indicate to it that requests in a given language are imminent. onSynthesizeText(SynthesisRequest, SynthesisCallback) is central to the engine implementation. The implementation should synthesize text as per the request parameters and return synthesized data via the supplied callback. This class and its helpers will then consume that data, which might mean queuing it for playback or writing it to a file or similar. All calls to this method will be on a single thread, which will be different from the main thread of the service. Synthesis must be synchronous which means the engine must NOT hold on to the callback or call any methods on it after the method returns. onStop() tells the engine that it should stop all ongoing synthesis, if any. Any pending data from the current synthesis will be discarded. onGetLanguage() is not required as of JELLYBEAN_MR2 (API 18) and later, it is only called on earlier versions of Android. API Level 20 adds support for Voice objects. Voices are an abstraction that allow the TTS service to expose multiple backends for a single locale. Each one of them can have a different features set. In order to fully take advantage of voices, an engine should implement the following methods:

The first three methods are siblings of the onGetLanguage(), onIsLanguageAvailable(String, String, String) and onLoadLanguage(String, String, String) methods. The last one, onGetDefaultVoiceNameFor(String, String, String) is a link between locale and voice based methods. Since API level 21 setLanguage(Locale) is implemented by calling setVoice(Voice) with the voice returned by onGetDefaultVoiceNameFor(String, String, String). If the client uses a voice instead of a locale, SynthesisRequest will contain the requested voice name. The default implementations of Voice-related methods implement them using the pre-existing locale-based implementation.

Summary

[Expand]

Inherited Constants

From class android.app.Service

From class android.content.Context

From interface android.content.ComponentCallbacks2

Public Constructors
	TextToSpeechService()

Public Methods
IBinder	onBind(Intent intent) Return the communication channel to the service.
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.
String	onGetDefaultVoiceNameFor(String lang, String country, String variant) Return a name of the default voice for a given locale.
List<Voice>	onGetVoices() Queries the service for a set of supported voices.
int	onIsValidVoiceName(String voiceName) Checks whether the engine supports a voice with a given name.
int	onLoadVoice(String voiceName) Notifies the engine that it should load a speech synthesis voice.

Protected Methods
Set<String>	onGetFeaturesForLanguage(String lang, String country, String variant) Queries the service for a set of features supported for a given language.
abstract String[]	onGetLanguage() Returns the language, country and variant currently being used by the TTS engine.
abstract int	onIsLanguageAvailable(String lang, String country, String variant) Checks whether the engine supports a given language.
abstract int	onLoadLanguage(String lang, String country, String variant) Notifies the engine that it should load a speech synthesis language.
abstract void	onStop() Notifies the service that it should stop any in-progress speech synthesis.
abstract void	onSynthesizeText(SynthesisRequest request, SynthesisCallback callback) Tells the service to synthesize speech from the given text.

[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

void	attachBaseContext(Context base) Set the base context for this ContextWrapper.
boolean	bindService(Intent service, ServiceConnection conn, int flags) Connect to an application service, creating it if needed.
int	checkCallingOrSelfPermission(String permission) Determine whether the calling process of an IPC or you have been granted a particular permission.
int	checkCallingOrSelfUriPermission(Uri uri, int modeFlags) Determine whether the calling process of an IPC or you has been granted permission to access a specific URI.
int	checkCallingPermission(String permission) Determine whether the calling process of an IPC you are handling has been granted a particular permission.
int	checkCallingUriPermission(Uri uri, int modeFlags) Determine whether the calling process and user ID has been granted permission to access a specific URI.
int	checkPermission(String permission, int pid, int uid) Determine whether the given permission is allowed for a particular process and user ID running in the system.
int	checkUriPermission(Uri uri, int pid, int uid, int modeFlags) Determine whether a particular process and user ID has been granted permission to access a specific URI.
int	checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags) Check both a Uri and normal permission.
void	clearWallpaper() This method is deprecated. Use `WallpaperManager.clear()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
Context	createConfigurationContext(Configuration overrideConfiguration) Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration.
Context	createDisplayContext(Display display) Return a new Context object for the current Context but whose resources are adjusted to match the metrics of the given Display.
Context	createPackageContext(String packageName, int flags) Return a new Context object for the given application name.
String[]	databaseList() Returns an array of strings naming the private databases associated with this Context's application package.
boolean	deleteDatabase(String name) Delete an existing private SQLiteDatabase associated with this Context's application package.
boolean	deleteFile(String name) Delete the given private file associated with this Context's application package.
void	enforceCallingOrSelfPermission(String permission, String message) If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a `SecurityException`.
void	enforceCallingOrSelfUriPermission(Uri uri, int modeFlags, String message) If the calling process of an IPC or you has not been granted permission to access a specific URI, throw `SecurityException`.
void	enforceCallingPermission(String permission, String message) If the calling process of an IPC you are handling has not been granted a particular permission, throw a `SecurityException`.
void	enforceCallingUriPermission(Uri uri, int modeFlags, String message) If the calling process and user ID has not been granted permission to access a specific URI, throw `SecurityException`.
void	enforcePermission(String permission, int pid, int uid, String message) If the given permission is not allowed for a particular process and user ID running in the system, throw a `SecurityException`.
void	enforceUriPermission(Uri uri, int pid, int uid, int modeFlags, String message) If a particular process and user ID has not been granted permission to access a specific URI, throw `SecurityException`.
void	enforceUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message) Enforce both a Uri and normal permission.
String[]	fileList() Returns an array of strings naming the private files associated with this Context's application package.
Context	getApplicationContext() Return the context of the single, global Application object of the current process.
ApplicationInfo	getApplicationInfo() Return the full application info for this context's package.
AssetManager	getAssets() Return an AssetManager instance for your application's package.
Context	getBaseContext()
File	getCacheDir() Returns the absolute path to the application specific cache directory on the filesystem.
ClassLoader	getClassLoader() Return a class loader you can use to retrieve classes in this package.
File	getCodeCacheDir() Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code.
ContentResolver	getContentResolver() Return a ContentResolver instance for your application's package.
File	getDatabasePath(String name) Returns the absolute path on the filesystem where a database created with `openOrCreateDatabase(String, int, SQLiteDatabase.CursorFactory)` is stored.
File	getDir(String name, int mode) Retrieve, creating if needed, a new directory in which the application can place its own custom data files.
File	getExternalCacheDir() Returns the absolute path to the directory on the primary external filesystem (that is somewhere on `Environment.getExternalStorageDirectory()` where the application can place cache files it owns.
File[]	getExternalCacheDirs() Returns absolute paths to application-specific directories on all external storage devices where the application can place cache files it owns.
File	getExternalFilesDir(String type) Returns the absolute path to the directory on the primary external filesystem (that is somewhere on `Environment.getExternalStorageDirectory()`) where the application can place persistent files it owns.
File[]	getExternalFilesDirs(String type) Returns absolute paths to application-specific directories on all external storage devices where the application can place persistent files it owns.
File[]	getExternalMediaDirs() Returns absolute paths to application-specific directories on all external storage devices where the application can place media files.
File	getFileStreamPath(String name) Returns the absolute path on the filesystem where a file created with `openFileOutput(String, int)` is stored.
File	getFilesDir() Returns the absolute path to the directory on the filesystem where files created with `openFileOutput(String, int)` are stored.
Looper	getMainLooper() Return the Looper for the main thread of the current process.
File	getNoBackupFilesDir() Returns the absolute path to the directory on the filesystem similar to `getFilesDir()`.
File	getObbDir() Return the primary external storage directory where this application's OBB files (if there are any) can be found.
File[]	getObbDirs() Returns absolute paths to application-specific directories on all external storage devices where the application's OBB files (if there are any) can be found.
String	getPackageCodePath() Return the full path to this context's primary Android package.
PackageManager	getPackageManager() Return PackageManager instance to find global package information.
String	getPackageName() Return the name of this application's package.
String	getPackageResourcePath() Return the full path to this context's primary Android package.
Resources	getResources() Return a Resources instance for your application's package.
SharedPreferences	getSharedPreferences(String name, int mode) Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values.
Object	getSystemService(String name) Return the handle to a system-level service by name.
Resources.Theme	getTheme() Return the Theme object associated with this Context.
Drawable	getWallpaper() This method is deprecated. Use `WallpaperManager.get()` instead.
int	getWallpaperDesiredMinimumHeight() This method is deprecated. Use `WallpaperManager.getDesiredMinimumHeight()` instead.
int	getWallpaperDesiredMinimumWidth() This method is deprecated. Use `WallpaperManager.getDesiredMinimumWidth()` instead.
void	grantUriPermission(String toPackage, Uri uri, int modeFlags) Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider.
boolean	isRestricted() Indicates whether this Context is restricted.
FileInputStream	openFileInput(String name) Open a private file associated with this Context's application package for reading.
FileOutputStream	openFileOutput(String name, int mode) Open a private file associated with this Context's application package for writing.
SQLiteDatabase	openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory) Open a new private SQLiteDatabase associated with this Context's application package.
SQLiteDatabase	openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory, DatabaseErrorHandler errorHandler) Open a new private SQLiteDatabase associated with this Context's application package.
Drawable	peekWallpaper() This method is deprecated. Use `WallpaperManager.peek()` instead.
Intent	registerReceiver(BroadcastReceiver receiver, IntentFilter filter) Register a BroadcastReceiver to be run in the main activity thread.
Intent	registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler) Register to receive intent broadcasts, to run in the context of `scheduler`.
void	removeStickyBroadcast(Intent intent) This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
void	removeStickyBroadcastAsUser(Intent intent, UserHandle user) This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
void	revokeUriPermission(Uri uri, int modeFlags) Remove all permissions to access a particular content provider Uri that were previously added with `grantUriPermission(String, Uri, int)`.
void	sendBroadcast(Intent intent) Broadcast the given intent to all interested BroadcastReceivers.
void	sendBroadcast(Intent intent, String receiverPermission) Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.
void	sendBroadcastAsUser(Intent intent, UserHandle user) Version of `sendBroadcast(Intent)` that allows you to specify the user the broadcast will be sent to.
void	sendBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission) Version of `sendBroadcast(Intent, String)` that allows you to specify the user the broadcast will be sent to.
void	sendOrderedBroadcast(Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) Version of `sendBroadcast(Intent)` that allows you to receive data back from the broadcast.
void	sendOrderedBroadcast(Intent intent, String receiverPermission) Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.
void	sendOrderedBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) Version of `sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)` that allows you to specify the user the broadcast will be sent to.
void	sendStickyBroadcast(Intent intent) This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
void	sendStickyBroadcastAsUser(Intent intent, UserHandle user) This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
void	sendStickyOrderedBroadcast(Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
void	sendStickyOrderedBroadcastAsUser(Intent intent, UserHandle user, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) This method is deprecated. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
void	setTheme(int resid) Set the base theme for this context.
void	setWallpaper(Bitmap bitmap) This method is deprecated. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
void	setWallpaper(InputStream data) This method is deprecated. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
void	startActivities(Intent[] intents) Same as `startActivities(Intent[], Bundle)` with no options specified.
void	startActivities(Intent[] intents, Bundle options) Launch multiple new activities.
void	startActivity(Intent intent) Same as `startActivity(Intent, Bundle)` with no options specified.
void	startActivity(Intent intent, Bundle options) Launch a new activity.
boolean	startInstrumentation(ComponentName className, String profileFile, Bundle arguments) Start executing an `Instrumentation` class.
void	startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options) Like `startActivity(Intent, Bundle)`, but taking a IntentSender to start.
void	startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags) Same as `startIntentSender(IntentSender, Intent, int, int, int, Bundle)` with no options specified.
ComponentName	startService(Intent service) Request that a given application service be started.
boolean	stopService(Intent name) Request that a given application service be stopped.
void	unbindService(ServiceConnection conn) Disconnect from an application service.
void	unregisterReceiver(BroadcastReceiver receiver) Unregister a previously registered BroadcastReceiver.

From class android.content.Context

abstract boolean	bindService(Intent service, ServiceConnection conn, int flags) Connect to an application service, creating it if needed.
abstract int	checkCallingOrSelfPermission(String permission) Determine whether the calling process of an IPC or you have been granted a particular permission.
abstract int	checkCallingOrSelfUriPermission(Uri uri, int modeFlags) Determine whether the calling process of an IPC or you has been granted permission to access a specific URI.
abstract int	checkCallingPermission(String permission) Determine whether the calling process of an IPC you are handling has been granted a particular permission.
abstract int	checkCallingUriPermission(Uri uri, int modeFlags) Determine whether the calling process and user ID has been granted permission to access a specific URI.
abstract int	checkPermission(String permission, int pid, int uid) Determine whether the given permission is allowed for a particular process and user ID running in the system.
abstract int	checkUriPermission(Uri uri, int pid, int uid, int modeFlags) Determine whether a particular process and user ID has been granted permission to access a specific URI.
abstract int	checkUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags) Check both a Uri and normal permission.
abstract void	clearWallpaper() This method was deprecated in API level 5. Use `WallpaperManager.clear()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
abstract Context	createConfigurationContext(Configuration overrideConfiguration) Return a new Context object for the current Context but whose resources are adjusted to match the given Configuration.
abstract Context	createDisplayContext(Display display) Return a new Context object for the current Context but whose resources are adjusted to match the metrics of the given Display.
abstract Context	createPackageContext(String packageName, int flags) Return a new Context object for the given application name.
abstract String[]	databaseList() Returns an array of strings naming the private databases associated with this Context's application package.
abstract boolean	deleteDatabase(String name) Delete an existing private SQLiteDatabase associated with this Context's application package.
abstract boolean	deleteFile(String name) Delete the given private file associated with this Context's application package.
abstract void	enforceCallingOrSelfPermission(String permission, String message) If neither you nor the calling process of an IPC you are handling has been granted a particular permission, throw a `SecurityException`.
abstract void	enforceCallingOrSelfUriPermission(Uri uri, int modeFlags, String message) If the calling process of an IPC or you has not been granted permission to access a specific URI, throw `SecurityException`.
abstract void	enforceCallingPermission(String permission, String message) If the calling process of an IPC you are handling has not been granted a particular permission, throw a `SecurityException`.
abstract void	enforceCallingUriPermission(Uri uri, int modeFlags, String message) If the calling process and user ID has not been granted permission to access a specific URI, throw `SecurityException`.
abstract void	enforcePermission(String permission, int pid, int uid, String message) If the given permission is not allowed for a particular process and user ID running in the system, throw a `SecurityException`.
abstract void	enforceUriPermission(Uri uri, int pid, int uid, int modeFlags, String message) If a particular process and user ID has not been granted permission to access a specific URI, throw `SecurityException`.
abstract void	enforceUriPermission(Uri uri, String readPermission, String writePermission, int pid, int uid, int modeFlags, String message) Enforce both a Uri and normal permission.
abstract String[]	fileList() Returns an array of strings naming the private files associated with this Context's application package.
abstract Context	getApplicationContext() Return the context of the single, global Application object of the current process.
abstract ApplicationInfo	getApplicationInfo() Return the full application info for this context's package.
abstract AssetManager	getAssets() Return an AssetManager instance for your application's package.
abstract File	getCacheDir() Returns the absolute path to the application specific cache directory on the filesystem.
abstract ClassLoader	getClassLoader() Return a class loader you can use to retrieve classes in this package.
abstract File	getCodeCacheDir() Returns the absolute path to the application specific cache directory on the filesystem designed for storing cached code.
abstract ContentResolver	getContentResolver() Return a ContentResolver instance for your application's package.
abstract File	getDatabasePath(String name) Returns the absolute path on the filesystem where a database created with `openOrCreateDatabase(String, int, SQLiteDatabase.CursorFactory)` is stored.
abstract File	getDir(String name, int mode) Retrieve, creating if needed, a new directory in which the application can place its own custom data files.
final Drawable	getDrawable(int id) Return a drawable object associated with a particular resource ID and styled for the current theme.
abstract File	getExternalCacheDir() Returns the absolute path to the directory on the primary external filesystem (that is somewhere on `Environment.getExternalStorageDirectory()` where the application can place cache files it owns.
abstract File[]	getExternalCacheDirs() Returns absolute paths to application-specific directories on all external storage devices where the application can place cache files it owns.
abstract File	getExternalFilesDir(String type) Returns the absolute path to the directory on the primary external filesystem (that is somewhere on `Environment.getExternalStorageDirectory()`) where the application can place persistent files it owns.
abstract File[]	getExternalFilesDirs(String type) Returns absolute paths to application-specific directories on all external storage devices where the application can place persistent files it owns.
abstract File[]	getExternalMediaDirs() Returns absolute paths to application-specific directories on all external storage devices where the application can place media files.
abstract File	getFileStreamPath(String name) Returns the absolute path on the filesystem where a file created with `openFileOutput(String, int)` is stored.
abstract File	getFilesDir() Returns the absolute path to the directory on the filesystem where files created with `openFileOutput(String, int)` are stored.
abstract Looper	getMainLooper() Return the Looper for the main thread of the current process.
abstract File	getNoBackupFilesDir() Returns the absolute path to the directory on the filesystem similar to `getFilesDir()`.
abstract File	getObbDir() Return the primary external storage directory where this application's OBB files (if there are any) can be found.
abstract File[]	getObbDirs() Returns absolute paths to application-specific directories on all external storage devices where the application's OBB files (if there are any) can be found.
abstract String	getPackageCodePath() Return the full path to this context's primary Android package.
abstract PackageManager	getPackageManager() Return PackageManager instance to find global package information.
abstract String	getPackageName() Return the name of this application's package.
abstract String	getPackageResourcePath() Return the full path to this context's primary Android package.
abstract Resources	getResources() Return a Resources instance for your application's package.
abstract SharedPreferences	getSharedPreferences(String name, int mode) Retrieve and hold the contents of the preferences file 'name', returning a SharedPreferences through which you can retrieve and modify its values.
final String	getString(int resId) Return a localized string from the application's package's default string table.
final String	getString(int resId, Object... formatArgs) Return a localized formatted string from the application's package's default string table, substituting the format arguments as defined in `Formatter` and `format(String, Object...)`.
abstract Object	getSystemService(String name) Return the handle to a system-level service by name.
final CharSequence	getText(int resId) Return a localized, styled CharSequence from the application's package's default string table.
abstract Resources.Theme	getTheme() Return the Theme object associated with this Context.
abstract Drawable	getWallpaper() This method was deprecated in API level 5. Use `WallpaperManager.get()` instead.
abstract int	getWallpaperDesiredMinimumHeight() This method was deprecated in API level 5. Use `WallpaperManager.getDesiredMinimumHeight()` instead.
abstract int	getWallpaperDesiredMinimumWidth() This method was deprecated in API level 5. Use `WallpaperManager.getDesiredMinimumWidth()` instead.
abstract void	grantUriPermission(String toPackage, Uri uri, int modeFlags) Grant permission to access a specific Uri to another package, regardless of whether that package has general permission to access the Uri's content provider.
boolean	isRestricted() Indicates whether this Context is restricted.
final TypedArray	obtainStyledAttributes(int[] attrs) Retrieve styled attribute information in this Context's theme.
final TypedArray	obtainStyledAttributes(AttributeSet set, int[] attrs, int defStyleAttr, int defStyleRes) Retrieve styled attribute information in this Context's theme.
final TypedArray	obtainStyledAttributes(AttributeSet set, int[] attrs) Retrieve styled attribute information in this Context's theme.
final TypedArray	obtainStyledAttributes(int resid, int[] attrs) Retrieve styled attribute information in this Context's theme.
abstract FileInputStream	openFileInput(String name) Open a private file associated with this Context's application package for reading.
abstract FileOutputStream	openFileOutput(String name, int mode) Open a private file associated with this Context's application package for writing.
abstract SQLiteDatabase	openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory) Open a new private SQLiteDatabase associated with this Context's application package.
abstract SQLiteDatabase	openOrCreateDatabase(String name, int mode, SQLiteDatabase.CursorFactory factory, DatabaseErrorHandler errorHandler) Open a new private SQLiteDatabase associated with this Context's application package.
abstract Drawable	peekWallpaper() This method was deprecated in API level 5. Use `WallpaperManager.peek()` instead.
void	registerComponentCallbacks(ComponentCallbacks callback) Add a new `ComponentCallbacks` to the base application of the Context, which will be called at the same times as the ComponentCallbacks methods of activities and other components are called.
abstract Intent	registerReceiver(BroadcastReceiver receiver, IntentFilter filter) Register a BroadcastReceiver to be run in the main activity thread.
abstract Intent	registerReceiver(BroadcastReceiver receiver, IntentFilter filter, String broadcastPermission, Handler scheduler) Register to receive intent broadcasts, to run in the context of `scheduler`.
abstract void	removeStickyBroadcast(Intent intent) This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
abstract void	removeStickyBroadcastAsUser(Intent intent, UserHandle user) This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
abstract void	revokeUriPermission(Uri uri, int modeFlags) Remove all permissions to access a particular content provider Uri that were previously added with `grantUriPermission(String, Uri, int)`.
abstract void	sendBroadcast(Intent intent, String receiverPermission) Broadcast the given intent to all interested BroadcastReceivers, allowing an optional required permission to be enforced.
abstract void	sendBroadcast(Intent intent) Broadcast the given intent to all interested BroadcastReceivers.
abstract void	sendBroadcastAsUser(Intent intent, UserHandle user) Version of `sendBroadcast(Intent)` that allows you to specify the user the broadcast will be sent to.
abstract void	sendBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission) Version of `sendBroadcast(Intent, String)` that allows you to specify the user the broadcast will be sent to.
abstract void	sendOrderedBroadcast(Intent intent, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) Version of `sendBroadcast(Intent)` that allows you to receive data back from the broadcast.
abstract void	sendOrderedBroadcast(Intent intent, String receiverPermission) Broadcast the given intent to all interested BroadcastReceivers, delivering them one at a time to allow more preferred receivers to consume the broadcast before it is delivered to less preferred receivers.
abstract void	sendOrderedBroadcastAsUser(Intent intent, UserHandle user, String receiverPermission, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) Version of `sendOrderedBroadcast(Intent, String, BroadcastReceiver, Handler, int, String, Bundle)` that allows you to specify the user the broadcast will be sent to.
abstract void	sendStickyBroadcast(Intent intent) This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
abstract void	sendStickyBroadcastAsUser(Intent intent, UserHandle user) This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
abstract void	sendStickyOrderedBroadcast(Intent intent, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
abstract void	sendStickyOrderedBroadcastAsUser(Intent intent, UserHandle user, BroadcastReceiver resultReceiver, Handler scheduler, int initialCode, String initialData, Bundle initialExtras) This method was deprecated in API level 21. Sticky broadcasts should not be used. They provide no security (anyone can access them), no protection (anyone can modify them), and many other problems. The recommended pattern is to use a non-sticky broadcast to report that something has changed, with another mechanism for apps to retrieve the current value whenever desired.
abstract void	setTheme(int resid) Set the base theme for this context.
abstract void	setWallpaper(InputStream data) This method was deprecated in API level 5. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
abstract void	setWallpaper(Bitmap bitmap) This method was deprecated in API level 5. Use `WallpaperManager.set()` instead. This method requires the caller to hold the permission `SET_WALLPAPER`.
abstract void	startActivities(Intent[] intents, Bundle options) Launch multiple new activities.
abstract void	startActivities(Intent[] intents) Same as `startActivities(Intent[], Bundle)` with no options specified.
abstract void	startActivity(Intent intent) Same as `startActivity(Intent, Bundle)` with no options specified.
abstract void	startActivity(Intent intent, Bundle options) Launch a new activity.
abstract boolean	startInstrumentation(ComponentName className, String profileFile, Bundle arguments) Start executing an `Instrumentation` class.
abstract void	startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags, Bundle options) Like `startActivity(Intent, Bundle)`, but taking a IntentSender to start.
abstract void	startIntentSender(IntentSender intent, Intent fillInIntent, int flagsMask, int flagsValues, int extraFlags) Same as `startIntentSender(IntentSender, Intent, int, int, int, Bundle)` with no options specified.
abstract ComponentName	startService(Intent service) Request that a given application service be started.
abstract boolean	stopService(Intent service) Request that a given application service be stopped.
abstract void	unbindService(ServiceConnection conn) Disconnect from an application service.
void	unregisterComponentCallbacks(ComponentCallbacks callback) Remove a `ComponentCallbacks` object that was previously registered with `registerComponentCallbacks(ComponentCallbacks)`.
abstract void	unregisterReceiver(BroadcastReceiver receiver) Unregister a previously registered BroadcastReceiver.

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

From interface android.content.ComponentCallbacks

Public Constructors

public TextToSpeechService ()

Added in API level 14

Public Methods

public IBinder onBind (Intent intent)

Added in API level 14

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 onCreate ()

Added in API level 14

Called by the system when the service is first created. Do not call this method directly.

public void onDestroy ()

Added in API level 14

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.

public String onGetDefaultVoiceNameFor (String lang, String country, String variant)

Added in API level 21

Return a name of the default voice for a given locale. This method provides a mapping between locales and available voices. This method is used in setLanguage(Locale), which calls this method and then calls setVoice(Voice) with the voice returned by this method. Also, it's used by getDefaultVoice() to find a default voice for the default locale.

Parameters

lang	ISO-3 language code.
country	ISO-3 country code. May be empty or null.
variant	Language variant. May be empty or null.

Returns

A name of the default voice for a given locale.

public List<Voice> onGetVoices ()

Added in API level 21

Queries the service for a set of supported voices. Can be called on multiple threads. The default implementation tries to enumerate all available locales, pass them to onIsLanguageAvailable(String, String, String) and create Voice instances (using the locale's BCP-47 language tag as the voice name) for the ones that are supported. Note, that this implementation is suitable only for engines that don't have multiple voices for a single locale. Also, this implementation won't work with Locales not listed in the set returned by the getAvailableLocales() method.

Returns

A list of voices supported.

public int onIsValidVoiceName (String voiceName)

Added in API level 21

Checks whether the engine supports a voice with a given name. Can be called on multiple threads. The default implementation treats the voice name as a language tag, creating a Locale from the voice name, and passes it to onIsLanguageAvailable(String, String, String).

Parameters

voiceName	Name of the voice.

Returns

ERROR or SUCCESS.

public int onLoadVoice (String voiceName)

Added in API level 21

Notifies the engine that it should load a speech synthesis voice. There is no guarantee that this method is always called before the voice is used for synthesis. It is merely a hint to the engine that it will probably get some synthesis requests for this voice at some point in the future. Will be called only on synthesis thread. The default implementation creates a Locale from the voice name (by interpreting the name as a BCP-47 tag for the locale), and passes it to onLoadLanguage(String, String, String).

Parameters

voiceName	Name of the voice.

Returns

ERROR or SUCCESS.

Protected Methods

protected Set<String> onGetFeaturesForLanguage (String lang, String country, String variant)

Added in API level 15

Queries the service for a set of features supported for a given language. Can be called on multiple threads.

Parameters

lang	ISO-3 language code.
country	ISO-3 country code. May be empty or null.
variant	Language variant. May be empty or null.

Returns

A list of features supported for the given language.

protected abstract String[] onGetLanguage ()

Added in API level 14

Returns the language, country and variant currently being used by the TTS engine. This method will be called only on Android 4.2 and before (API <= 17). In later versions this method is not called by the Android TTS framework. Can be called on multiple threads.

Returns

A 3-element array, containing language (ISO 3-letter code), country (ISO 3-letter code) and variant used by the engine. The country and variant may be "". If country is empty, then variant must be empty too.

protected abstract int onIsLanguageAvailable (String lang, String country, String variant)

Added in API level 14

Checks whether the engine supports a given language. Can be called on multiple threads. Its return values HAVE to be consistent with onLoadLanguage.

Parameters

lang	ISO-3 language code.
country	ISO-3 country code. May be empty or null.
variant	Language variant. May be empty or null.

Returns

Code indicating the support status for the locale. One of LANG_AVAILABLE, LANG_COUNTRY_AVAILABLE, LANG_COUNTRY_VAR_AVAILABLE, LANG_MISSING_DATA LANG_NOT_SUPPORTED.

protected abstract int onLoadLanguage (String lang, String country, String variant)

Added in API level 14

Notifies the engine that it should load a speech synthesis language. There is no guarantee that this method is always called before the language is used for synthesis. It is merely a hint to the engine that it will probably get some synthesis requests for this language at some point in the future. Can be called on multiple threads. In <= Android 4.2 (<= API 17) can be called on main and service binder threads. In > Android 4.2 (> API 17) can be called on main and synthesis threads.

Parameters

lang	ISO-3 language code.
country	ISO-3 country code. May be empty or null.
variant	Language variant. May be empty or null.

Returns

Code indicating the support status for the locale. One of LANG_AVAILABLE, LANG_COUNTRY_AVAILABLE, LANG_COUNTRY_VAR_AVAILABLE, LANG_MISSING_DATA LANG_NOT_SUPPORTED.

protected abstract void onStop ()

Added in API level 14

Notifies the service that it should stop any in-progress speech synthesis. This method can be called even if no speech synthesis is currently in progress. Can be called on multiple threads, but not on the synthesis thread.

protected abstract void onSynthesizeText (SynthesisRequest request, SynthesisCallback callback)

Added in API level 14

Tells the service to synthesize speech from the given text. This method should block until the synthesis is finished. Used for requests from V1 clients (TextToSpeech). Called on the synthesis thread.

Parameters

request	The synthesis request.
callback	The callback that the engine must use to make data available for playback or for writing to a file.

Results

Interfaces

Classes

TextToSpeechService

Class Overview

Summary

Public Constructors

public TextToSpeechService ()

Public Methods

public IBinder onBind (Intent intent)

Parameters

Returns

public void onCreate ()

public void onDestroy ()

public String onGetDefaultVoiceNameFor (String lang, String country, String variant)

Parameters

Returns

public List<Voice> onGetVoices ()

Returns

public int onIsValidVoiceName (String voiceName)

Parameters

Returns

public int onLoadVoice (String voiceName)

Parameters

Returns

Protected Methods

protected Set<String> onGetFeaturesForLanguage (String lang, String country, String variant)

Parameters

Returns

protected abstract String[] onGetLanguage ()

Returns

See Also

protected abstract int onIsLanguageAvailable (String lang, String country, String variant)

Parameters

Returns

protected abstract int onLoadLanguage (String lang, String country, String variant)

Parameters

Returns

protected abstract void onStop ()

protected abstract void onSynthesizeText (SynthesisRequest request, SynthesisCallback callback)

Parameters