Skip to content

bodhi-realtime-agent / GeminiLiveTranscribeSTTOptions

Interface: GeminiLiveTranscribeSTTOptions ​

Defined in: src/transport/gemini-live-transcribe-stt-provider.ts:55

GeminiLiveTranscribeSTTProvider's options apart from its credential.

Extended by ​

Properties ​

connectTimeoutMs? ​

optional connectTimeoutMs?: number

Defined in: src/transport/gemini-live-transcribe-stt-provider.ts:71

Longest wait for setupComplete before a connection counts as failed. With a credentialProvider it is one deadline over the credential fetch, the dial and setupComplete; the fetch may use at most half of it.


createSocket? ​

optional createSocket?: (url) => WebSocketLike

Defined in: src/transport/gemini-live-transcribe-stt-provider.ts:76

Test seam.

Parameters ​

url ​

string

Returns ​

WebSocketLike


customVocabulary? ​

optional customVocabulary?: string[]

Defined in: src/transport/gemini-live-transcribe-stt-provider.ts:60

Up to 1000 names/terms the model should spell correctly.


drainMs? ​

optional drainMs?: number

Defined in: src/transport/gemini-live-transcribe-stt-provider.ts:67

How long the old socket stays open after audioStreamEnd.


languageCodes? ​

optional languageCodes?: string[]

Defined in: src/transport/gemini-live-transcribe-stt-provider.ts:58

BCP-47 hints; empty = auto-detect (handles mixed Chinese/English).


log? ​

optional log?: (msg) => void

Defined in: src/transport/gemini-live-transcribe-stt-provider.ts:77

Parameters ​

msg ​

string

Returns ​

void


maxRetries? ​

optional maxRetries?: number

Defined in: src/transport/gemini-live-transcribe-stt-provider.ts:73

Retries for a connection that fails before it is ready; the delay grows per attempt.


mode? ​

optional mode?: "VERBATIM" | "SMART"

Defined in: src/transport/gemini-live-transcribe-stt-provider.ts:61


model? ​

optional model?: string

Defined in: src/transport/gemini-live-transcribe-stt-provider.ts:56


onConnectionLifecycle? ​

optional onConnectionLifecycle?: (event) => void

Defined in: src/transport/gemini-live-transcribe-stt-provider.ts:80

Each connection's dial, setup and close, for a caller that tracks the credentials it issued. Also settable as a property.

Parameters ​

event ​

GeminiLiveTranscribeLifecycleEvent

Returns ​

void


onFatal? ​

optional onFatal?: (error) => void

Defined in: src/transport/gemini-live-transcribe-stt-provider.ts:87

The run ended on its own, after start() resolved: a lost connection could not be replaced within maxRetries, or the credential provider failed permanently (retryable: false). The provider has stopped (a later start() begins a new run) and no more transcripts come. Before start() resolves, a failure rejects start() instead. The error carries the last attempt's connectFailure. Also settable as a property.

Parameters ​

error ​

Error

Returns ​

void


pauseWaitMs? ​

optional pauseWaitMs?: number

Defined in: src/transport/gemini-live-transcribe-stt-provider.ts:65

Longest wait for a pause before handing over anyway.


retryDelayMs? ​

optional retryDelayMs?: number

Defined in: src/transport/gemini-live-transcribe-stt-provider.ts:74


rotateAfterMs? ​

optional rotateAfterMs?: number

Defined in: src/transport/gemini-live-transcribe-stt-provider.ts:63

Rotate before the server's 10-minute cap.

Built with VitePress