Skip to content

ElectronDesktopCapturer

Unofficial

Electron desktop capturer for accessing information about media sources that can be used to capture audio and video from the desktop using the navigator.mediaDevices.getUserMedia API.

Import:

import type { ElectronDesktopCapturer } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface ElectronDesktopCapturer

Methods

Method Returns Description
getSources(options) Promise<ElectronDesktopCapturerSource[]> Resolves with an array of DesktopCapturerSource objects, each representing a screen or an individual window that can be captured.

Capturing the screen contents requires user consent on macOS 10.15 Catalina or higher, which can be detected via systemPreferences.getMediaAccessStatus.

Links to this page: