desktopCapturer

通过[navigator.mediaDevices.getUserMedia] API ，可以访问那些用于从桌面上捕获音频和视频的媒体源信息。

进程: Renderer

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

  1. // In the renderer process.
  2. const { desktopCapturer } = require('electron')
  4. desktopCapturer.getSources({ types: ['window', 'screen'] }, (error, sources) => {
  5.   if (error) throw error
  6.   for (let i = 0; i < sources.length; ++i) {
  7.     if (sources[i].name === 'Electron') {
  8.       navigator.mediaDevices.getUserMedia({
  9.         audio: false,
  10.         video: {
  11.           mandatory: {
  12.             chromeMediaSource: 'desktop',
  13.             chromeMediaSourceId: sources[i].id,
  14.             minWidth: 1280,
  15.             maxWidth: 1280,
  16.             minHeight: 720,
  17.             maxHeight: 720
  18.           }
  19.         }
  20.       }).then((stream) => handleStream(stream))
  21.         .catch((e) => handleError(e))
  22.       return
  23.     }
  24.   }
  25. })
  27. function handleStream (stream) {
  28.   const video = document.querySelector('video')
  29.   video.srcObject = stream
  30.   video.onloadedmetadata = (e) => video.play()
  31. }
  33. function handleError (e) {
  34.   console.log(e)
  35. }

若要从 desktopCapturer 提供的源捕获视频, 则传递给 [navigator.mediaDevices.getUserMedia] 的约束必须包括 chromeMediaSource: "desktop" 和 audio: false。

要从整个桌面同时捕获音频和视频, 传递给 [navigator.mediaDevices.getUserMedia] 的约束必须包括 chromeMediaSource: ' desktop ', 同时用于 audio 和 video, 但不应包括 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, callback)

  • options 对象

    • typesString[]-列出要捕获的桌面源类型的字符串数组, 可用类型为 screen 和 window。
    • thumbnailSize Size (可选)-媒体源缩略图应缩放到的大小。默认值为 150 x 150。

  • callback Function - 回调函数

    • error Error
    • sources DesktopCapturerSource[]
      开始收集所有有效桌面媒体源的信息，当结束时将调用 callback(error, sources)

sources 是 DesktopCapturerSource对象数组, 每个DesktopCapturerSource 代表一个屏幕或一个可捕获的独立窗口。