2016-10-14 02:00:03 +00:00
|
|
|
# DesktopCapturerSource Object
|
2016-10-13 06:30:57 +00:00
|
|
|
|
2021-11-16 04:13:18 +00:00
|
|
|
* `id` string - The identifier of a window or screen that can be used as a
|
2016-10-13 06:30:57 +00:00
|
|
|
`chromeMediaSourceId` constraint when calling
|
|
|
|
[`navigator.webkitGetUserMedia`]. The format of the identifier will be
|
2021-01-11 03:20:00 +00:00
|
|
|
`window:XX:YY` or `screen:ZZ:0`. XX is the windowID/handle. YY is 1 for
|
|
|
|
the current process, and 0 for all others. ZZ is a sequential number
|
|
|
|
that represents the screen, and it does not equal to the index in the
|
|
|
|
source's name.
|
2021-11-16 04:13:18 +00:00
|
|
|
* `name` string - A screen source will be named either `Entire Screen` or
|
2016-10-13 06:30:57 +00:00
|
|
|
`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
|
2016-10-24 06:34:09 +00:00
|
|
|
`thumbnailSize` specified in the `options` passed to
|
2016-10-13 06:30:57 +00:00
|
|
|
`desktopCapturer.getSources`. The actual size depends on the scale of the
|
|
|
|
screen or window.
|
2021-11-16 04:13:18 +00:00
|
|
|
* `display_id` string - A unique identifier that will correspond to the `id` of
|
2018-04-09 05:43:35 +00:00
|
|
|
the matching [Display](display.md) returned by the [Screen API](../screen.md).
|
|
|
|
On some platforms, this is equivalent to the `XX` portion of the `id` field
|
|
|
|
above and on others it will differ. It will be an empty string if not
|
|
|
|
available.
|
2018-12-04 06:42:49 +00:00
|
|
|
* `appIcon` [NativeImage](../native-image.md) - An icon image of the
|
|
|
|
application that owns the window or null if the source has a type screen.
|
2020-08-18 07:55:16 +00:00
|
|
|
The size of the icon is not known in advance and depends on what
|
2018-12-04 06:42:49 +00:00
|
|
|
the application provides.
|