Skip to main content

OpenAITTS

OpenAI text-to-speech (TTS) synthesizer.

Constructor

apiKey
string | null
OpenAI API key. Defaults to the OPENAI_API_KEY environment variable.
voice
string
Voice id. Default 'ash'.
model
OpenAITTSModel | string
TTS model id. Default 'gpt-4o-mini-tts'.
sampleRate
number
Output audio sample rate in Hz. Default 24000.
speed
number | null
Playback speed multiplier. Default null (provider default, 1.0).
stream
boolean
Stream audio as it is synthesized. Default true.

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

OpenAITTSModel

Supported OpenAI TTS model ids.