Interface: VoiceoverSceneOptions

Defined in: src/audio/VoiceoverScene.ts:29

Options for a VoiceoverScene.

Extends

• SceneOptions

Properties

autoRender?

optional autoRender: boolean

Defined in: src/core/Scene.ts:70

Enable auto-render on add/remove. Defaults to true.

Inherited from

SceneOptions.autoRender

---

autoResize?

optional autoResize: boolean

Defined in: src/core/Scene.ts:81

Automatically resize the canvas when its container (or the window, on mobile rotation) changes size. Only active when both width and height are omitted — passing either dimension is treated as a request for a pinned canvas size, so auto-resize stays off. Defaults to true.

Inherited from

SceneOptions.autoResize

---

backgroundColor?

optional backgroundColor: string

Defined in: src/core/Scene.ts:60

Background color as CSS color string. Defaults to Manim's dark gray (#1C1C1C).

Inherited from

SceneOptions.backgroundColor

---

backgroundOpacity?

optional backgroundOpacity: number

Defined in: src/core/Scene.ts:72

Background opacity (0 = fully transparent, 1 = fully opaque). Defaults to 1. Not supported when exporting to video or GIF formats.

Inherited from

SceneOptions.backgroundOpacity

---

frameHeight?

optional frameHeight: number

Defined in: src/core/Scene.ts:64

Frame height in world units. Defaults to 8 (Manim standard).

Inherited from

SceneOptions.frameHeight

---

frameWidth?

optional frameWidth: number

Defined in: src/core/Scene.ts:62

Frame width in world units. Defaults to 14 (Manim standard).

Inherited from

SceneOptions.frameWidth

---

frustumCulling?

optional frustumCulling: boolean

Defined in: src/core/Scene.ts:68

Enable frustum culling optimization. Defaults to true.

Inherited from

SceneOptions.frustumCulling

---

headless?

optional headless: boolean

Defined in: src/core/Scene.ts:74

Enable headless mode (no WebGL renderer). Useful for testing scene logic without a DOM.

Inherited from

SceneOptions.headless

---

height?

optional height: number

Defined in: src/core/Scene.ts:58

Canvas height in pixels. Defaults to container height.

Inherited from

SceneOptions.height

---

targetFps?

optional targetFps: number

Defined in: src/core/Scene.ts:66

Target frame rate in fps. Defaults to 60.

Inherited from

SceneOptions.targetFps

---

voiceover?

optional voiceover: VoiceoverOptions

Defined in: src/audio/VoiceoverScene.ts:31

Default narration options (voice, rate, injected synthesizer, ...).

---

width?

optional width: number

Defined in: src/core/Scene.ts:56

Canvas width in pixels. Defaults to container width.

Inherited from

SceneOptions.width