Skip to main content

Interface: VoiceoverOptions

Defined in: src/audio/Voiceover.ts:175

Options for a Voiceover instance or a single voiceover call.

Extends​

Properties​

lang?​

optional lang: string

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

BCP-47 language tag, e.g. "en-US".

Inherited from​

SpeechOptions.lang

pitch?​

optional pitch: number

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

Voice pitch multiplier (1 = normal).

Inherited from​

SpeechOptions.pitch

rate?​

optional rate: number

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

Speaking rate multiplier (1 = normal).

Inherited from​

SpeechOptions.rate

synthesizer?​

optional synthesizer: SpeechSynthesizer

Defined in: src/audio/Voiceover.ts:177

A synthesizer that overrides the injected / default one for this scope.

voice?​

optional voice: string

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

Name of a specific SpeechSynthesisVoice to use.

Inherited from​

SpeechOptions.voice

volume?​

optional volume: number

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

Output volume in the range [0, 1].

Inherited from​

SpeechOptions.volume