TTSOptions class

Per-call TTS synthesis options.

Mirrors the C ABI rac_tts_options_t exactly. Field names match Swift TTSOptions / Kotlin TTSOptions / Dart TTSOptions.

Note: voice is optional at the source (Swift String?, C const char* = NULL). On the wire, an empty string MUST be interpreted as "use the component's configured voice".

Available extensions

Constructors

TTSOptions({String? voice, String? languageCode, double? speakingRate, double? pitch, double? volume, bool? enableSsml, AudioFormat? audioFormat, int? sampleRate, int? speakerId, String? style})
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
Output audio format.
getter/setter pair
enableSsml ↔ bool
Whether the input contains SSML markup. C ABI: use_ssml, Swift: useSSML, Kotlin: useSSML, Dart: useSSML. Canonicalized to enable_ssml for consistency with TTSConfiguration.
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 true if this message is marked read-only. Otherwise false.
no setterinherited
languageCode ↔ String
Language override (BCP-47). Empty = use component default.
getter/setter pair
pitch ↔ double
Speech pitch (0.5 – 2.0; 1.0 is normal).
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sampleRate ↔ int
Output sample rate override in Hz. 0 = component/default sample rate. Present in rac_tts_options_t and several SDK option structs.
getter/setter pair
speakerId ↔ int
Speaker index for multi-speaker voices. -1/0 = backend default depending on model convention.
getter/setter pair
speakingRate ↔ double
Speech rate (0.0 – 2.0; 1.0 is normal). Note Swift/Kotlin use the name rate, Dart uses rate, RN uses rate. C ABI field is rate. We canonicalize on speaking_rate to match TTSConfiguration; bindings alias to rate where appropriate.
getter/setter pair
style ↔ String
Optional style/emotion hint for voices that support style transfer.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
voice ↔ String
Voice override (empty = use component default).
getter/setter pair
volume ↔ double
Speech volume (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
clearEnableSsml() → 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
clearPitch() → void
clearSampleRate() → void
clearSpeakerId() → void
clearSpeakingRate() → void
clearStyle() → void
clearVoice() → void
clearVolume() → void
clone() → TTSOptions
Creates a deep copy of the fields in this message.
copyWith(void updates(TTSOptions)) → TTSOptions
Apply updates to 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
hasEnableSsml() → bool
hasExtension(Extension extension) → bool
Returns true if a value of extension is present.
inherited
hasField(int tagNumber) → bool
Whether this message has a field associated with tagNumber.
inherited
hasLanguageCode() → bool
hasPitch() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasSampleRate() → bool
hasSpeakerId() → bool
hasSpeakingRate() → bool
hasStyle() → 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 a CodedBufferReader input.
inherited
mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void
Merges field values from data, a JSON object, encoded as described by GeneratedMessage.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 other into 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

Apply updates to 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
writeToBuffer() → Uint8List
Serialize the message as the protobuf binary format.
inherited
writeToCodedBufferWriter(CodedBufferWriter output) → void
Same as writeToBuffer, but serializes to the given CodedBufferWriter.
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