TextToSpeech.Engine Class

Definition

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
TextToSpeech.Engine
Attributes

Remarks

Android platform documentation

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 F:Android.Speech.Tts.TextToSpeech+Engine.ActionCheckTtsData intent result where the TextToSpeech engine returns an ArrayList of all the available voices. The format of each voice is: lang-COUNTRY-variant where COUNTRY and variant are optional (ie, "eng" or "eng-USA" or "eng-USA-FEMALE").

ExtraCheckVoiceDataFor
Obsolete.

Extra information sent with the F:Android.Speech.Tts.TextToSpeech+Engine.ActionCheckTtsData intent where the caller indicates to the TextToSpeech engine which specific sets of voice data to check for by sending an ArrayList of the voices that are of interest. The format of each voice is: lang-COUNTRY-variant where COUNTRY and variant are optional (ie, "eng" or "eng-USA" or "eng-USA-FEMALE").

ExtraSampleText

Extra information received with the ActionGetSampleText intent result where the TextToSpeech engine returns an String with sample text for requested voice

ExtraTtsDataInstalled
Obsolete.

Extra information received with the ActionTtsDataInstalled intent result.

ExtraUnavailableVoices

Extra information received with the F:Android.Speech.Tts.TextToSpeech+Engine.ActionCheckTtsData intent result where the TextToSpeech engine returns an ArrayList of all the unavailable voices. The format of each voice is: lang-COUNTRY-variant where COUNTRY and variant are optional (ie, "eng" or "eng-USA" or "eng-USA-FEMALE").

ExtraVoiceDataFiles
ExtraVoiceDataFilesInfo
Obsolete.

Extra information received with the F:Android.Speech.Tts.TextToSpeech+Engine.ActionCheckTtsData intent result where the TextToSpeech engine specifies the locale associated with each resource file.

ExtraVoiceDataRootDirectory
Obsolete.

Extra information received with the F:Android.Speech.Tts.TextToSpeech+Engine.ActionCheckTtsData 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
KeyFeatureNetworkSynthesis
Obsolete.

Feature key for network synthesis.

KeyFeatureNetworkTimeoutMs
KeyFeatureNotInstalled
KeyParamPan

Parameter key to specify how the speech is panned from left to right when speaking text.

KeyParamSessionId
KeyParamStream

Parameter key to specify the audio stream type to be used when speaking text or playing back a file.

KeyParamUtteranceId
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 another thread invokes the java.lang.Object#notify() method or the java.lang.Object#notifyAll() method for this object.

(Inherited from Object)
Wait(Int64)

Causes the current thread to wait until either another thread invokes the java.lang.Object#notify() method or the java.lang.Object#notifyAll() method for this object, or a specified amount of time has elapsed.

(Inherited from Object)
Wait(Int64, Int32)

Causes the current thread to wait until another thread invokes the java.lang.Object#notify() method or the java.lang.Object#notifyAll() method for this object, or some other thread interrupts the current thread, or 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