Links
Android Sites
Language
Results
Loading...
| java.lang.Object | |
| ↳ | android.speech.tts.TextToSpeech.Engine |
Constants and parameter names for controlling text-to-speech. These include:
KEY_PARAM_UTTERANCE_ID
,
KEY_PARAM_STREAM
.
KEY_FEATURE_NETWORK_SYNTHESIS
). These values may be passed in to
)">speak(String, int, HashMap
)
and
, java.lang.String)">synthesizeToFile(String, HashMap
, String)
to modify
engine behaviour. The engine can be queried for the set of features it supports
through
getFeatures(java.util.Locale)
.
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | ACTION_CHECK_TTS_DATA | Activity Action: Starts the activity from the platform TextToSpeech engine to verify the proper installation and availability of the resource files on the system. | |||||||||
| String | ACTION_GET_SAMPLE_TEXT | Activity intent for getting some sample text to use for demonstrating TTS. | |||||||||
| String | ACTION_INSTALL_TTS_DATA | Activity Action: Triggers the platform TextToSpeech engine to start the activity that installs the resource files on the device that are required for TTS to be operational. | |||||||||
| String | ACTION_TTS_DATA_INSTALLED | Broadcast Action: broadcast to signal the change in the list of available languages or/and their features. | |||||||||
| int | CHECK_VOICE_DATA_BAD_DATA | This constant was deprecated in API level 18. Use CHECK_VOICE_DATA_FAIL instead. | |||||||||
| int | CHECK_VOICE_DATA_FAIL |
Indicates failure when checking the installation status of the resources used by the
TextToSpeech engine with the
ACTION_CHECK_TTS_DATA
intent.
|
|||||||||
| int | CHECK_VOICE_DATA_MISSING_DATA | This constant was deprecated in API level 18. Use CHECK_VOICE_DATA_FAIL instead. | |||||||||
| int | CHECK_VOICE_DATA_MISSING_VOLUME | This constant was deprecated in API level 18. Use CHECK_VOICE_DATA_FAIL instead. | |||||||||
| int | CHECK_VOICE_DATA_PASS |
Indicates success when checking the installation status of the resources used by the
TextToSpeech engine with the
ACTION_CHECK_TTS_DATA
intent.
|
|||||||||
| int | DEFAULT_STREAM | Default audio stream used when playing synthesized speech. | |||||||||
| String | EXTRA_AVAILABLE_VOICES |
Extra information received with the
ACTION_CHECK_TTS_DATA
intent result where
the TextToSpeech engine returns an ArrayList
|
|||||||||
| String | EXTRA_CHECK_VOICE_DATA_FOR | This constant was deprecated in API level 18. Redundant functionality, checking for existence of specific sets of voice data can be done on client side. | |||||||||
| String | EXTRA_SAMPLE_TEXT |
Extra information received with the
ACTION_GET_SAMPLE_TEXT
intent result where
the TextToSpeech engine returns an String with sample text for requested voice
|
|||||||||
| String | EXTRA_TTS_DATA_INSTALLED | This constant was deprecated in API level 18. No longer in use. If client ise interested in information about what changed, is should send ACTION_CHECK_TTS_DATA intent to discover available voices. | |||||||||
| String | EXTRA_UNAVAILABLE_VOICES |
Extra information received with the
ACTION_CHECK_TTS_DATA
intent result where
the TextToSpeech engine returns an ArrayList
|
|||||||||
| String | EXTRA_VOICE_DATA_FILES | This constant was deprecated in API level 18. TTS engine implementation detail, this information has no use for text-to-speech API client. | |||||||||
| String | EXTRA_VOICE_DATA_FILES_INFO | This constant was deprecated in API level 18. TTS engine implementation detail, this information has no use for text-to-speech API client. | |||||||||
| String | EXTRA_VOICE_DATA_ROOT_DIRECTORY | This constant was deprecated in API level 18. TTS engine implementation detail, this information has no use for text-to-speech API client. | |||||||||
| String | INTENT_ACTION_TTS_SERVICE | Intent for starting a TTS service. | |||||||||
| String | KEY_FEATURE_EMBEDDED_SYNTHESIS | Feature key for embedded synthesis. | |||||||||
| String | KEY_FEATURE_NETWORK_SYNTHESIS | Feature key for network synthesis. | |||||||||
| String | KEY_PARAM_PAN | Parameter key to specify how the speech is panned from left to right when speaking text. | |||||||||
| String | KEY_PARAM_STREAM | Parameter key to specify the audio stream type to be used when speaking text or playing back a file. | |||||||||
| String | KEY_PARAM_UTTERANCE_ID |
Parameter key to identify an utterance in the
TextToSpeech.OnUtteranceCompletedListener
after text has been
spoken, a file has been played back or a silence duration has elapsed.
|
|||||||||
| String | KEY_PARAM_VOLUME | Parameter key to specify the speech volume relative to the current stream type volume used when speaking text. | |||||||||
| String | SERVICE_META_DATA | Name under which a text to speech engine publishes information about itself. | |||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
||||||||||
|
[Expand]
Inherited Methods
|
|||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
|||||||||||
Activity Action: Starts the activity from the platform TextToSpeech
engine to verify the proper installation and availability of the
resource files on the system. Upon completion, the activity will
return one of the following codes:
CHECK_VOICE_DATA_PASS
,
CHECK_VOICE_DATA_FAIL
,
Moreover, the data received in the activity result will contain the following fields:
EXTRA_AVAILABLE_VOICES
which contains an ArrayList
EXTRA_UNAVAILABLE_VOICES
which contains an ArrayList
Activity intent for getting some sample text to use for demonstrating TTS. Specific locale have to be requested by passing following extra parameters:
EXTRA_SAMPLE_TEXT
which contains an String with sample text.
Activity Action: Triggers the platform TextToSpeech engine to
start the activity that installs the resource files on the device
that are required for TTS to be operational. Since the installation
of the data can be interrupted or declined by the user, the application
shouldn't expect successful installation upon return from that intent,
and if need be, should check installation status with
ACTION_CHECK_TTS_DATA
.
Broadcast Action: broadcast to signal the change in the list of available languages or/and their features.
This constant was deprecated
in API level 18.
Use CHECK_VOICE_DATA_FAIL instead.
Indicates erroneous data when checking the installation status of the resources used by
the TextToSpeech engine with the
ACTION_CHECK_TTS_DATA
intent.
Indicates failure when checking the installation status of the resources used by the
TextToSpeech engine with the
ACTION_CHECK_TTS_DATA
intent.
This constant was deprecated
in API level 18.
Use CHECK_VOICE_DATA_FAIL instead.
Indicates missing resources when checking the installation status of the resources used
by the TextToSpeech engine with the
ACTION_CHECK_TTS_DATA
intent.
This constant was deprecated
in API level 18.
Use CHECK_VOICE_DATA_FAIL instead.
Indicates missing storage volume when checking the installation status of the resources
used by the TextToSpeech engine with the
ACTION_CHECK_TTS_DATA
intent.
Indicates success when checking the installation status of the resources used by the
TextToSpeech engine with the
ACTION_CHECK_TTS_DATA
intent.
Default audio stream used when playing synthesized speech.
Extra information received with the
ACTION_CHECK_TTS_DATA
intent result where
the TextToSpeech engine returns an ArrayList
This constant was deprecated
in API level 18.
Redundant functionality, checking for existence of specific sets of voice
data can be done on client side.
Extra information sent with the
ACTION_CHECK_TTS_DATA
intent where the
caller indicates to the TextToSpeech engine which specific sets of voice data to
check for by sending an ArrayList
Extra information received with the
ACTION_GET_SAMPLE_TEXT
intent result where
the TextToSpeech engine returns an String with sample text for requested voice
This constant was deprecated
in API level 18.
No longer in use. If client ise interested in information about what
changed, is should send ACTION_CHECK_TTS_DATA intent to discover available voices.
Extra information received with the
ACTION_TTS_DATA_INSTALLED
intent result.
It indicates whether the data files for the synthesis engine were successfully
installed. The installation was initiated with the
ACTION_INSTALL_TTS_DATA
intent. The possible values for this extra are
SUCCESS
and
ERROR
.
Extra information received with the
ACTION_CHECK_TTS_DATA
intent result where
the TextToSpeech engine returns an ArrayList
This constant was deprecated
in API level 18.
TTS engine implementation detail, this information has no use for
text-to-speech API client.
Extra information received with the
ACTION_CHECK_TTS_DATA
intent result where
the TextToSpeech engine specifies the file names of its resources under the
resource path.
This constant was deprecated
in API level 18.
TTS engine implementation detail, this information has no use for
text-to-speech API client.
Extra information received with the
ACTION_CHECK_TTS_DATA
intent result where
the TextToSpeech engine specifies the locale associated with each resource file.
This constant was deprecated
in API level 18.
TTS engine implementation detail, this information has no use for
text-to-speech API client.
Extra information received with the
ACTION_CHECK_TTS_DATA
intent result where
the TextToSpeech engine specifies the path to its resources.
It may be used by language packages to find out where to put their data.
Intent for starting a TTS service. Services that handle this intent must
extend
TextToSpeechService
. Normal applications should not use this intent
directly, instead they should talk to the TTS service using the the methods in this
class.
Feature key for embedded synthesis. See
getFeatures(Locale)
for a description of how feature keys work. If set and supported by the engine
as per
getFeatures(Locale)
, the engine must synthesize
text on-device (without making network requests).
Feature key for network synthesis. See
getFeatures(Locale)
for a description of how feature keys work. If set (and supported by the engine
as per
getFeatures(Locale)
, the engine must
use network based synthesis.
Parameter key to specify how the speech is panned from left to right when speaking text. Pan is specified as a float ranging from -1 to +1 where -1 maps to a hard-left pan, 0 to center (the default behavior), and +1 to hard-right.
Parameter key to specify the audio stream type to be used when speaking text
or playing back a file. The value should be one of the STREAM_ constants
defined in
AudioManager
.
Parameter key to identify an utterance in the
TextToSpeech.OnUtteranceCompletedListener
after text has been
spoken, a file has been played back or a silence duration has elapsed.
Parameter key to specify the speech volume relative to the current stream type volume used when speaking text. Volume is specified as a float ranging from 0 to 1 where 0 is silence, and 1 is the maximum volume (the default behavior).
Name under which a text to speech engine publishes information about itself.
This meta-data should reference an XML resource containing a
<
tts-engine
>
tag.