Skip to main content

Interface: PlayerOptions

Defined in: player/Player.ts:31

Options for configuring a Scene.

Extends​

Properties​

autoHideMs?​

optional autoHideMs: number

Defined in: player/Player.ts:33

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

autoPlay?​

optional autoPlay: boolean

Defined in: player/Player.ts:35

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

autoRender?​

optional autoRender: boolean

Defined in: core/Scene.ts:59

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

Inherited from​

SceneOptions.autoRender

backgroundColor?​

optional backgroundColor: string

Defined in: core/Scene.ts:49

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:61

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:53

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

Inherited from​

SceneOptions.frameHeight

frameWidth?​

optional frameWidth: number

Defined in: core/Scene.ts:51

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

Inherited from​

SceneOptions.frameWidth

frustumCulling?​

optional frustumCulling: boolean

Defined in: core/Scene.ts:57

Enable frustum culling optimization. Defaults to true.

Inherited from​

SceneOptions.frustumCulling

headless?​

optional headless: boolean

Defined in: core/Scene.ts:63

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:47

Canvas height in pixels. Defaults to container height.

Inherited from​

SceneOptions.height

loop?​

optional loop: boolean

Defined in: player/Player.ts:37

Loop playback. Default false.

slidesMode?​

optional slidesMode: boolean

Defined in: player/Player.ts:39

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

targetFps?​

optional targetFps: number

Defined in: core/Scene.ts:55

Target frame rate in fps. Defaults to 60.

Inherited from​

SceneOptions.targetFps

width?​

optional width: number

Defined in: core/Scene.ts:45

Canvas width in pixels. Defaults to container width.

Inherited from​

SceneOptions.width