Specifiy function param types in docs
This commit is contained in:
parent
7584e73d70
commit
20323e7032
13 changed files with 226 additions and 133 deletions
14
docs/api/structures/desktop-capturer-source.md
Normal file
14
docs/api/structures/desktop-capturer-source.md
Normal file
|
@ -0,0 +1,14 @@
|
|||
# Desktop Capturer Source Object
|
||||
|
||||
* `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.
|
6
docs/api/structures/upload-data.md
Normal file
6
docs/api/structures/upload-data.md
Normal file
|
@ -0,0 +1,6 @@
|
|||
# ThumbarButton Object
|
||||
|
||||
* `bytes` Buffer - Content being sent.
|
||||
* `file` String - Path of file being uploaded.
|
||||
* `blobUUID` String - UUID of blob data. Use [ses.getBlobData](../session.md#sesgetblobdataidentifier-callback) method
|
||||
to retrieve the data.
|
Loading…
Add table
Add a link
Reference in a new issue