RecordingAppOptions

Electron APIs / recorder / RecordingAppOptions

Configuration options for launching or customizing the recording application behavior.

See

• CaptureSettings
• EncoderSettingsX264

Example

const options: RecordingAppOptions = {
  showDebugWindow: true,
  enableDebugLogs: true,
  maxLogFiles: 20,
};

Properties

Property	Type	Description
crashDumps?	CrashDumpOptions	Tune OBS-host crash dumps. Mini-dump capture is on by default; these options change the detail level and retention count, or turn capture off entirely via type: 'off'. See CrashDumpOptions
enableDebugLogs?	boolean	Enables verbose debug logs for the recorder. Can be used to troubleshoot issues during recording.
hostMode?	ObsHostMode	How to host OBS. Defaults to process. Applied the next time OBS starts, so changing it while a recording is running does not affect that recording. See ObsHostMode
maxLogFiles?	number	Maximum number of OBS log files to retain under the recorder's ow-obs/logs folder. Once the number of logs exceeds this value, the oldest logs are gradually pruned. Must be a positive integer. Defaults to 10.
showDebugWindow?	boolean	Whether to show the recorder capture (OBS) window during runtime. Useful for debugging or development purposes.