STTOptions class

STT runtime transcription options (per-call overrides). Sources pre-IDL: Swift STTTypes.swift:64 STTOptions (10 fields) Kotlin STTTypes.kt:65 STTOptions (10 fields) Dart generation_types.dart:78 STTOptions (10 fields) RN STTTypes.ts:12 STTOptions (5 fields, narrower) Web STTTypes.ts:25 STTTranscribeOptions (2 fields) C ABI rac_stt_types.h:130 rac_stt_options_t (8 fields)

Per spec, this canonical message exposes: language, enable_punctuation, enable_diarization, max_speakers, vocabulary_list, enable_word_timestamps, beam_size. Other pre-IDL fields (audio_format, sample_rate, detect_language, preferred_framework) are part of STTConfiguration or implied by STT_LANGUAGE_AUTO.

Available extensions

Constructors

STTOptions({STTLanguage? language, bool? enablePunctuation, bool? enableDiarization, int? maxSpeakers, Iterable<String>? vocabularyList, bool? enableWordTimestamps, int? beamSize, String? languageCode, bool? detectLanguage, AudioFormat? audioFormat, int? sampleRate, int? maxAlternatives, int? chunkDurationMs, int? endpointSilenceMs, bool? suppressBlank, bool? translateToEnglish})
factory
STTOptions.fromBuffer(List<int> data, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory
STTOptions.fromJson(String json, [ExtensionRegistry registry = $pb.ExtensionRegistry.EMPTY])
factory

Properties

audioFormat ↔ AudioFormat
Per-call input audio hints mirrored from rac_stt_options_t.
getter/setter pair
beamSize ↔ int
getter/setter pair
chunkDurationMs ↔ int
Streaming/endpointer controls. 0 = backend/default.
getter/setter pair
detectLanguage ↔ bool
Explicit language auto-detection flag for C ABI parity. Equivalent to language == STT_LANGUAGE_AUTO for generated-only consumers.
getter/setter pair
enableDiarization ↔ bool
getter/setter pair
enablePunctuation ↔ bool
getter/setter pair
enableWordTimestamps ↔ bool
getter/setter pair
endpointSilenceMs ↔ int
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
language ↔ STTLanguage
getter/setter pair
languageCode ↔ String
Free-form BCP-47 language tag. When set, consumers should prefer this over the base-language enum above.
getter/setter pair
maxAlternatives ↔ int
Maximum number of alternatives to return. 0 = backend/default.
getter/setter pair
maxSpeakers ↔ int
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sampleRate ↔ int
getter/setter pair
suppressBlank ↔ bool
getter/setter pair
translateToEnglish ↔ bool
getter/setter pair
unknownFields → UnknownFieldSet
no setterinherited
vocabularyList → PbList<String>
no setter

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
clearBeamSize() → void
clearChunkDurationMs() → void
clearDetectLanguage() → void
clearEnableDiarization() → void
clearEnablePunctuation() → void
clearEnableWordTimestamps() → void
clearEndpointSilenceMs() → 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
clearLanguage() → void
clearLanguageCode() → void
clearMaxAlternatives() → void
clearMaxSpeakers() → void
clearSampleRate() → void
clearSuppressBlank() → void
clearTranslateToEnglish() → void
clone() → STTOptions
Creates a deep copy of the fields in this message.
copyWith(void updates(STTOptions)) → STTOptions
Apply updates to a copy of this message.
createEmptyInstance() → STTOptions
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
hasBeamSize() → bool
hasChunkDurationMs() → bool
hasDetectLanguage() → bool
hasEnableDiarization() → bool
hasEnablePunctuation() → bool
hasEnableWordTimestamps() → bool
hasEndpointSilenceMs() → 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
hasLanguage() → bool
hasLanguageCode() → bool
hasMaxAlternatives() → bool
hasMaxSpeakers() → bool
hasRequiredFields() → bool
Whether the message has required fields.
inherited
hasSampleRate() → bool
hasSuppressBlank() → bool
hasTranslateToEnglish() → 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() → STTOptions
getDefault() → STTOptions