Skip to main content

InworldAITTS

Inworld AI text-to-speech (TTS) provider.

Constructor

apiKey
string
Inworld AI API key. Falls back to the INWORLDAI_API_KEY environment variable when omitted.
voiceId
string
Voice used for synthesis. Defaults to 'Hades'.
modelId
string
TTS model identifier. Defaults to 'inworld-tts-1'.
sampleRate
number
Output audio sample rate in Hz. Defaults to 24000.

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