TTSConfiguration class

Component-level TTS configuration.

Mirrors the C ABI rac_tts_config_t exactly (minus preferred_framework, which is a runtime hint, not part of the wire contract). Field names match Swift TTSConfiguration / Kotlin TTSConfiguration.

Defaults (for documentation; proto3 zero-values apply on the wire): voice = "default" (Kotlin) / "com.apple.ttsbundle..." (Swift) language_code = "en-US" speaking_rate = 1.0 (range 0.5 – 2.0) pitch = 1.0 (range 0.5 – 2.0) volume = 1.0 (range 0.0 – 1.0) audio_format = AUDIO_FORMAT_PCM sample_rate = 22050 (RAC_TTS_DEFAULT_SAMPLE_RATE) enable_neural_voice= true enable_ssml = false

Available extensions

Constructors

TTSConfiguration({String? modelId, String? voice, String? languageCode, double? speakingRate, double? pitch, double? volume, AudioFormat? audioFormat, int? sampleRate, bool? enableNeuralVoice, bool? enableSsml, InferenceFramework? preferredFramework}): factory
TTSConfiguration.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]): factory
TTSConfiguration.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY]): factory

Properties

audioFormat ↔ AudioFormat: Output audio format.
getter/setter pair
enableNeuralVoice ↔ bool: Whether to use neural / premium voice if available.
getter/setter pair
enableSsml ↔ bool: Whether to enable SSML markup support.
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 for synthesis (BCP-47, e.g. "en-US").
getter/setter pair
modelId ↔ String: Model identifier (voice model file id, e.g. piper voice). Optional — platform TTS engines (Apple System TTS, Android TextToSpeech) don't require a model file.
getter/setter pair
pitch ↔ double: Speech pitch (0.5 – 2.0; 1.0 is normal).
getter/setter pair
preferredFramework ↔ InferenceFramework: Preferred framework for the component. Absent = auto. Mirrors the C ABI rac_tts_config_t preferred_framework field.
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
sampleRate ↔ int: Sample rate for output audio in Hz. 0 = engine default (RAC_TTS_DEFAULT_SAMPLE_RATE = 22050).
getter/setter pair
speakingRate ↔ double: Speaking rate (0.5 – 2.0; 1.0 is normal).
getter/setter pair
unknownFields → UnknownFieldSet: no setterinherited
voice ↔ String: Voice identifier to use for synthesis. For platform engines this is the engine-specific voice id (e.g. "com.apple.ttsbundle.siri_female_en-US_compact").
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
clearEnableNeuralVoice() → 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
clearModelId() → void
clearPitch() → void
clearPreferredFramework() → void
clearSampleRate() → void
clearSpeakingRate() → void
clearVoice() → void
clearVolume() → void
clone() → TTSConfiguration: Creates a deep copy of the fields in this message.
copyWith(void updates(TTSConfiguration)) → TTSConfiguration: Apply updates to a copy of this message.
createEmptyInstance() → TTSConfiguration: 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
hasEnableNeuralVoice() → 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
hasModelId() → bool
hasPitch() → bool
hasPreferredFramework() → bool
hasRequiredFields() → bool: Whether the message has required fields.
inherited
hasSampleRate() → bool
hasSpeakingRate() → 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() → TTSConfiguration
getDefault() → TTSConfiguration