TtsOptions class

Constructors

TtsOptions({bool? enqueue, String? voiceName, String? extensionId, String? lang, VoiceGender? gender, double? rate, double? pitch, double? volume, List<String>? requiredEventTypes, List<String>? desiredEventTypes, JSFunction? onEvent})
TtsOptions.fromJS(TtsOptions _wrapped)

Properties

desiredEventTypes List<String>?
The TTS event types that you are interested in listening to. If missing, all event types may be sent.
getter/setter pair
enqueue bool?
If true, enqueues this utterance if TTS is already in progress. If false (the default), interrupts any current speech and flushes the speech queue before speaking this new utterance.
getter/setter pair
extensionId String?
The extension ID of the speech engine to use, if known.
getter/setter pair
gender VoiceGender?
Gender of voice for synthesized speech.
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
lang String?
The language to be used for synthesis, in the form language-region. Examples: 'en', 'en-US', 'en-GB', 'zh-CN'.
getter/setter pair
onEvent JSFunction?
This function is called with events that occur in the process of speaking the utterance.
getter/setter pair
pitch double?
Speaking pitch between 0 and 2 inclusive, with 0 being lowest and 2 being highest. 1.0 corresponds to a voice's default pitch.
getter/setter pair
rate double?
Speaking rate relative to the default rate for this voice. 1.0 is the default rate, normally around 180 to 220 words per minute. 2.0 is twice as fast, and 0.5 is half as fast. Values below 0.1 or above 10.0 are strictly disallowed, but many voices will constrain the minimum and maximum rates further-for example a particular voice may not actually speak faster than 3 times normal even if you specify a value larger than 3.0.
getter/setter pair
requiredEventTypes List<String>?
The TTS event types the voice must support.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
toJS → TtsOptions
no setter
voiceName String?
The name of the voice to use for synthesis. If empty, uses any available voice.
getter/setter pair
volume double?
Speaking volume between 0 and 1 inclusive, with 0 being lowest and 1 being highest, with a default of 1.0.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited