feat: add enableLocalEcho flag to setDisplayMediaRequestHandler() callback

[theogravity]

Description of Change

This adds a boolean option called enableLocalEcho to the callback handler for setDisplayMediaRequestHandler() which prevents input from being echoed in the local output stream (e.g., speaker). It can only be used if the audio property is set to a WebFrameMain. Closes #37293.

Checklist

• PR description included and stakeholders cc'd
• npm test passes
• tests are changed or added
• relevant documentation, tutorials, templates and examples are changed or added
• PR release notes describe the change in a way relevant to app developers, and are capitalized, punctuated, and past tense.

Release Notes

Notes: Added the enableLocalEcho flag to the session handler ses.setDisplayMediaRequestHandler() callback for allowing remote audio input to be echoed in the local output stream when audio is a WebFrameMain.

[welcome]

💖 Thanks for opening this pull request! 💖

We use semantic commit messages to streamline the release process. Before your pull request can be merged, you should update your pull request title to start with a semantic prefix.

Examples of commit messages with semantic prefixes:

• fix: don't overwrite prevent_default if default wasn't prevented
• feat: add app.isPackaged() method
• docs: app.isDefaultProtocolClient is now available on Linux

Things that will help get your PR across the finish line:

• Follow the JavaScript, C++, and Python coding style.
• Run npm run lint locally to catch formatting errors earlier.
• Document any user-facing changes you've made following the documentation styleguide.
• Include tests when adding/changing behavior.
• Include screenshots and animated GIFs whenever possible.

We get a lot of pull requests on this repo, so please be patient and we will get back to you as soon as we can.

[theogravity]

FYI, I have zero C++ experience and did my best to kind of figure things out as a JS dev and read through the Contributing section of the Electron docs as a guide. I do have a colleague who is versed in C++ and will take over should any revisions required get pretty complicated.

I'm not too keen on having a property that relies on another property being set with a specific type to activate, but not sure how to go about it overall.

Also the naming of the flag itself feels odd to have it as disable vs enable, but I left it as disable since the default behavior was true to begin with and the comment around it said disable_local_echo.

I couldn't figure out how to update the typescript definition for the callback. I am aware that @electron/typescript-definitions exists, but there does not seem to be any documentation on when this is involved during the development cycle.

[theogravity]

I don't have any further edits to the PR - it should be ready for review.

[theogravity]

@VerteDinde is there anything about this PR that prevents it from getting a review? Or just need to schedule it for review within your sprint process?

[nornagon]

@theogravity there's nothing more you need to do, this is already in our queue.

[theogravity]

@nornagon Thanks for your time with the feedback. I've updated the PR with what we've discussed.

[nornagon]

API LGTM, but needs a bit of documentation work.

[nornagon]

(JFYI, our process requires 2 members of @electron/wg-api to approve API changes, so we need one more review for this.)

[codebytere]

API LGTM

[zcbenz]

API LGTM

[welcome]

Congrats on merging your first pull request! 🎉🎉🎉

[release-clerk]

Release Notes Persisted

Added the enableLocalEcho flag to the session handler ses.setDisplayMediaRequestHandler() callback for allowing remote audio input to be echoed in the local output stream when audio is a WebFrameMain.

[theogravity]

@nornagon Could this be part of the 23 or 24 release, or is it too late for that train?

[VerteDinde]

/trop run backport-to 24-x-y

[trop]

The backport process for this PR has been manually initiated - sending your PR to 24-x-y!

[VerteDinde]

/trop run backport-to 23-x-y

[trop]

I have automatically backported this PR to "24-x-y", please check out #37528

[trop]

The backport process for this PR has been manually initiated - sending your PR to 23-x-y!

[trop]

I have automatically backported this PR to "23-x-y", please check out #37529