TTSOutput class

Full TTS output: synthesized audio plus metadata.

Mirrors the C ABI rac_tts_output_t. audio_data is opaque bytes; bindings adapt to native buffers (Swift Data, Kotlin ByteArray, Dart Uint8List, JS ArrayBuffer/Float32Array, C void*). Sample rate is required because PCM payloads are otherwise unparseable.

Available extensions

Constructors

TTSOutput({List<int>? audioData, AudioFormat? audioFormat, int? sampleRate, Int64? durationMs, Iterable<TTSPhonemeTimestamp>? phonemeTimestamps, TTSSynthesisMetadata? metadata, Int64? timestampMs, int? chunkIndex, bool? isFinal, Int64? audioSizeBytes, String? errorMessage, int? errorCode})
factory
TTSOutput.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
TTSOutput.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

audioData ↔ List<int>
Synthesized audio bytes, encoded per audio_format.
getter/setter pair
audioFormat ↔ AudioFormat
Audio format of the bytes in audio_data.
getter/setter pair
audioSizeBytes ↔ Int64
getter/setter pair
chunkIndex ↔ int
Stream chunk metadata. For one-shot synthesis, chunk_index=0 and is_final=true when set by the producer.
getter/setter pair
durationMs ↔ Int64
Audio duration in milliseconds (matches C ABI duration_ms).
getter/setter pair
errorCode ↔ int
getter/setter pair
errorMessage ↔ String
Terminal error details for result-envelope APIs.
getter/setter pair
hashCode → int
Calculates a hash code based on the contents of the protobuf.
no setterinherited
info_ → BuilderInfo
no setter
isFinal ↔ bool
getter/setter pair
isFrozen → bool
Returns true if this message is marked read-only. Otherwise false.
no setterinherited
metadata ↔ TTSSynthesisMetadata
Per-pass synthesis metadata.
getter/setter pair
phonemeTimestamps → PbList<TTSPhonemeTimestamp>
Phoneme-level timestamps, if the engine produced them. May be empty.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sampleRate ↔ int
Sample rate in Hz. For PCM payloads this is required to interpret the bytes; for compressed formats (mp3, opus, …) it reflects the synthesis sample rate, not the container rate.
getter/setter pair
timestampMs ↔ Int64
Wall-clock timestamp when the output was produced (milliseconds since UNIX epoch). Mirrors C ABI timestamp_ms.
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited

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
clearAudioData() → void
clearAudioFormat() → void
clearAudioSizeBytes() → void
clearChunkIndex() → void
clearDurationMs() → void
clearErrorCode() → void
clearErrorMessage() → 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
clearIsFinal() → void
clearMetadata() → void
clearSampleRate() → void
clearTimestampMs() → void
clone() → TTSOutput
Creates a deep copy of the fields in this message.
copyWith(void updates(TTSOutput)) → TTSOutput
Apply updates to a copy of this message.
createEmptyInstance() → TTSOutput
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.
ensureMetadata() → TTSSynthesisMetadata
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
hasAudioData() → bool
hasAudioFormat() → bool
hasAudioSizeBytes() → bool
hasChunkIndex() → bool
hasDurationMs() → bool
hasErrorCode() → bool
hasErrorMessage() → 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
hasIsFinal() → bool
hasMetadata() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasSampleRate() → bool
hasTimestampMs() → 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() → TTSOutput
getDefault() → TTSOutput