Skip to content

docs: add caveats for Electron PipeWire implementation#48242

Merged
VerteDinde merged 1 commit intoelectron:mainfrom
byquanton:docs/pipewire-caveats
Oct 28, 2025
Merged

docs: add caveats for Electron PipeWire implementation#48242
VerteDinde merged 1 commit intoelectron:mainfrom
byquanton:docs/pipewire-caveats

Conversation

@byquanton
Copy link
Copy Markdown
Contributor

@byquanton byquanton commented Sep 2, 2025 •
edited
Loading

Description of Change

The Pipewire Capturer implementation in Electron has some Caveats, but those are only documented in the codebase.

electron/shell/browser/api/electron_api_desktop_capturer.cc

Line 253 in fed7304

// PipeWire returns a single source, so index is not relevant.

electron/shell/browser/api/electron_api_desktop_capturer.cc

Lines 285 to 286 in fed7304

// Some capturers like PipeWire support a single capturer for both screens
// and windows. Use it if possible, treating both as window capture

Checklist

Notes: none

@welcome
Copy link
Copy Markdown

welcome bot commented Sep 2, 2025

💖 Thanks for opening this pull request! 💖

Semantic PR titles

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

Commit signing

This repo enforces commit signatures for all incoming PRs.
To sign your commits, see GitHub's documentation on Telling Git about your signing key.

PR tips

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.

@electron-cation electron-cation bot added documentation 📓 semver/patch backwards-compatible bug fixes new-pr 🌱 PR opened recently labels Sep 2, 2025
@byquanton byquanton mentioned this pull request Sep 2, 2025
Merged
4 tasks
@byquanton byquanton force-pushed the docs/pipewire-caveats branch from 878c92e to 228b944 Compare September 2, 2025 16:22
@electron-cation electron-cation bot removed the new-pr 🌱 PR opened recently label Sep 3, 2025
@byquanton
Copy link
Copy Markdown
Contributor Author

byquanton commented Sep 18, 2025

What is required to get this merged?

@byquanton byquanton mentioned this pull request Sep 19, 2025
Open
3 tasks
@byquanton byquanton mentioned this pull request Oct 13, 2025
Closed
5 tasks
erickzhao
erickzhao approved these changes Oct 28, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@erickzhao erickzhao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs: lgtm

electron-docs-reviewer[bot]
electron-docs-reviewer bot approved these changes Oct 28, 2025
View reviewed changes
Copy link
Copy Markdown

@electron-docs-reviewer electron-docs-reviewer bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving on behalf of the Electron Docs Team

@VerteDinde VerteDinde force-pushed the docs/pipewire-caveats branch from 228b944 to 22e2e4f Compare October 28, 2025 19:17
@erickzhao erickzhao added the target/39-x-y PR should also be added to the "39-x-y" branch. label Oct 28, 2025
@VerteDinde VerteDinde merged commit 1d3cc9d into electron:main Oct 28, 2025
30 checks passed
@release-clerk
Copy link
Copy Markdown

release-clerk bot commented Oct 28, 2025

No Release Notes

@trop trop bot mentioned this pull request Oct 28, 2025
Merged
@trop
Copy link
Copy Markdown
Contributor

trop bot commented Oct 28, 2025

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

@trop trop bot added in-flight/39-x-y merged/39-x-y PR was merged to the "39-x-y" branch. and removed target/39-x-y PR should also be added to the "39-x-y" branch. in-flight/39-x-y labels Oct 28, 2025
TheCommieAxolotl pushed a commit to TheCommieAxolotl/electron that referenced this pull request Nov 2, 2025
@byquanton @TheCommieAxolotl
docs: add caveats for Electron PipeWire implementation (electron#48242)
b76adb2
nilayarya pushed a commit to nilayarya/electron that referenced this pull request Nov 21, 2025
@byquanton
docs: add caveats for Electron PipeWire implementation (electron#48242)
41e2a93
nilayarya added a commit to nilayarya/electron that referenced this pull request Nov 21, 2025
@nilayarya
docs: add caveats for Electron PipeWire implementation (electron#48242)
37130d8
nilayarya added a commit to nilayarya/electron that referenced this pull request Nov 21, 2025
@nilayarya
docs: add caveats for Electron PipeWire implementation (electron#48242)
49a1fe6
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@VerteDinde VerteDinde VerteDinde approved these changes

@electron-docs-reviewer electron-docs-reviewer[bot] electron-docs-reviewer[bot] approved these changes

+1 more reviewer

@erickzhao erickzhao erickzhao approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation 📓 merged/39-x-y PR was merged to the "39-x-y" branch. semver/patch backwards-compatible bug fixes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@byquanton @VerteDinde @erickzhao @jkleinsc