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,
  customCommandLineArgs: ["--multi-threading"],
  overrideOBSFolder: "C:/custom/obs",
  statsInterval: 5000,
};

Properties

Property	Type	Description
customCommandLineArgs?	string[]	Additional command-line arguments to pass when launching the recorder. This can be used to customize the underlying OBS runtime behavior.
enableDebugLogs?	boolean	Enables verbose debug logs for the recorder. Can be used to troubleshoot issues during recording.
overrideOBSFolder?	string	Specifies a custom folder path to override the default OBS binaries used by the recorder. Useful for testing with a modified or custom OBS build.
showDebugWindow?	boolean	Whether to show the recorder capture (OBS) window during runtime. Useful for debugging or development purposes.
statsInterval?	number	Interval in milliseconds for emitting 'stats' events. Default is 2000 (2 seconds). Set to 0 to disable stats reporting.