ReplayOptions
Electron APIs / recorder / ReplayOptions
Defines the configuration options for using the replay buffer.
Extends RecordingBaseOptions and includes additional properties for managing replay specific behavior.
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. |
bufferSecond | number | The length of the replay buffer in seconds. This determines how much time will be retained in memory before being written to disk on replay save. Must be at least 1. A shorter buffer can not hold a playable segment, and is rejected with a RecorderError carrying the MissingOrInvalidParameters (-11) code. Example: 30 will capture the last 30 seconds before the save. |
criticalEncodeSkipRate? | number | Output frame-skip rate (0–1) at which OBS is considered critically overloaded during an active recording. If this threshold is reached when the stop-replays timeout fires, OBS is force-killed even while a recording is active. Defaults to 0.5. |
fileFormat? | kFileFormat | Specifies the container format for the output video file. Common formats include 'fragmented_mp4', 'mkv', 'flv', etc. Default 'fragmented_mp4' See kFileFormat |
rootFolder | string | The root directory where replay videos will be saved. This path must be accessible and writable by the recording service. Example: "C:/Recordings/Replays" |
stopReplaysKillTimeoutMs? | number | How long (ms) to wait for OBS to acknowledge a stop before force-killing the process. Defaults to 30000 ms. |