desktopCapturer

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

Process: Main

The following example shows how to capture video from a desktop window whose title is Electron:

  1. // In the main process.
  2. const { desktopCapturer } = require('electron')
  4. desktopCapturer.getSources({ types: ['window', 'screen'] }).then(async sources => {
  5.   for (const source of sources) {
  6.     if (source.name === 'Electron') {
  7.       mainWindow.webContents.send('SET_SOURCE', source.id)
  8.       return
  9.     }
  10.   }
  11. })
  1. // In the preload script.
  2. const { ipcRenderer } = require('electron')
  4. ipcRenderer.on('SET_SOURCE', async (event, sourceId) => {
  5.   try {
  6.     const stream = await navigator.mediaDevices.getUserMedia({
  7.       audio: false,
  8.       video: {
  9.         mandatory: {
  10.           chromeMediaSource: 'desktop',
  11.           chromeMediaSourceId: sourceId,
  12.           minWidth: 1280,
  13.           maxWidth: 1280,
  14.           minHeight: 720,
  15.           maxHeight: 720
  16.         }
  17.       }
  18.     })
  19.     handleStream(stream)
  20.   } catch (e) {
  21.     handleError(e)
  22.   }
  23. })
  25. function handleStream (stream) {
  26.   const video = document.querySelector('video')
  27.   video.srcObject = stream
  28.   video.onloadedmetadata = (e) => video.play()
  29. }
  31. function handleError (e) {
  32.   console.log(e)
  33. }

To capture video from a source provided by desktopCapturer the constraints passed to navigator.mediaDevices.getUserMedia must include chromeMediaSource: 'desktop', and audio: false.

To capture both audio and video from the entire desktop the constraints passed to navigator.mediaDevices.getUserMedia must include chromeMediaSource: 'desktop', for both audio and video, but should not include a chromeMediaSourceId constraint.

  1. const constraints = {
  2.   audio: {
  3.     mandatory: {
  4.       chromeMediaSource: 'desktop'
  5.     }
  6.   },
  7.   video: {
  8.     mandatory: {
  9.       chromeMediaSource: 'desktop'
  10.     }
  11.   }
  12. }

Methods

The desktopCapturer module has the following methods:

desktopCapturer.getSources(options)

  • options Object
    • types string[] - An array of strings that lists the types of desktop sources to be captured, available types are screen and window.
    • thumbnailSize Size (optional) - The size that the media source thumbnail should be scaled to. Default is 150 x 150. Set width or height to 0 when you do not need the thumbnails. This will save the processing time required for capturing the content of each window and screen.
    • fetchWindowIcons boolean (optional) - Set to true to enable fetching window icons. The default value is false. When false the appIcon property of the sources return null. Same if a source has the type screen.

Returns Promise<DesktopCapturerSource[]> - Resolves with an array of DesktopCapturerSource objects, each DesktopCapturerSource represents a screen or an individual window that can be captured.

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

Caveats

navigator.mediaDevices.getUserMedia does not work on macOS for audio capture due to a fundamental limitation whereby apps that want to access the system’s audio require a signed kernel extension. Chromium, and by extension Electron, does not provide this.

It is possible to circumvent this limitation by capturing system audio with another macOS app like Soundflower and passing it through a virtual audio input device. This virtual device can then be queried with navigator.mediaDevices.getUserMedia.