Skip to main content

ReplayVideo

Electron APIs / recorder / ReplayVideo

Metadata and statistics about a replay video created from a buffered recording. Extends RecordEventArgs with replay specific information.

Example

const handleReplayComplete = (replay: ReplayVideo) => {
console.log(`Replay saved to: ${replay.filePath}`);
console.log(`Replay duration: ${replay.duration}ms`);
console.log(
`Replay started at: ${new Date(replay.startTimeEpoch).toISOString()}`,
);
};

See

RecordEventArgs

Extends

Properties

PropertyTypeDescription
durationnumberDuration of the replay video in milliseconds.
error?stringA descriptive error message if the recording failed to complete successfully. undefined if no error occurred,
filePath?stringThe full file path to the saved video recording. undefined if the recording failed.
reason?numberThe reason the recording was stopped, either by the user or due to an error. This can be a predefined ErrorCode or a custom numeric value.
startTimeEpochnumberEpoch UTC timestamp (in milliseconds) of when the replay started (first frame).
stats?RecorderStatsPerformance and runtime statistics collected during the recording session, such as frame rate, dropped frames, or encoding stats.