TextToSpeech.Engine Class

Reference

Definition

Namespace:: Android.Speech.Tts

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Constants and parameter names for controlling text-to-speech.

[Android.Runtime.Register("android/speech/tts/TextToSpeech$Engine", DoNotGenerateAcw=true)]
public class TextToSpeech.Engine : Java.Lang.Object

[<Android.Runtime.Register("android/speech/tts/TextToSpeech$Engine", DoNotGenerateAcw=true)>]
type TextToSpeech.Engine = class
    inherit Object

Inheritance: Object

Object
TextToSpeech.Engine

Attributes: RegisterAttribute

Remarks

Constants and parameter names for controlling text-to-speech. These include:

<ul> <li> Intents to ask engine to install data or check its data and extras for a TTS engine's check data activity. </li> <li> Keys for the parameters passed with speak commands, e.g. Engine#KEY_PARAM_UTTERANCE_ID, Engine#KEY_PARAM_STREAM. </li> <li> A list of feature strings that engines might support, e.g Engine#KEY_FEATURE_NETWORK_SYNTHESIS. These values may be passed in to TextToSpeech#speak and TextToSpeech#synthesizeToFile to modify engine behaviour. The engine can be queried for the set of features it supports through TextToSpeech#getFeatures(java.util.Locale). </li> </ul>

Apps targeting Android 11 that use text-to-speech should declare TextToSpeech.Engine#INTENT_ACTION_TTS_SERVICE in the queries elements of their manifest:

&lt;queries&gt;
              ...
             &lt;intent&gt;
                 &lt;action android:name="android.intent.action.TTS_SERVICE" /&gt;
             &lt;/intent&gt;
            &lt;/queries&gt;

Java documentation for android.speech.tts.TextToSpeech.Engine.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

TextToSpeech.Engine(IntPtr, JniHandleOwnership)	A constructor used when creating managed representations of JNI objects; called by the runtime.
TextToSpeech.Engine(TextToSpeech)

Fields

ActionCheckTtsData	Activity Action: Starts the activity from the platform TextToSpeech engine to verify the proper installation and availability of the resource files on the system.
ActionGetSampleText	Activity intent for getting some sample text to use for demonstrating TTS.
ActionInstallTtsData	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.
ActionTtsDataInstalled	Broadcast Action: broadcast to signal the change in the list of available languages or/and their features.
DefaultStream	Default audio stream used when playing synthesized speech.
ExtraAvailableVoices	Extra information received with the `#ACTION_CHECK_TTS_DATA` intent result where the TextToSpeech engine returns an ArrayList<String> of all the available voices.
ExtraCheckVoiceDataFor	Obsolete. 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<String> of the voices that are of interest.
ExtraSampleText	Extra information received with the `#ACTION_GET_SAMPLE_TEXT` intent result where the TextToSpeech engine returns an String with sample text for requested voice
ExtraTtsDataInstalled	Obsolete. Extra information received with the `#ACTION_TTS_DATA_INSTALLED` intent result.
ExtraUnavailableVoices	Extra information received with the `#ACTION_CHECK_TTS_DATA` intent result where the TextToSpeech engine returns an ArrayList<String> of all the unavailable voices.
ExtraVoiceDataFiles	Obsolete. 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.
ExtraVoiceDataFilesInfo	Obsolete. Extra information received with the `#ACTION_CHECK_TTS_DATA` intent result where the TextToSpeech engine specifies the locale associated with each resource file.
ExtraVoiceDataRootDirectory	Obsolete. Extra information received with the `#ACTION_CHECK_TTS_DATA` intent result where the TextToSpeech engine specifies the path to its resources.
IntentActionTtsService	Intent for starting a TTS service.
KeyFeatureEmbeddedSynthesis	Obsolete. Feature key for embedded synthesis.
KeyFeatureNetworkRetriesCount	Feature key that indicates that network request retries count can be set for the request.
KeyFeatureNetworkSynthesis	Obsolete. Feature key for network synthesis.
KeyFeatureNetworkTimeoutMs	Feature key that indicate that a network timeout can be set for the request.
KeyFeatureNotInstalled	Feature key that indicates that the voice may need to download additional data to be fully functional.
KeyParamPan	Parameter key to specify how the speech is panned from left to right when speaking text.
KeyParamSessionId	Parameter key to specify an audio session identifier (obtained from `AudioManager#generateAudioSessionId()`) that will be used by the request audio output.
KeyParamStream	Parameter key to specify the audio stream type to be used when speaking text or playing back a file.
KeyParamUtteranceId	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.
KeyParamVolume	Parameter key to specify the speech volume relative to the current stream type volume used when speaking text.
ServiceMetaData	Name under which a text to speech engine publishes information about itself.

Properties

Class	Returns the runtime class of this `Object`. (Inherited from Object)
Handle	The handle to the underlying Android instance. (Inherited from Object)
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
PeerReference	(Inherited from Object)
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.

Methods

Clone()	Creates and returns a copy of this object. (Inherited from Object)
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to