RecordEventArgs

Electron APIs / Recorder / RecordEventArgs

Information about a completed recording event, including file path, status, error (if any), and stats.

Example

const handleRecordingStopped = (args: RecordEventArgs) => {
  if (args.error) {
    console.error("Recording failed:", args.error);
  } else {
    console.log("Recording saved to:", args.filePath);
  }
};

Extended by

• RecordStopEventArgs
• SplitRecordArgs
• ReplayVideo

Properties

Property	Type	Description
error?	string	A descriptive error message if the recording failed to complete successfully. undefined if no error occurred,
filePath?	string	The full file path to the saved video recording. undefined if the recording failed.
reason?	number	The 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.
stats?	RecorderStats	Performance and runtime statistics collected during the recording session, such as frame rate, dropped frames, or encoding stats.