Skip to main content

NvidiaTTS

NVIDIA Riva text-to-speech (TTS) provider.

Constructor

apiKey
string
NVIDIA API key. Falls back to the NVIDIA_API_KEY environment variable when omitted.
voice
string
default:"English-US-Female-1"
Riva synthesis voice name.
languageCode
string
BCP-47 language code for synthesis (e.g. 'en-US'). Accepted for compatibility; currently has no effect.
sampleRate
number
default:"22050"
Output audio sample rate, in hertz.
server
string
Riva endpoint host. Accepted for compatibility; currently has no effect.

close

Release any resources held by the provider.

closeEmitter

Close the emitter: drop all handlers and stop emitting. Waits up to 2 seconds for in-flight async handlers to settle before returning.

emit

event
string
required

getRuntimeConfig

returns
Record<string, any>

interrupt

Stop the current synthesis.

listenerCount

event
string
required
returns
number

off

event
string
required
handler
EventHandler
required

on

event
string
required
handler
EventHandler
required
returns
EventHandler

once

event
string
required
handler
EventHandler
required
returns
EventHandler

onFirstAudioByte

Register a callback fired when the first synthesized audio byte is emitted.
callback
FirstAudioByteCallback
required

removeAllListeners

event
string

synthesize

Synthesize and speak text on the active session.
text
any
required