Skip to main content

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

RecordingBaseOptions

Extends

Properties

PropertyTypeDescription
audioTrack?numberDefines 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?booleanAutomatically stops the recording when the game exits. This only applies when recording with a Game capture source.
bufferSecondnumberThe 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. Example: 30 will capture the last 30 seconds before the save.
fileFormat?kFileFormatSpecifies the container format for the output video file. Common formats include 'fragmented_mp4', 'mkv', 'flv', etc. Default 'fragmented_mp4' See kFileFormat
rootFolderstringThe root directory where replay videos will be saved. This path must be accessible and writable by the recording service. Example: "C:/Recordings/Replays"