MonitorCaptureSourceSettings
Electron APIs / Recorder / MonitorCaptureSourceSettings
Settings specific to capturing a monitor display as a video source.
Extends CaptureSourceSettings to include monitor-specific options such as display ID, capture method, cursor visibility, and optional SDR enforcement.
These settings define how the monitor content should be captured and rendered in the final output.
See
CaptureSourceSettings
Extends
Properties
| Property | Type | Description |
|---|---|---|
captureCursor? | boolean | Whether to include the mouse cursor in the captured video. Default true |
forceSDR? | boolean | Forces capture to standard dynamic range (SDR), disabling HDR tone mapping. |
monitorId | string | The identifier of the monitor to capture. This should match a valid monitor ID retrieved from system monitor info. |
stretchToOutputSize? | boolean | Whether the capture source should be centered and stretched to fit the output video size. When set to true, the source will automatically scale and center itself to match the output resolution, even if it requires stretching. Default true |
type? | DisplayCaptureType | The method or API used to capture the monitor content. Options include 'Auto', 'DXGI', 'BitBlt', and 'WGC'. Default 'Auto' |