Skip to main content

Interface: SpeechSynthesizer

Defined in: src/audio/speechSynthesizer.ts:66

The dependency Voiceover speaks through.

Methods​

cancel()​

cancel(): void

Defined in: src/audio/speechSynthesizer.ts:70

Cancel every in-flight and queued utterance.

Returns​

void


isSupported()​

isSupported(): boolean

Defined in: src/audio/speechSynthesizer.ts:72

Whether this synthesizer can actually speak in the current environment.

Returns​

boolean


speak()​

speak(text, options?): SpeechUtteranceHandle

Defined in: src/audio/speechSynthesizer.ts:68

Begin speaking text; returns a handle for timing and cancellation.

Parameters​

text​

string

options?​

SpeechOptions

Returns​

SpeechUtteranceHandle