Class STT

constructor

• new STT(opts?): STT

• Parameters

  • opts: Partial<STTOptions> = {}

    Partial STTOptions. apiKey defaults to $INWORLD_API_KEY.

  Returns STT

label

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.

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.

_recognize

• _recognize(buffer): Promise<SpeechEvent>

• Parameters

  • buffer: AudioBuffer

  Returns Promise<SpeechEvent>

close

• close(): Promise<void>

• Returns Promise<void>

stream

• stream(options?): SpeechStream

• Returns a SpeechStream that can be used to push audio frames and receive transcriptions

  Parameters

  • Optional options: {
        connOptions?: APIConnectOptions;
    }

    Optional configuration including connection options

    • Optional connOptions?: APIConnectOptions

  Returns SpeechStream

updateOptions

• updateOptions(opts): void

• Parameters

  • opts: Partial<STTOptions>

  Returns void