Interface: PlayerOptions

Defined in: player/Player.ts:32

Options for configuring a Scene.

Extends

• SceneOptions

Properties

autoHideMs?

optional autoHideMs: number

Defined in: player/Player.ts:34

Auto-hide controls after this many ms. 0 = never. Default 2500.

---

autoPlay?

optional autoPlay: boolean

Defined in: player/Player.ts:36

Auto-play after sequence() finishes recording. Default false.

---

autoRender?

optional autoRender: boolean

Defined in: core/Scene.ts:68

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

Inherited from

SceneOptions.autoRender

---

autoResize?

optional autoResize: boolean

Defined in: core/Scene.ts:79

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: core/Scene.ts:58

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

Inherited from

SceneOptions.backgroundColor

---

backgroundOpacity?

optional backgroundOpacity: number

Defined in: core/Scene.ts:70

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: core/Scene.ts:62

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

Inherited from

SceneOptions.frameHeight

---

frameWidth?

optional frameWidth: number

Defined in: core/Scene.ts:60

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

Inherited from

SceneOptions.frameWidth

---

frustumCulling?

optional frustumCulling: boolean

Defined in: core/Scene.ts:66

Enable frustum culling optimization. Defaults to true.

Inherited from

SceneOptions.frustumCulling

---

headless?

optional headless: boolean

Defined in: core/Scene.ts:72

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

Inherited from

SceneOptions.headless

---

height?

optional height: number

Defined in: core/Scene.ts:56

Canvas height in pixels. Defaults to container height.

Inherited from

SceneOptions.height

---

loop?

optional loop: boolean

Defined in: player/Player.ts:38

Loop playback. Default false.

---

slidesMode?

optional slidesMode: boolean

Defined in: player/Player.ts:40

Slides mode: arrows play/pause at slide boundaries like a presentation. Default false.

---

targetFps?

optional targetFps: number

Defined in: core/Scene.ts:64

Target frame rate in fps. Defaults to 60.

Inherited from

SceneOptions.targetFps

---

width?

optional width: number

Defined in: core/Scene.ts:54

Canvas width in pixels. Defaults to container width.

Inherited from

SceneOptions.width