Class STT<TModel>

Livekit Cloud Inference STT

Type Parameters

TModel extends inference.STTModels

Hierarchy (view full)

stt.STT
- STT

Index

Constructors

constructor

new STT<TModel>(opts?): inference.STT<TModel>
Type Parameters
- TModel extends inference.STTModels
Parameters
- Optional opts: {
      apiKey?: string;
      apiSecret?: string;
      baseURL?: string;
      connOptions?: APIConnectOptions;
      encoding?: "pcm_s16le";
      fallback?: STTFallbackModelType | STTFallbackModelType[];
      language?: inference.STTLanguages;
      model?: STTModelString;
      modelOptions?: inference.STTOptions<TModel>;
      sampleRate?: number;
      vad?: VAD;
  }
  - Optional apiKey?: string
  - Optional apiSecret?: string
  - Optional baseURL?: string
  - Optional connOptions?: APIConnectOptions
  - Optional encoding?: "pcm_s16le"
  - Optional fallback?: STTFallbackModelType | STTFallbackModelType[]
  - Optional language?: inference.STTLanguages
  - Optional model?: STTModelString
  - Optional modelOptions?: inference.STTOptions<TModel>
  - Optional sampleRate?: number
  - Optional vad?: VAD
Returns inference.STT<TModel>
Overrides STT.constructor
- Defined in agents/src/inference/stt.ts:365

Accessors

capabilities

get capabilities(): STTCapabilities
Returns this STT's capabilities

Returns STTCapabilities
Inherited from BaseSTT.capabilities
- Defined in agents/src/stt/stt.ts:171

label

get label(): string
Returns string
Overrides BaseSTT.label
- Defined in agents/src/inference/stt.ts:445

model

get model(): string
Get the model name/identifier for this STT instance.

Returns string
The model name if available, "unknown" otherwise.

Remarks
Plugins should override this property to provide their model information.
Overrides BaseSTT.model
- Defined in agents/src/inference/stt.ts:449

provider

get provider(): string
Get the provider name for this STT instance.

Returns string
The provider name if available, "unknown" otherwise.

Remarks
Plugins should override this property to provide their provider information.
Overrides BaseSTT.provider
- Defined in agents/src/inference/stt.ts:453

vadPromise

get vadPromise(): Promise<undefined | VAD>
Resolves to the VAD instance for the current model, or undefined if the model handles endpointing server-side. Lazily computed on first read so callers that never need VAD don't pay the cost of loading Silero.

Returns Promise<undefined | VAD>
- Defined in agents/src/inference/stt.ts:356

Methods

close

close(): Promise<void>
Returns Promise<void>
Inherited from STT.close
- Defined in agents/src/stt/stt.ts:237

connectWs

connectWs(timeout): Promise<WebSocket>
Parameters
- timeout: number
Returns Promise<WebSocket>
- Defined in agents/src/inference/stt.ts:526

recognize

recognize(frame, abortSignal?): Promise<SpeechEvent>
Receives an audio buffer and returns transcription in the form of a SpeechEvent
Parameters
- frame: AudioBuffer
- Optional abortSignal: AbortSignal
Returns Promise<SpeechEvent>
Inherited from STT.recognize
- Defined in agents/src/stt/stt.ts:204

stream

stream(options?): inference.stt.SpeechStream<TModel>
Returns a SpeechStream that can be used to push audio frames and receive transcriptions
Parameters
- Optional options: {
  connOptions?: APIConnectOptions;
  language?: string | AnyString;
  }
  Optional configuration including connection options
  - Optional connOptions?: APIConnectOptions
  - Optional language?: string | AnyString
Returns inference.stt.SpeechStream<TModel>
Overrides STT.stream
- Defined in agents/src/inference/stt.ts:509

updateOptions

updateOptions(opts): void
Parameters
- opts: Partial<Pick<InferenceSTTOptions<TModel>, "model" | "language" | "modelOptions">>
Returns void
- Defined in agents/src/inference/stt.ts:466

`Static` fromModelString

fromModelString(modelString): inference.STT<AnyString>
Parameters
- modelString: string
Returns inference.STT<AnyString>
- Defined in agents/src/inference/stt.ts:457

Class STT<TModel>

Type Parameters

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Optional apiKey?: string

Optional apiSecret?: string

Optional baseURL?: string

Optional connOptions?: APIConnectOptions

Optional encoding?: "pcm_s16le"

Optional fallback?: STTFallbackModelType | STTFallbackModelType[]

Optional language?: inference.STTLanguages

Optional model?: STTModelString

Optional modelOptions?: inference.STTOptions<TModel>

Optional sampleRate?: number

Optional vad?: VAD

Returns inference.STT<TModel>

Accessors

capabilities

Returns STTCapabilities

label

Returns string

model

Returns string

Remarks

provider

Returns string

Remarks

vadPromise

Returns Promise<undefined | VAD>

Methods

close

Returns Promise<void>

connectWs

Parameters

Returns Promise<WebSocket>

recognize

Parameters

Returns Promise<SpeechEvent>

stream

Parameters

Optional connOptions?: APIConnectOptions

Optional language?: string | AnyString

Returns inference.stt.SpeechStream<TModel>

updateOptions

Parameters

Returns void

Static fromModelString

Parameters

Returns inference.STT<AnyString>

Settings

Member Visibility

Theme

On This Page

`Optional` apiKey?: string

`Optional` apiSecret?: string

`Optional` baseURL?: string

`Optional` connOptions?: APIConnectOptions

`Optional` encoding?: "pcm_s16le"

`Optional` fallback?: STTFallbackModelType | STTFallbackModelType[]

`Optional` language?: inference.STTLanguages

`Optional` model?: STTModelString

`Optional` modelOptions?: inference.STTOptions<TModel>

`Optional` sampleRate?: number

`Optional` vad?: VAD

`Optional` connOptions?: APIConnectOptions

`Optional` language?: string | AnyString

`Static` fromModelString