Skip to main content

​
NeuphonicTTS

Neuphonic text-to-speech (TTS) provider.

​
Constructor

​
apiKey
string
Neuphonic API key used to authenticate requests. Defaults to the NEUPHONIC_API_KEY environment variable when omitted.
​
voiceId
string | null
Identifier of the Neuphonic voice to synthesize with. Defaults to null, in which case the provider’s default voice is used.
​
langCode
string
BCP-47 language code for synthesis (e.g. "en"). No default is applied; when omitted the provider’s default language is used.
​
samplingRate
number
Audio output sampling rate in Hz. Defaults to 22050.

​
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