-
Notifications
You must be signed in to change notification settings - Fork 206
fix: update docs around macOS & desktopCapturer
#1010
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
fix: update docs around macOS & desktopCapturer
#1010
Conversation
🍏 : This page was outdated since ~macOS 13 when Apple added ways to capture audio w/o signed kernel extension. Apple's latest [`CoreAudio Tap API `](https://github.com/insidegui/AudioCap) also has some [relevant nuances](electron/electron#49607) worth mentioning.
…eam Chromium pivot in native Apple API usage 🍏 : Affects macOS >=14.2 electron apps starting in `v39.0.0-beta4`. Full triage of issue available [here](electron/electron#49607).
desktopCapturer
desktopCapturerdesktopCapturer
nikwen
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you so much for your work on this!
Could you please add "Refs electron/electron#49607" at the beginning of the PR? That makes it easier for maintainers to find the related issue quickly.
|
Great feedback @nikwen 👍 really appreciate the maintainer support on this! Curious is there a way to preview changes made to documentation markdown in the main electron repo? I had assumed doc changes flowed in the opposite direction so changes could be easily previewed with local instance of the doc website when being drafted/added. |
Description of Change
Refs electron/electron#49607
PR contains big update for
desktopCapturerdocumentation and related nuance on macOS. Notably:Clarify macOS
desktopCapturefor audio has been available since macOS 13 and higher. Prior to this it was only via signed kernel extension & not supported by Chromium/Electron directly.More recently, Chromium switched to use Apple's newer native API for audio capture.
NSAudioCaptureUsageDescriptionin the App's Info.plist. Thus electron apps now require the same to usedesktopCapturerproperly on macOS >=14.2 where Apple introduced the API.Screen & System Audio Recordingpermissions system if the newer API fails. Meaning electron apps that don't have the newNSAudioCaptureUsageDescriptionkey will seedesktopCapturerbreak on version jumpv39.0.0-beta.3tov39.0.0-beta.4. In that version jump is where we see Chromium enables the newCoreAudio Tap APIby default.In addition to doc bump for
desktopCapturerthis PR also adds a note about the relevant breaking change to the Electron 39.0.0 Release Blog.A lot of the findings added in this PR came from my triage/investigation in this issue
Checklist