Interface IRoomSpeechSynthesizer

Turns announcement text into audio. Return null when speech could not be produced (and log why).

interface IRoomSpeechSynthesizer {
    Synthesize(
        text: string,
        contextUser: UserInfo,
    ): Promise<DecodedAudio | null>;
}

Implemented by

MJRoomSpeechSynthesizer

Index

Methods

Methods

Synthesize

Synthesize(text: string, contextUser: UserInfo): Promise<DecodedAudio | null>
Speaks text.
Parameters
- text: string
  What to say.
- contextUser: UserInfo
  The user the synthesis runs (and is logged) as.
Returns Promise<DecodedAudio | null>
The audio, or null when it could not be produced.
- Defined in LiveKitRoomServer/src/room-audio/room-speech-synthesizer.ts:29