Skip to main content

CaptureSettingsOptions

Electron APIs / recorder / CaptureSettingsOptions

Optional parameters used to configure a CaptureSettings object before creation.

This interface provides configuration for encoder selection, audio device handling, and track separation logic for audio sources.

See

Properties

PropertyTypeDescription
audioEncoder?stringAudio encoder to use. Default 'ffmpeg_aac' Use queryInformation().encoders.audio to see the supported encoders. See kKnownAudioEncodersTypes
includeDefaultAudioSources?booleanWhether to add default audio devices. Default true
separateAudioTracks?booleanAutomatically separate audio tracks. When using the default audio sources, the input and output devices will be recorded to dedicated tracks (2 and 3), and track number 1 will include both.
videoEncoder?kSupportedEncodersTypesEncoder type to create the capture setting. Default is the best default encoder detected (GPU → x264).