RecordingOptions
Electron APIs / recorder / RecordingOptions
Defines the configuration options for starting a recording session.
Extends RecordingBaseOptions and includes optional split settings and the output file path.
See
Extends
Properties
| Property | Type | Description |
|---|---|---|
audioTrack? | number | Defines which audio track(s) should be used for recording. If separateAudioTracks is enabled, it may include multiple tracks such as Track1, Track2, and Track3. Default Track1 See AudioTracks |
autoShutdownOnGameExit? | boolean | Automatically stops the recording when the game exits. This only applies when recording with a Game capture source. |
fileFormat? | kFileFormat | Specifies the container format for the output video file. Common formats include 'fragmented_mp4', 'mkv', 'flv', etc. Default 'fragmented_mp4' See kFileFormat |
filePath | string | The full path to the output file (without the file extension). This determines where the recorded video will be saved. Example "C:/Videos/MyGameRecording" |
split? | SplitOptions | Configuration for splitting the video recording into smaller segments. If not set, the recording will be saved as a single file. See SplitOptions |