electron/docs/api
Julien Isorce 9b29befdc8 feat: disable fetching thumbnails if thumbnailSize is 0 (#14906)
Capturing window thmubnails is expensive as it actually uses the
window capturer and it records one full frame per window and then
downscale to the default size 150x150. When only interested in the
window names or the app icons we do not need all of this.

Underlying change is merged in chromium72 so this patch only modifies
the doc, see:
  https://chromium.googlesource.com/chromium/src.git/+log/72.0.3626.52/chrome/browser/media/webrtc/native_desktop_media_list.cc

Example: desktopCapturer.getSources({thumbnailSize: {width: 0, height: 0}}, ...)

Also added a unit test in spec/api-desktop-capturer-spec.js that verifies
that the returned thumbails are of type NativeImage and empty,
when the user disable fetching thumbnails.

notes: Can disable fetching the thumbnails for the DesktopCapturer.

https://github.com/electron/electron/issues/14872
2019-02-13 10:27:42 -08:00
..
structures feat: add new components to Display structure (#16870) 2019-02-12 05:34:42 -10:00
accelerator.md feat: add support for scroll lock accelerator (#16873) 2019-02-11 09:13:13 -10:00
app.md feat: promisify app.dock.show() (#16904) 2019-02-12 21:06:33 -08:00
auto-updater.md docs: clarify default auto-updater installation behavior (#12783) 2018-07-25 08:33:53 +10:00
breaking-changes.md chore: Add new webFrame IsolatedWorldInfo API and deprecate (#16801) 2019-02-13 08:05:28 -10:00
browser-view.md feat: flexible autoresize for BrowserViews (#16184) 2019-01-31 11:07:19 +09:00
browser-window-proxy.md
browser-window.md feat: implement BrowserWindow.moveTop on X11 (#16629) 2019-02-07 12:48:19 -08:00
chrome-command-line-switches.md chore: update to standard 12 2018-09-14 14:57:01 +10:00
client-request.md feat: add getUploadProgress API to the net API (#13783) 2018-07-27 07:15:48 -07:00
clipboard.md feat: add webPreferences.enableRemoteModule option (#13028) 2018-10-13 20:50:07 +03:00
content-tracing.md feat: promisify contentTracing recording APIs (#16584) 2019-01-30 18:53:55 -08:00
cookies.md feat: promisify cookies api (#16464) 2019-01-25 12:11:35 -06:00
crash-reporter.md docs: reorder crashReporter notes to make more sense (#16825) 2019-02-08 13:26:59 -08:00
debugger.md feat: promisify debugger.sendCommand() (#16861) 2019-02-13 07:23:53 -10:00
desktop-capturer.md feat: disable fetching thumbnails if thumbnailSize is 0 (#14906) 2019-02-13 10:27:42 -08:00
dialog.md docs: Recommend use of callback with dialog.showSaveDialog (#16649) 2019-02-03 23:56:51 -08:00
download-item.md feat: add methods to allow customization of save dialog during will-download event (#15497) 2018-11-08 10:51:06 -04:00
environment-variables.md refactor: remove hardcoded google api key (#15478) 2018-10-31 07:49:44 -07:00
file-object.md docs: es6ify 'Breaking Changes' and 'File' API pages (#15507) 2018-12-05 23:14:52 +11:00
frameless-window.md fix: incorrect view ordering for customButtonsOnHover (#15564) 2018-12-10 11:05:30 -08:00
global-shortcut.md fix: don't register some shortcuts without accessibility (#16125) 2019-01-03 20:40:17 -08:00
in-app-purchase.md docs: fix the type information in in-app-purchase 2018-05-03 09:34:21 -07:00
incoming-message.md
ipc-main.md feat: preloads and nodeIntegration in iframes (#16425) 2019-01-22 11:24:46 -08:00
ipc-renderer.md doc: correct ipcRenderer sendTo windowId param (#15403) 2018-10-26 10:18:47 -05:00
locales.md
menu-item.md refactor: convert more files to typescript (#16820) 2019-02-12 04:22:33 -10:00
menu.md feat: allow Menu.buildFromTemplate() to accept MenuItems (#16697) 2019-02-06 10:04:40 -08:00
native-image.md chore: update to standard 12 2018-09-14 14:57:01 +10:00
net-log.md refactor: create request context from network context (#14656) 2018-10-04 13:08:56 -05:00
net.md chore: update to standard 12 2018-09-14 14:57:01 +10:00
notification.md
power-monitor.md chore: update to standard 12 2018-09-14 14:57:01 +10:00
power-save-blocker.md chore: update to standard 12 2018-09-14 14:57:01 +10:00
process.md feat: preloads and nodeIntegration in iframes (#16425) 2019-01-22 11:24:46 -08:00
promisification.md feat: promisify debugger.sendCommand() (#16861) 2019-02-13 07:23:53 -10:00
protocol.md chore: fix lint errors (#16906) 2019-02-13 00:19:47 +05:30
remote.md feat: add webPreferences.enableRemoteModule option (#13028) 2018-10-13 20:50:07 +03:00
sandbox-option.md feat: enable mixed-sandbox mode by default (#15894) 2019-01-22 10:44:28 -08:00
screen.md chore: remove deprecated modules internally using remote.require in sandboxed renderer context (#15957) 2019-01-24 10:53:52 -08:00
session.md refactor: create request context from network context (#14656) 2018-10-04 13:08:56 -05:00
shell.md feat: split openExternal into sync and async (#16176) 2019-01-14 20:35:21 -08:00
synopsis.md chore: update to standard 12 2018-09-14 14:57:01 +10:00
system-preferences.md feat: add mac support to systemPrefs.getColor() (#16249) 2019-01-03 16:17:07 -08:00
touch-bar-button.md
touch-bar-color-picker.md
touch-bar-group.md
touch-bar-label.md
touch-bar-popover.md
touch-bar-scrubber.md
touch-bar-segmented-control.md
touch-bar-slider.md
touch-bar-spacer.md
touch-bar.md docs: Fix TouchBar API example (#16482) 2019-01-21 17:07:47 -08:00
tray.md chore: update to standard 12 2018-09-14 14:57:01 +10:00
web-contents.md feat: promisify webContents.printToPDF() (#16795) 2019-02-11 09:20:04 -10:00
web-frame.md chore: Add new webFrame IsolatedWorldInfo API and deprecate (#16801) 2019-02-13 08:05:28 -10:00
web-request.md docs: fix referrer typedef in OnCompletedDetails (#16661) 2019-02-01 07:54:31 -08:00
webview-tag.md docs: remove removed autosize attribute (#16884) 2019-02-11 14:15:15 -08:00
window-open.md docs: specify BrowserWindow features passable to window.open 2018-09-10 17:49:54 +02:00