Skip to main content

Interface: VoiceoverAudioOptions

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

Options for a pre-recorded voiceover.

Properties​

audioManager​

audioManager: VoiceoverAudioScheduler

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

The scheduler that plays the clip (usually a scene's audioManager).


bookmarks?​

optional bookmarks: Record<string, number>

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

Map of bookmark name to time in seconds from the clip start.


duration?​

optional duration: number

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

Narration length in seconds. Falls back to the scheduled track duration.


gain?​

optional gain: number

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

Playback gain in [0, 1].


time?​

optional time: number

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

When to start the clip on the scheduler timeline (seconds). Default 0.


url​

url: string

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

URL of the narration audio clip.