Skip to main content

Interface: SceneExportOptions

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

Options for scene.export() convenience method. Format is inferred from the filename extension.

Properties​

duration?​

optional duration: number

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

Duration in seconds. Auto-detects from timeline if not specified.


fps?​

optional fps: number

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

Frames per second. Defaults to 30 for GIF, 60 for video.


height?​

optional height: number

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

Output height in pixels. Defaults to scene height.


includeAudio?​

optional includeAudio: boolean

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

Include audio in video export. Defaults to true when audio tracks exist.


onProgress()?​

optional onProgress: (progress) => void

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

Progress callback (0-1).

Parameters​

progress​

number

Returns​

void


quality?​

optional quality: number

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

Quality. For GIF: 1-30 (lower is better), default 10. For video: 0-1, default 0.9.


repeat?​

optional repeat: number

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

GIF repeat mode. 0 = loop forever, -1 = no repeat. Default 0.


width?​

optional width: number

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

Output width in pixels. Defaults to scene width.


workers?​

optional workers: number

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

Number of GIF encoding workers. Default 4.