feat: Implement electron.DesktopCapturer.SetSkipCursor #25103

CapOM · 2020-08-24T06:58:55Z

Description of Change

Checklist

PR description included and stakeholders cc'd
npm test passes
tests are changed or added
relevant documentation is changed or added
PR title follows semantic commit guidelines
PR release notes describe the change in a way relevant to app developers, and are capitalized, punctuated, and past tense.
This is NOT A BREAKING CHANGE. Breaking changes may not be merged to master until 11-x-y is branched.

Release Notes

Notes: Can disable or re-enable cursor capturer while the stream is running

This reverts commit c141b1a.

This reverts commit 2789f32.

This reverts commit 2342aaf.

Co-authored-by: Cheng Zhao <zcbenz@gmail.com>

Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

Co-authored-by: Cheng Zhao <zcbenz@gmail.com>

Co-authored-by: John Kleinschmidt <jkleinsc@github.com>

…lectron#23771) When application is activated thru macOS app switcher (cmd+tab) the App's activate event is note emitted. The reason is that `applicationShouldHandleReopen:hasVisibleWindows:` is sent only when app is activated via Dock. Using `applicationDidBecomeActive:` is handling all cases properly. Co-authored-by: Lukas Weber <luweber@microsoft.com>

Co-authored-by: Cheng Zhao <zcbenz@gmail.com>

…tcher (electron#23771)" (electron#23819) This reverts commit 7709e60.

Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

Co-authored-by: Aleksei Kuzmin <alkuzmin@microsoft.com>

Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

* refactor: use typeutils for nativeImage serialization (electron#23693) * fix: ensure nativeImage serialization main->renderer

…ectron#23876) (cherry picked from commit 4133c71)

The devtools profiler is not attached at the point we run out init scripts (or our apps preload scripts), we do not really want to change when we run these init scripts but for when a dev is doing performance work it makes sense to give them an option to make the devtools profiler actually work on both our init scripts and their preload script. This PR adds that logic behind an environment variable ELECTRON_PROFILE_INIT_SCRIPTS. Co-authored-by: Samuel Attard <samuel.r.attard@gmail.com>

Co-authored-by: Cheng Zhao <zcbenz@gmail.com>

…d preloads (electron#23893) Co-authored-by: Samuel Attard <samuel.r.attard@gmail.com>

…enabled (electron#23896) * fix: add patch to prevent crash during frame swap with ctx isolation enabled * Update .patches * chore: update patches Co-authored-by: Samuel Attard <samuel.r.attard@gmail.com> Co-authored-by: Samuel Attard <sattard@slack-corp.com>

* docs: move protocol-ns to protocol.md * chore: fix up tests and implement missing pieces required for tests Co-authored-by: Samuel Attard <samuel.r.attard@gmail.com>

Co-authored-by: Samuel Attard <sattard@slack-corp.com>

…lectron#23899) This regressed once again in Electron 8 due to Chromium changes. Test Plan: - Confirm that test case from electron#15898 (comment) now works Notes: Fix disabling color correct rendering with `--disable-color-correct-rendering` Co-authored-by: Biru Mohanathas <birunthan@mohanathas.com>

Useful to dynamically stop cursor capture in the stream. By default the cursor is captured. First argument is a deviceId so one can stop capturing the cursor for a specific streamed source. electron#23923 Notes: Can enable or disable capturing cursor while the stream is running

jkleinsc

Please target master instead of 10-x-y. We do not add features directly to release branches but we will backport them.

MarshallOfSound

These are fairly chonky patches, can you attempt to upstream them so we don't have to take that burden?

CapOM · 2020-09-12T05:53:06Z

These are fairly chonky patches, can you attempt to upstream them so we don't have to take that burden?

It would not be possible to upstream it in the current state. I think the only way would be to start implementing MediaTrackSupportedConstraints.cursor (values always, never, motion) , see the w3c spec https://www.w3.org/TR/screen-capture/#cursorcaptureconstraint . But that would be to support getDisplayMedia which is not currently supported by electron: #16513 (comment)
So that would reduce this PR but not sure how much.

There are some technical details here but essentially skipping the cursor on a particular source would affect all calls to getUserMedia or getDisplayMedia on that particular source (i.e. a particular app window A)

This is because the compositing of the cursor and the frame is done in the webrtc capturer. Some interfaces would need to be changed in chromium/media first to allow passing a frame and the cursor as a meta overlay. So that consumers of the capturer could decide or not to composite the frame with the cursor independently of each others for the same source.

That said currently this PR allows to show and hide the cursor on the fly. And skipping the cursor on a source app window A does not affect capturing the cursor on another source B. It only affects if there are multiple captures of the same source app window A at the same time.
As mentioned above, it would be very difficult to avoid that corner case when implementing MediaTrackSupportedConstraints.cursor. Also the use case were we would want to skip and show the cursor on app window A , should be rare.

Note that even if this PR touches lot of files but only a few lines per files and the changes are quite redundant.

pavlobu · 2020-10-07T20:00:34Z

Great work!
really waiting for it to appear in new version

miniak · 2020-10-13T23:03:09Z

docs/api/desktop-capturer.md

@@ -97,6 +97,13 @@ which can detected by [`systemPreferences.getMediaAccessStatus`].
 [`navigator.mediaDevices.getUserMedia`]: https://developer.mozilla.org/en/docs/Web/API/MediaDevices/getUserMedia
 [`systemPreferences.getMediaAccessStatus`]: system-preferences.md#systempreferencesgetmediaaccessstatusmediatype-macos

+### `desktopCapturer.SetSkipCursor(sourceId, skip)`


Suggested change

### `desktopCapturer.SetSkipCursor(sourceId, skip)`

### `desktopCapturer.setSkipCursor(sourceId, skip)`

apodolny · 2020-10-28T23:09:01Z

Would love to see this merged — @nornagon @miniak let me know if there's anything I can do to help.

nornagon · 2020-10-28T23:53:31Z

Looks like this PR somehow got messed up. I can't review it as is.

apodolny · 2020-11-02T18:14:34Z

@miniak do you have time to resolve the issues here?

ns-jisorce · 2020-11-03T12:11:36Z

Hi, I will try to rebase my PR against master later this year

apodolny · 2020-11-11T00:44:23Z

@CapOM, are you able to rebase against master? Let me know if there's anything I can do to help.

adityak368 · 2021-02-18T21:27:51Z

Any update on this? Let me know if I can help

CapOM · 2021-02-18T21:57:13Z

Yes please go ahead with the rebase if you have some time, I do not have the bandwidth for now. Thanks

tristaaan · 2021-02-26T17:20:47Z

I tried rebasing on master and I had a rather difficult time with it and ended up cherry-picking the commit.
https://github.com/tristaaan/electron/tree/set_skip_cursor_rebased

apodolny · 2021-03-11T03:33:50Z

Seems like something has happened to this PR again :(

nornagon · 2021-03-11T19:49:58Z

I'm closing this PR as it's unreviewable in its current state, please open a new PR if you're interested in continuing development!

apodolny · 2021-03-18T16:38:12Z

@tristaaan

I tried rebasing on master and I had a rather difficult time with it and ended up cherry-picking the commit.
https://github.com/tristaaan/electron/tree/set_skip_cursor_rebased

Do you want to make a new PR based on your change?

adityak368 · 2021-03-19T20:22:11Z

@CapOM Created a new PR instead of rebase, which seemed to be the easier way. I think the patches needs to be updated as it failed to apply for me.

electron-bot and others added 30 commits May 21, 2020 13:33

Bump v10.0.0-beta.1

c141b1a

Revert "Bump v10.0.0-beta.1"

03ddd2d

This reverts commit c141b1a.

fix: support 10-x-y in the release notes generator (electron#23709)

4c8b884

Bump v10.0.0-beta.1

2789f32

Revert "Bump v10.0.0-beta.1"

05efbbc

This reverts commit 2789f32.

Revert "feat: look harder for a commit's pull request. (electron#23593)"

9de5ede

This reverts commit 2342aaf.

Bump v10.0.0-beta.1

95e3853

fix: read GTK dark theme setting on Linux (electron#23711)

f8508b3

Co-authored-by: Cheng Zhao <zcbenz@gmail.com>

fix: trigger about panel for about role on on win (electron#23717)

1fb11e1

Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

test: use WebContents event to test beforeunload (electron#23766)

471f805

Co-authored-by: Cheng Zhao <zcbenz@gmail.com>

ci: deflake WOA tests (electron#23769)

0962c1b

Co-authored-by: John Kleinschmidt <jkleinsc@github.com>

fix: pass correct buffer length (electron#23798)

c2354d4

Co-authored-by: Cheng Zhao <zcbenz@gmail.com>

Revert "fix: trigger activate event when app is activated via app swi…

50efa84

…tcher (electron#23771)" (electron#23819) This reverts commit 7709e60.

fix: only bezel frameless windows (electron#23809)

4fe7c9a

Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

fix: volume key globalShortcut registration (electron#23823)

c0183d1

Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

test: refactor how spec files are collected (electron#23811)

241e74c

Co-authored-by: Aleksei Kuzmin <alkuzmin@microsoft.com>

fix: handle asynchronous URL loading in bw proxy (electron#23804)

eb93acc

Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

fix: weakly reference MenuModel from MenuController (electron#23806)

cee9e6f

Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>

fix: ensure nativeImage serialization main->renderer (electron#23794)

9d2aa93

* refactor: use typeutils for nativeImage serialization (electron#23693) * fix: ensure nativeImage serialization main->renderer

Bump v10.0.0-beta.2

12ea1c0

build: fix for "enable_desktop_capturer = false" (electron#23864) (el…

cc0c763

…ectron#23876) (cherry picked from commit 4133c71)

fix: do not use CONTEXT_MENU flag for tray menu (electron#23879)

d4001c1

Co-authored-by: Cheng Zhao <zcbenz@gmail.com>

test: wait for beforeunload handler to be installed (electron#23898)

67be469

Co-authored-by: Cheng Zhao <zcbenz@gmail.com>

fix: expose electron/common and electron/renderer modules in sandboxe…

79acd3e

…d preloads (electron#23893) Co-authored-by: Samuel Attard <samuel.r.attard@gmail.com>

docs: move protocol-ns to protocol.md (electron#23911)

9ea42da

* docs: move protocol-ns to protocol.md * chore: fix up tests and implement missing pieces required for tests Co-authored-by: Samuel Attard <samuel.r.attard@gmail.com>

docs: default of allowRendererProcessReuse is true (electron#23912)

a8fc41d

Co-authored-by: Samuel Attard <sattard@slack-corp.com>

CapOM requested review from a team as code owners August 24, 2020 06:58

electron-cation bot added the new-pr 🌱 PR opened in the last 24 hours label Aug 24, 2020

CapOM changed the base branch from master to 10-x-y August 24, 2020 06:59

CapOM changed the title ~~Set skip cursor~~ feat: Implement electron.DesktopCapturer.SetSkipCursor Aug 24, 2020

jkleinsc requested changes Aug 24, 2020

View reviewed changes

MarshallOfSound reviewed Aug 24, 2020

View reviewed changes

electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Aug 25, 2020

miniak reviewed Oct 13, 2020

View reviewed changes

miniak changed the base branch from 10-x-y to master October 13, 2020 23:03

miniak requested a review from nornagon as a code owner October 13, 2020 23:03

zcbenz added the wip ⚒ label Feb 24, 2021

nornagon closed this Mar 11, 2021

adityak368 mentioned this pull request Mar 19, 2021

feat: Implement desktopCapturer.setSkipCursor #28302

Closed

5 tasks

danielehrhardt mentioned this pull request Jul 21, 2021

feat: add electron.DesktopCapturer.setSkipCursor() method #30231

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Implement electron.DesktopCapturer.SetSkipCursor #25103

feat: Implement electron.DesktopCapturer.SetSkipCursor #25103

CapOM commented Aug 24, 2020 •

edited

jkleinsc left a comment

MarshallOfSound left a comment

CapOM commented Sep 12, 2020

pavlobu commented Oct 7, 2020 •

edited

miniak Oct 13, 2020

apodolny commented Oct 28, 2020

nornagon commented Oct 28, 2020

apodolny commented Nov 2, 2020

ns-jisorce commented Nov 3, 2020

apodolny commented Nov 11, 2020

adityak368 commented Feb 18, 2021

CapOM commented Feb 18, 2021

tristaaan commented Feb 26, 2021

apodolny commented Mar 11, 2021

nornagon commented Mar 11, 2021

apodolny commented Mar 18, 2021 •

edited

adityak368 commented Mar 19, 2021 •

edited

	### `desktopCapturer.SetSkipCursor(sourceId, skip)`
	### `desktopCapturer.setSkipCursor(sourceId, skip)`

feat: Implement electron.DesktopCapturer.SetSkipCursor #25103

feat: Implement electron.DesktopCapturer.SetSkipCursor #25103

Conversation

CapOM commented Aug 24, 2020 • edited

Description of Change

Checklist

Release Notes

jkleinsc left a comment

Choose a reason for hiding this comment

MarshallOfSound left a comment

Choose a reason for hiding this comment

CapOM commented Sep 12, 2020

pavlobu commented Oct 7, 2020 • edited

miniak Oct 13, 2020

Choose a reason for hiding this comment

apodolny commented Oct 28, 2020

nornagon commented Oct 28, 2020

apodolny commented Nov 2, 2020

ns-jisorce commented Nov 3, 2020

apodolny commented Nov 11, 2020

adityak368 commented Feb 18, 2021

CapOM commented Feb 18, 2021

tristaaan commented Feb 26, 2021

apodolny commented Mar 11, 2021

nornagon commented Mar 11, 2021

apodolny commented Mar 18, 2021 • edited

adityak368 commented Mar 19, 2021 • edited

CapOM commented Aug 24, 2020 •

edited

pavlobu commented Oct 7, 2020 •

edited

apodolny commented Mar 18, 2021 •

edited

adityak368 commented Mar 19, 2021 •

edited