2015-12-08 05:09:36 +00:00
|
|
|
# desktopCapturer
|
2015-10-04 01:35:00 +00:00
|
|
|
|
2016-07-25 10:49:25 +00:00
|
|
|
> Access information about media sources that can be used to capture audio and
|
|
|
|
> video from the desktop using the [`navigator.webkitGetUserMedia`] API.
|
|
|
|
|
|
|
|
The following example shows how to capture video from a desktop window whose
|
|
|
|
title is `Electron`:
|
2015-10-04 01:35:00 +00:00
|
|
|
|
|
|
|
```javascript
|
|
|
|
// In the renderer process.
|
2016-05-10 16:26:38 +00:00
|
|
|
const {desktopCapturer} = require('electron');
|
2015-10-04 01:35:00 +00:00
|
|
|
|
2016-05-04 17:59:02 +00:00
|
|
|
desktopCapturer.getSources({types: ['window', 'screen']}, (error, sources) => {
|
2015-10-19 02:54:12 +00:00
|
|
|
if (error) throw error;
|
2016-05-10 17:15:09 +00:00
|
|
|
for (let i = 0; i < sources.length; ++i) {
|
2016-05-10 09:42:11 +00:00
|
|
|
if (sources[i].name === 'Electron') {
|
2015-10-06 06:34:54 +00:00
|
|
|
navigator.webkitGetUserMedia({
|
|
|
|
audio: false,
|
|
|
|
video: {
|
|
|
|
mandatory: {
|
|
|
|
chromeMediaSource: 'desktop',
|
|
|
|
chromeMediaSourceId: sources[i].id,
|
|
|
|
minWidth: 1280,
|
|
|
|
maxWidth: 1280,
|
|
|
|
minHeight: 720,
|
|
|
|
maxHeight: 720
|
|
|
|
}
|
2015-10-04 01:35:00 +00:00
|
|
|
}
|
2016-07-25 10:49:25 +00:00
|
|
|
}, handleStream, handleError);
|
2015-10-06 06:34:54 +00:00
|
|
|
return;
|
|
|
|
}
|
2015-10-04 01:35:00 +00:00
|
|
|
}
|
|
|
|
});
|
|
|
|
|
2016-07-25 10:49:25 +00:00
|
|
|
function handleStream(stream) {
|
2015-10-04 01:35:00 +00:00
|
|
|
document.querySelector('video').src = URL.createObjectURL(stream);
|
|
|
|
}
|
|
|
|
|
2016-07-25 10:49:25 +00:00
|
|
|
function handleError(e) {
|
|
|
|
console.log(e);
|
2015-10-04 01:35:00 +00:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2016-07-25 10:49:25 +00:00
|
|
|
To capture video from a source provided by `desktopCapturer` the constraints
|
|
|
|
passed to [`navigator.webkitGetUserMedia`] must include
|
|
|
|
`chromeMediaSource: 'desktop'`, and `audio: false`.
|
2015-12-15 22:07:55 +00:00
|
|
|
|
2016-07-25 10:49:25 +00:00
|
|
|
To capture both audio and video from the entire desktop the constraints passed
|
2016-07-26 04:57:39 +00:00
|
|
|
to [`navigator.webkitGetUserMedia`] must include `chromeMediaSource: 'screen'`,
|
2016-07-25 10:49:25 +00:00
|
|
|
and `audio: true`, but should not include a `chromeMediaSourceId` constraint.
|
2015-12-15 22:07:55 +00:00
|
|
|
|
2015-10-06 06:34:54 +00:00
|
|
|
## Methods
|
2015-10-04 01:35:00 +00:00
|
|
|
|
2015-10-06 06:34:54 +00:00
|
|
|
The `desktopCapturer` module has the following methods:
|
2015-10-04 01:35:00 +00:00
|
|
|
|
2015-10-06 06:34:54 +00:00
|
|
|
### `desktopCapturer.getSources(options, callback)`
|
2015-10-04 01:35:00 +00:00
|
|
|
|
2015-12-08 05:09:36 +00:00
|
|
|
* `options` Object
|
|
|
|
* `types` Array - An array of String that lists the types of desktop sources
|
|
|
|
to be captured, available types are `screen` and `window`.
|
2016-07-25 10:49:25 +00:00
|
|
|
* `thumbnailSize` Object (optional) - The suggested size that the media source
|
|
|
|
thumbnail should be scaled to, defaults to `{width: 150, height: 150}`.
|
2015-12-08 05:09:36 +00:00
|
|
|
* `callback` Function
|
2015-10-04 01:35:00 +00:00
|
|
|
|
2016-07-25 10:49:25 +00:00
|
|
|
Starts gathering information about all available desktop media sources,
|
|
|
|
and calls `callback(error, sources)` when finished.
|
2015-10-04 01:35:00 +00:00
|
|
|
|
2016-07-25 10:49:25 +00:00
|
|
|
`sources` is an array of `Source` objects, each `Source` represents a
|
|
|
|
screen or an individual window that can be captured, and has the following
|
|
|
|
properties:
|
2016-04-14 22:53:34 +00:00
|
|
|
|
2016-07-25 10:49:25 +00:00
|
|
|
* `id` String - The identifier of a window or screen that can be used as a
|
|
|
|
`chromeMediaSourceId` constraint when calling
|
|
|
|
[`navigator.webkitGetUserMedia`]. The format of the identifier will be
|
|
|
|
`window:XX` or `screen:XX`, where `XX` is a random generated number.
|
|
|
|
* `name` String - A screen source will be named either `Entire Screen` or
|
|
|
|
`Screen <index>`, while the name of a window source will match the window
|
|
|
|
title.
|
|
|
|
* `thumbnail` [NativeImage](native-image.md) - A thumbnail image. **Note:**
|
|
|
|
There is no guarantee that the size of the thumbnail is the same as the
|
|
|
|
`thumnbailSize` specified in the `options` passed to
|
|
|
|
`desktopCapturer.getSources`. The actual size depends on the scale of the
|
|
|
|
screen or window.
|
2015-12-08 05:09:36 +00:00
|
|
|
|
2016-07-25 10:49:25 +00:00
|
|
|
[`navigator.webkitGetUserMedia`]: https://developer.mozilla.org/en/docs/Web/API/Navigator/getUserMedia
|