textmode.export.js / GIFExportOptions

Type Alias: GIFExportOptions

type GIFExportOptions = object;

Options for capturing deterministic textmode frames as an animated GIF.

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.

---

onProgress?

optional onProgress?: (progress) => void;

Progress callback invoked throughout the recording lifecycle.

Parameters

Parameter	Type
progress	GIFExportProgress

Returns

void

---

prepareFrame?

optional prepareFrame?: PrepareExportFrame;

Prepares external media before each deterministic frame is redrawn.

---

repeat?

optional repeat?: number;

GIF loop count. 0 = loop forever. Defaults to 0.

---

scale?

optional scale?: number;

Scale factor for the output image.

1.0 = original size, 2.0 = double size, 0.5 = half size.

Defaults to 1.0.

---

signal?

optional signal?: AbortSignal;

Abort signal for cancelling capture or encoding.