Skip to main content

Interface: VideoExportOptions

Defined in: export/VideoExporter.ts:19

Options for configuring video export.

Properties

audioManager?

optional audioManager: AudioManager

Defined in: export/VideoExporter.ts:43

Provide an external AudioManager to use for the audio track. If not specified, the scene's audioManager is used.


duration?

optional duration: number

Defined in: export/VideoExporter.ts:31

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


format?

optional format: "webm" | "mp4" | "mov"

Defined in: export/VideoExporter.ts:25

Video format. Defaults to 'webm' (mp4/mov require additional browser codec support).


fps?

optional fps: number

Defined in: export/VideoExporter.ts:21

Frames per second. Defaults to 60.


height?

optional height: number

Defined in: export/VideoExporter.ts:29

Output height in pixels. Defaults to scene height.


includeAudio?

optional includeAudio: boolean

Defined in: export/VideoExporter.ts:38

Include audio from the scene's AudioManager in the exported video. Defaults to true when the scene has audio tracks loaded.


onProgress()?

optional onProgress: (progress) => void

Defined in: export/VideoExporter.ts:33

Progress callback (0-1).

Parameters

progress

number

Returns

void


quality?

optional quality: number

Defined in: export/VideoExporter.ts:23

Quality from 0-1. Defaults to 0.9.


width?

optional width: number

Defined in: export/VideoExporter.ts:27

Output width in pixels. Defaults to scene width.