WindowCaptureSourceSettings
Electron APIs / Recorder / WindowCaptureSourceSettings
Settings for capturing a specific window as a video source.
Extends CaptureSourceSettings with window-specific capture options, including capture method,
process identification, cursor visibility, and display compatibility.
See
CaptureSourceSettings
Extends
Properties
| Property | Type | Description |
|---|
captureCursor? | boolean | Whether to include the mouse cursor in the window capture. Default true |
clientArea? | boolean | If true, captures only the client area of the window (excluding borders and title bar). Default true |
compatibility? | boolean | Enables BitBlt compatibility mode for multi-GPU (multi-adapter) setups. May improve stability when using traditional window capture on systems with more than one GPU. |
executable | string | The name of the executable associated with the window to capture. This is typically the process name (e.g., "notepad.exe" or "chrome.exe"). |
forceSDR? | boolean | If true, forces capture to standard dynamic range (SDR), disabling high dynamic range output if the window supports it. |
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? | any | The capture method used to record the window. Options depend on system capabilities and may include 'Auto', 'BitBlt', or 'WGC' (Windows Graphics Capture). Default 'Auto' |