Skip to content

textmode.export.js / VideoExportProgress

Type Alias: VideoExportProgress

ts
type VideoExportProgress = object;

Progress information emitted during the video export process.

Properties

state

ts
state: VideoRecordingState;

Current state of the recording process.


phase?

ts
optional phase?: VideoExportPhase;

Current export phase for newer progress UIs.


frameIndex?

ts
optional frameIndex?: number;

Number of frames that have been recorded so far.


frame?

ts
optional frame?: number;

Alias for frameIndex. Prefer this field in new code.


totalFrames?

ts
optional totalFrames?: number;

Total number of frames planned for the recording.


progress?

ts
optional progress?: number;

Export completion ratio between 0 and 1.


message?

ts
optional message?: string;

Optional status message for UI consumption.