desktopCapturer

访问关于使用navigator.mediaDevices.getUserMedia API 获取的可以用来从桌面捕获音频和视频的媒体源的信息。

进程：主进程

下面的示例演示如何从标题为 Electron 的桌面窗口捕获视频:

  1. // 在主进程中.
  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. // 在 preload 脚本中。
  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. }

为了从desktopCapturer提供的源捕获视频，传递给 navigator.mediaDevices.getUserMedia 的约束条件需包括 chromeMediaSource: 'desktop' 和 audio: false。

为了同时捕获整个桌面的音视频，传递给 navigator.mediaDevices.getUserMedia 的约束条件需包括 chromeMediaSource: 'desktop'，audio 和 视频，但不应该包括 chromeMediaSourceId 约束。

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

方法

desktopCapturer 模块有以下方法:

desktopCapturer.getSources(options)

  • 选项 对象
    • types string[] - 列出要捕获的桌面源类型的字符串数组，可用类型为 screen 和 window。
    • thumbnailSizeSize(可选) - 媒体源缩略图应缩放到的尺寸大小。 默认是 150 x 150。 当您不需要缩略图时，设置宽度或高度为0。 这将节省用于获取每个窗口和屏幕内容时的处理时间。
    • fetchWindowIcons boolean (可选) - 设置为 true 以启用提取窗口图标。 默认值为false。 当值为false时，源的appIcon属性返回null。 如果一个源是屏幕类型也是如此。

返回 Promise<DesktopCapturerSource[]> - resolve 一个DesktopCapturerSource 对象类型的数组，每个 DesktopCapturerSource 代表一个屏幕或一个可以被捕获的独立窗口。

注意 在macOS 10.15 Catalina 或更高版本上捕获屏幕内容需要用户同意，可通过 systemPreferences.getMediaAccessStatus 检测是否授权。

注意事项

由于存在基本限制，因此navigator.mediaDevices.getUserMedia 无法在macOS上进行音频捕获，因此要访问系统音频的应用程序需要一个签名内核拓展. Chromium以及Electron扩展不提供这个。

通过使用另一个MacOS应用程序（如Soundflower）捕获系统音频并将其通过虚拟音频输入设备来规避此限制是可能的。 然后可以用 navigator.mediaDevices.getUserMedia查询该虚拟设备。