FluxSttOptions class

Query parameters for a /v2/listen Flux transcription session.

Constructors

FluxSttOptions({String model = 'flux-general-en', List<String>? languageHints, LiveEncoding? encoding, int? sampleRate, double? eotThreshold, double? eagerEotThreshold, int? eotTimeoutMs, List<String>? keyterms, bool? numerals, List<String>? tag, Map<String, String>? extra, bool? mipOptOut})

Creates a Flux options bundle.

const

Properties

eagerEotThreshold → double?

Eager end-of-turn threshold. When set, EagerEndOfTurn and TurnResumed events are emitted, letting an agent start preparing a reply before the turn is fully settled.

final

encoding → LiveEncoding?

Required when streaming raw (uncontainerized) audio, together with sampleRate. Flux supports a subset of LiveEncoding: linear16, linear32, mulaw, alaw, opus, and ogg-opus.

final

eotThreshold → double?

End-of-turn confidence threshold, between 0.5 and 1.0. When null the server default (0.7) applies.

final

eotTimeoutMs → int?

Milliseconds of speech after which the turn is force-ended. When null the server default (5000 ms) applies.

final

extra → Map<String, String>?

Arbitrary key-value pairs echoed in API responses for downstream processing.

final

hashCode → int

The hash code for this object.

no setter, inherited

keyterms → List<String>?

Key term prompting. Sent as repeated keyterm query keys; plain terms only (no weights or intensifiers).

final

languageHints → List<String>?

BCP-47 language hints biasing language detection. Only valid with the flux-general-multi model. Sent as repeated language_hint query keys.

final

mipOptOut → bool?

Opt out of the Deepgram Model Improvement Program.

final

model → String

Flux model: flux-general-en (English) or flux-general-multi (multilingual). Defaults to flux-general-en.

final

numerals → bool?

Convert written numbers to numerals.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sampleRate → int?

Sample rate in Hz. Required together with encoding.

final

tag → List<String>?

Tags for usage reporting. Sent as repeated tag query keys.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toQuery() → Map<String, dynamic>

Builds the query parameters for the WebSocket URI.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited