Class ElevenLabsUtterance

An utterance implementation that uses the ElevenLabs API to synthesize speech.

Implements

Utterance

Index

Constructors

Accessors

Methods

Constructors

constructor

new ElevenLabsUtterance(
    apiKey: string,
    voiceId: string,
    languageCode: string,
    text: string,
    cacheMaxAge?: null | number,
    options?: { normalizeVolume?: boolean },
): ElevenLabsUtterance
Parameters
- apiKey: string
- voiceId: string
- languageCode: string
- text: string
- cacheMaxAge: null | number = 3600
- options: { normalizeVolume?: boolean } = {}
Returns ElevenLabsUtterance
- Defined in ElevenLabsVoiceProvider.ts:254

Accessors

onend

set onend(callback: () => void): void
Set the callback for when the utterance finishes speaking
Parameters
- callback: () => void
Returns void
Implementation of Utterance.onend
- Defined in ElevenLabsVoiceProvider.ts:442

onstart

set onstart(callback: () => void): void
Set the callback for when the utterance starts speaking
Parameters
- callback: () => void
Returns void
Implementation of Utterance.onstart
- Defined in ElevenLabsVoiceProvider.ts:437

Methods

start

start(): Promise<void>
Start speaking the utterance by fetching audio from ElevenLabs and playing it. If normalizeVolume is enabled, the audio will be processed to normalize its volume.

Returns Promise<void>
Implementation of Utterance.start
- Defined in ElevenLabsVoiceProvider.ts:272

stop

stop(): void
Stop speaking the utterance

Returns void
Implementation of Utterance.stop
- Defined in ElevenLabsVoiceProvider.ts:424