desktopCapturer

navigator.mediaDevices.getUserMedia APIを使用して、デスクトップからの音声と映像のキャプチャに利用できるメディアソース関連の情報にアクセスします。

Process: Main

以下の例では、タイトルが Electron であるデスクトップウインドウからビデオをキャプチャする方法を示します。

// main.js
const { app, BrowserWindow, desktopCapturer, session } = require('electron')

app.whenReady().then(() => {
  const mainWindow = new BrowserWindow()

  session.defaultSession.setDisplayMediaRequestHandler((request, callback) => {
    desktopCapturer.getSources({ types: ['screen'] }).then((sources) => {
      // 最初に見つけた画面へのアクセスを認可します。
      callback({ video: sources[0], audio: 'loopback' })
    })
    // If true, use the system picker if available.
    // Note: this is currently experimental. If the system picker
    // is available, it will be used and the media request handler
    // will not be invoked.
  }, { useSystemPicker: true })

  mainWindow.loadFile('index.html')
})

// renderer.js
const startButton = document.getElementById('startButton')
const stopButton = document.getElementById('stopButton')
const video = document.querySelector('video')

startButton.addEventListener('click', () => {
  navigator.mediaDevices.getDisplayMedia({
    audio: true,
    video: {
      width: 320,
      height: 240,
      frameRate: 30
    }
  }).then(stream => {
    video.srcObject = stream
    video.onloadedmetadata = (e) => video.play()
  }).catch(e => console.log(e))
})

stopButton.addEventListener('click', () => {
  video.pause()
})

<!-- index.html -->
<html>
<meta http-equiv="content-security-policy" content="script-src 'self' 'unsafe-inline'" />
  <body>
    <button id="startButton" class="button">Start</button>
    <button id="stopButton" class="button">Stop</button>
    <video width="320" height="240" autoplay></video>
    <script src="renderer.js"></script>
  </body>
</html>

詳しくは navigator.mediaDevices.getDisplayMedia を参照してください。

info

navigator.mediaDevices.getDisplayMedia does not permit the use of deviceId for selection of a source - see specification.

メソッド

desktopCapturer モジュールには以下のメソッドがあります。

`desktopCapturer.getSources(options)`

options Object
- types string[] - キャプチャされるデスクトップソースの種別を列挙した文字列の配列。指定できる種別は、screen と window です。
- thumbnailSize Size (optional) - The size that the media source thumbnail should be scaled to. 省略値は 150 x 150 です。サムネイルが不要な場合は、幅または高さを 0 に設定してください。これにより、各ウィンドウおよび画面のコンテンツをキャプチャするために必要な処理時間が節約されます。
- fetchWindowIcons boolean (任意) - ウインドウアイコンの取得を有効にするには true に設定します。デフォルト値は false です。 false の場合、ソースの appIcon プロパティは null を返します。ソースが 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. Chrome、ひいては Electron はこれを提供していません。

Soundflower のような他の macOS アプリでシステムオーディオをキャプチャし、それを仮想オーディオ入力デバイスに渡すことでこの制限を回避することが可能です。この仮想デバイスは、 navigator.mediaDevices.getUserMedia.を使用して照会できます。

メソッド​

desktopCapturer.getSources(options)​

Caveats​

メソッド

`desktopCapturer.getSources(options)`

Caveats