TTSOptions class
- Available extensions
Constructors
- TTSOptions({String? voice, String? languageCode, double? speed, double? pitch, double? volume, AudioFormat? audioFormat, int? sampleRate, String? model})
-
factory
-
TTSOptions.fromBuffer(List<
int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]) -
factory
- TTSOptions.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- audioFormat ↔ AudioFormat
-
TTS honours exactly AUDIO_FORMAT_PCM (float32) and AUDIO_FORMAT_WAV.
Other values, including AUDIO_FORMAT_PCM_S16LE, fall through to PCM
silently today; do not rely on them until that is fixed.
getter/setter pair
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- info_ → BuilderInfo
-
no setter
- isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited - languageCode ↔ String
-
BCP-47. Empty = use the component default.
getter/setter pair
- model ↔ String
-
Voice/model id to synthesize with. Unset = use whatever is already
loaded for MODEL_CATEGORY_SPEECH_SYNTHESIS; set = load it first,
downloading if needed.
getter/setter pair
- pitch ↔ double
-
Fundamental-frequency multiplier, 1.0 = the voice's own pitch. Honoured
only by the platform backend (Apple System TTS / Android TextToSpeech);
neural voices (sherpa/Piper/Kokoro, qhexrt) ignore it, because for them
pitch is voice identity rather than a dial.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sampleRate ↔ int
-
0 (the default) = render at the voice's native rate. Naming any other
rate forces a resample and costs quality. TTSOutput.sample_rate always
reports the rate actually used.
getter/setter pair
- speed ↔ double
-
Speed multiplier, matching OpenAI /audio/speech
speed.getter/setter pair - unknownFields → UnknownFieldSet
-
no setterinherited
- voice ↔ String
-
Empty = use the component's configured voice.
getter/setter pair
- volume ↔ double
-
0.0 - 1.0.
getter/setter pair
Methods
-
addExtension(
Extension extension, Object? value) → void -
Adds an extension field value to a repeated field.
inherited
-
check(
) → void -
Throws a StateError if the message has required fields without a value.
inherited
-
clear(
) → void -
Clears all data that was set in this message.
inherited
-
clearAudioFormat(
) → void -
clearExtension(
Extension extension) → void -
Clears an extension field and also removes the extension.
inherited
-
clearField(
int tagNumber) → void -
Clears the contents of a given field.
inherited
-
clearLanguageCode(
) → void -
clearModel(
) → void -
clearPitch(
) → void -
clearSampleRate(
) → void -
clearSpeed(
) → void -
clearVoice(
) → void -
clearVolume(
) → void -
clone(
) → TTSOptions - Creates a deep copy of the fields in this message.
-
copyWith(
void updates(TTSOptions)) → TTSOptions -
Apply
updatesto a copy of this message. -
createEmptyInstance(
) → TTSOptions - Creates an empty instance of the same message type as this.
-
deepCopy(
) → T -
Available on T, provided by the GeneratedMessageGenericExtensions extension
Returns a writable deep copy of this message. -
extensionsAreInitialized(
) → bool -
inherited
-
freeze(
) → GeneratedMessage -
Make this message read-only.
inherited
-
getDefaultForField(
int tagNumber) → dynamic -
Returns the default value for the given field.
inherited
-
getExtension(
Extension extension) → dynamic -
Returns the value of
extension.inherited -
getField(
int tagNumber) → dynamic -
Returns the value of the field associated with
tagNumber, or the default value if it is not set.inherited -
getFieldOrNull(
int tagNumber) → dynamic -
Returns the value of a field, ignoring any defaults.
inherited
-
getTagNumber(
String fieldName) → int? -
inherited
-
hasAudioFormat(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
trueif a value ofextensionis present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber.inherited -
hasLanguageCode(
) → bool -
hasModel(
) → bool -
hasPitch(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasSampleRate(
) → bool -
hasSpeed(
) → bool -
hasVoice(
) → bool -
hasVolume(
) → bool -
isInitialized(
) → bool -
Whether all required fields in the message and embedded messages are set.
inherited
-
mergeFromBuffer(
List< int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges serialized protocol buffer data into this message.
inherited
-
mergeFromCodedBufferReader(
CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Same as
mergeFromBuffer, but takes aCodedBufferReaderinput.inherited -
mergeFromJson(
String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from
data, a JSON object, encoded as described byGeneratedMessage.writeToJson.inherited -
mergeFromJsonMap(
Map< String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from a JSON object represented as a Dart map.
inherited
-
mergeFromMessage(
GeneratedMessage other) → void -
Merges the contents of the
otherinto this message.inherited -
mergeFromProto3Json(
Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void -
Merges field values from
json, a JSON object using proto3 encoding.inherited -
mergeUnknownFields(
UnknownFieldSet unknownFieldSet) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
rebuild(
void updates(T)) → T -
Available on T, provided by the GeneratedMessageGenericExtensions extension
Applyupdatesto a copy of this message. -
setExtension(
Extension extension, Object value) → void -
Sets the value of a non-repeated extension field to
value.inherited -
setField(
int tagNumber, Object value) → void -
Sets the value of a field by its
tagNumber.inherited -
toBuilder(
) → GeneratedMessage -
Creates a writable, shallow copy of this message.
inherited
-
toDebugString(
) → String -
Returns a String representation of this message.
inherited
-
toProto3Json(
{TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object? -
Returns an Object representing Proto3 JSON serialization of
this.inherited -
toString(
) → String -
Returns a String representation of this message.
inherited
-
validate(
) → void -
Available on TTSOptions, provided by the TTSOptionsValidate extension
-
writeToBuffer(
) → Uint8List -
Serialize the message as the protobuf binary format.
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
Same as
writeToBuffer, but serializes to the givenCodedBufferWriter.inherited -
writeToJson(
) → String -
Returns a JSON string that encodes this message.
inherited
-
writeToJsonMap(
) → Map< String, dynamic> -
Returns the JSON encoding of this message as a Dart Map.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
) → TTSOptions -
getDefault(
) → TTSOptions