textmode.export.js / VideoExportOptions

Type Alias: VideoExportOptions

type VideoExportOptions = object;

Options for exporting the textmode content to video format.

Properties

filename?

optional filename: string;

Target filename without extension. Defaults to an auto-generated value.

---

frameCount?

optional frameCount: number;

Desired total number of frames to capture. Defaults to 300.

---

frameRate?

optional frameRate: number;

Target frame rate for the export, in frames per second. Defaults to 60.

---

quality?

optional quality: number;

Encoder quality between 0.0 and 1.0. Higher values request higher fidelity. Defaults to 1.0 (lossless).

---

transparent?

optional transparent: boolean;

When true, attempts to preserve alpha data in the recording (experimental). Defaults to false.

---

onProgress()?

optional onProgress: (progress) => void;

Progress callback invoked throughout the recording lifecycle.

Parameters

Parameter	Type
progress	VideoExportProgress

Returns

void

---

debugLogging?

optional debugLogging: boolean;

Enables verbose logging. Defaults to false.