textmode.export.js / VideoExportProgress

Type Alias: VideoExportProgress

type VideoExportProgress = object;

Progress information emitted while a deterministic video is probed, captured, and written.

Properties

codec?

optional codec?: VideoCodec;

Effective codec family selected after capability probing (avc, vp9, or vp8).

---

codedHeight?

optional codedHeight?: number;

Effective coded height in pixels.

---

codedWidth?

optional codedWidth?: number;

Effective coded width in pixels.

---

frame?

optional frame?: number;

Alias for frameIndex. Prefer this field in new code.

---

frameIndex?

optional frameIndex?: number;

Number of frames captured so far.

---

frameRate?

optional frameRate?: number;

Exact output frame rate passed to the muxer.

---

message?

optional message?: string;

Optional status message for UI consumption.

---

phase?

optional phase?: VideoExportPhase;

Current detailed phase. See VideoExportPhase for current and compatibility-only values.

---

progress?

optional progress?: number;

Normalized frame-capture completion ratio between 0 and 1.

Final writing or muxing may still be in progress when this value reaches 1.

---

state

state: VideoRecordingState;

Current high-level export state.

---

totalFrames?

optional totalFrames?: number;

Total number of frames planned for the recording.