Skip to content

Create polished demo videos without editing skills. Mac/Windows/Linux

fix(linux): route X11 capture through real sources

wiiiii1239bb288b06933
diff --git a/electron/ipc/register/sourceMapping.test.ts b/electron/ipc/register/sourceMapping.test.ts
new file mode 100644
index 00000000..c5823e64
--- /dev/null
+++ b/electron/ipc/register/sourceMapping.test.ts
@@ -0,0 +1,91 @@
+import { describe, expect, it } from "vitest";
+
+import {
+ getScreenSourceIdForDisplay,
+ LINUX_PORTAL_SCREEN_SOURCE_ID,
+ shouldUseSyntheticLinuxPortalSource,
+} from "./sourceMapping";
+
+describe("getScreenSourceIdForDisplay", () => {
+ it("keeps the live Electron screen source when one is available", () => {
+ expect(
+ getScreenSourceIdForDisplay({
+ displayId: "42",
+ matchedSourceId: "screen:42:0",
+ platform: "linux",
+ }),
+ ).toBe("screen:42:0");
+ });
+
+ it("routes unmatched Linux screens through the portal sentinel", () => {
+ expect(
+ getScreenSourceIdForDisplay({
+ displayId: "42",
+ matchedSourceId: null,
+ platform: "linux",
+ }),
+ ).toBe(LINUX_PORTAL_SCREEN_SOURCE_ID);
+ });
+
+ it("keeps non-Linux unmatched screens on the explicit fallback id", () => {
+ expect(
+ getScreenSourceIdForDisplay({
+ displayId: "42",
+ matchedSourceId: undefined,
+ platform: "win32",
+ }),
+ ).toBe("screen:fallback:42");
+ });
+});
+
+describe("shouldUseSyntheticLinuxPortalSource", () => {
+ it("keeps Wayland portal capture on the synthetic source path", () => {
+ expect(
+ shouldUseSyntheticLinuxPortalSource({
+ env: { XDG_SESSION_TYPE: "wayland", WAYLAND_DISPLAY: "wayland-0" },
+ platform: "linux",
+ sourceId: LINUX_PORTAL_SCREEN_SOURCE_ID,
+ }),
+ ).toBe(true);
+ });
+
+ it("lets X11 use Electron desktopCapturer sources instead of a synthetic id", () => {
+ expect(
+ shouldUseSyntheticLinuxPortalSource({
+ env: { XDG_SESSION_TYPE: "x11", DISPLAY: ":0" },
+ platform: "linux",
+ sourceId: LINUX_PORTAL_SCREEN_SOURCE_ID,
+ }),
+ ).toBe(false);
+ });
+
+ it("defaults unknown Linux sessions with WAYLAND_DISPLAY to the synthetic path", () => {
+ expect(
+ shouldUseSyntheticLinuxPortalSource({
+ env: { WAYLAND_DISPLAY: "wayland-0" },
+ platform: "linux",
+ sourceId: null,
+ }),
+ ).toBe(true);
+ });
+
+ it("does not synthesize for concrete source ids", () => {
+ expect(
+ shouldUseSyntheticLinuxPortalSource({
+ env: { XDG_SESSION_TYPE: "wayland", WAYLAND_DISPLAY: "wayland-0" },
+ platform: "linux",
+ sourceId: "screen:42:0",
+ }),
+ ).toBe(false);
+ });
+
+ it("does not synthesize outside Linux", () => {
+ expect(
+ shouldUseSyntheticLinuxPortalSource({
+ env: { XDG_SESSION_TYPE: "wayland", WAYLAND_DISPLAY: "wayland-0" },
+ platform: "win32",
+ sourceId: LINUX_PORTAL_SCREEN_SOURCE_ID,
+ }),
+ ).toBe(false);
+ });
+});
diff --git a/electron/ipc/register/sourceMapping.ts b/electron/ipc/register/sourceMapping.ts
new file mode 100644
index 00000000..c779c380
--- /dev/null
+++ b/electron/ipc/register/sourceMapping.ts
@@ -0,0 +1,53 @@
+export const LINUX_PORTAL_SCREEN_SOURCE_ID = "screen:linux-portal";
+
+export function isLikelyLinuxWaylandSession(env: NodeJS.ProcessEnv) {
+ const sessionType = env.XDG_SESSION_TYPE?.trim().toLowerCase();
+ if (sessionType === "wayland") {
+ return true;
+ }
+ if (sessionType === "x11") {
+ return false;
+ }
+
+ return Boolean(env.WAYLAND_DISPLAY);
+}
+
+export function getScreenSourceIdForDisplay({
+ displayId,
+ matchedSourceId,
+ platform,
+}: {
+ displayId: string;
+ matchedSourceId?: string | null;
+ platform: NodeJS.Platform | string;
+}) {
+ if (matchedSourceId) {
+ return matchedSourceId;
+ }
+
+ if (platform === "linux") {
+ return LINUX_PORTAL_SCREEN_SOURCE_ID;
+ }
+
+ return `screen:fallback:${displayId}`;
+}
+
+export function shouldUseSyntheticLinuxPortalSource({
+ env,
+ platform,
+ sourceId,
+}: {
+ env: NodeJS.ProcessEnv;
+ platform: NodeJS.Platform | string;
+ sourceId?: string | null;
+}) {
+ if (platform !== "linux") {
+ return false;
+ }
+
+ if (sourceId && sourceId !== LINUX_PORTAL_SCREEN_SOURCE_ID) {
+ return false;
+ }
+
+ return isLikelyLinuxWaylandSession(env);
+}
diff --git a/electron/ipc/register/sources.ts b/electron/ipc/register/sources.ts
index 4ba6b35a..141a335f 100644
--- a/electron/ipc/register/sources.ts
+++ b/electron/ipc/register/sources.ts
@@ -1,19 +1,20 @@
import { execFile } from "node:child_process";
import { promisify } from "node:util";
import { app, BrowserWindow, desktopCapturer, ipcMain } from "electron";
+import { reassertHudOverlayMousePassthrough } from "../../windows";
import { ALLOW_RECORDLY_WINDOW_CAPTURE } from "../constants";
-import { selectedSource, setSelectedSource } from "../state";
-import type { SelectedSource } from "../types";
-import { getScreen, parseWindowId } from "../utils";
-import { getDisplayBoundsForSource, getDisplayWorkAreaForSource } from "../recording/ffmpeg";
import {
getNativeMacWindowSources,
+ resolveLinuxWindowBounds,
resolveMacWindowBounds,
resolveWindowsWindowBounds,
- resolveLinuxWindowBounds,
stopWindowBoundsCapture,
} from "../cursor/bounds";
-import { reassertHudOverlayMousePassthrough } from "../../windows";
+import { getDisplayBoundsForSource, getDisplayWorkAreaForSource } from "../recording/ffmpeg";
+import { selectedSource, setSelectedSource } from "../state";
+import type { SelectedSource } from "../types";
+import { getScreen, parseWindowId } from "../utils";
+import { getScreenSourceIdForDisplay } from "./sourceMapping";
const execFileAsync = promisify(execFile);
const SOURCE_LIST_CACHE_TTL_MS = 1200;
@@ -125,7 +126,11 @@ export function registerSourceHandlers({
: `Screen ${index + 1}`;
return {
- id: matchedSource?.id ?? `screen:fallback:${displayId}`,
+ id: getScreenSourceIdForDisplay({
+ displayId,
+ matchedSourceId: matchedSource?.id,
+ platform: process.platform,
+ }),
name: displayName,
originalName: matchedSource?.name ?? displayName,
display_id: displayId,
diff --git a/electron/main.ts b/electron/main.ts
index ed05ffeb..b403c6c5 100644
--- a/electron/main.ts
+++ b/electron/main.ts
@@ -25,6 +25,7 @@ import {
killWindowsCaptureProcess,
registerIpcHandlers,
} from "./ipc/handlers";
+import { shouldUseSyntheticLinuxPortalSource } from "./ipc/register/sourceMapping";
import { ensureMediaServer } from "./mediaServer";
import { ensurePackagedRendererServer } from "./rendererServer";
import type { UpdateToastPayload } from "./updater";
@@ -1014,12 +1015,18 @@ app.whenReady().then(async () => {
// is set we skip getSources entirely and hand back a synthetic
// source id; Chromium then opens the portal once to actually
// resolve the capture.
- // Default to the sentinel on Linux when no source has been
+ // Default to the sentinel on Linux/Wayland when no source has been
// pre-selected (e.g. fresh session where the renderer skipped the
// source picker entirely). This avoids calling getSources() which
// would itself trigger an extra portal dialog.
- const isLinuxPortalSentinel =
- process.platform === "linux" && (sourceId === "screen:linux-portal" || !sourceId);
+ // X11 does not need this synthetic path; use Electron's documented
+ // desktopCapturer source flow there so getDisplayMedia receives a
+ // real source id instead of a Wayland-only portal sentinel.
+ const isLinuxPortalSentinel = shouldUseSyntheticLinuxPortalSource({
+ env: process.env,
+ platform: process.platform,
+ sourceId,
+ });
if (isLinuxPortalSentinel) {
callback({ video: { id: "screen:0:0", name: "Entire screen" } });
return;
diff --git a/src/hooks/useScreenRecorder.test.ts b/src/hooks/useScreenRecorder.test.ts
index 509b049b..8f6d8b58 100644
--- a/src/hooks/useScreenRecorder.test.ts
+++ b/src/hooks/useScreenRecorder.test.ts
@@ -7,6 +7,7 @@ import {
normalizeBrowserMicrophoneProfile,
resolveBrowserCaptureCursorPolicy,
resolveLinuxPortalCursorPresentation,
+ shouldUseLinuxPortalCapture,
shouldUseNativeWindowsCaptureForSource,
} from "./useScreenRecorder";
@@ -207,6 +208,35 @@ describe("resolveLinuxPortalCursorPresentation", () => {
});
});
+describe("shouldUseLinuxPortalCapture", () => {
+ it("uses the portal when the selected source is the Linux sentinel", () => {
+ expect(
+ shouldUseLinuxPortalCapture({
+ browserCaptureSourceId: "screen:0:0",
+ selectedSourceId: "screen:linux-portal",
+ }),
+ ).toBe(true);
+ });
+
+ it("uses the portal when a stale screen fallback resolves to the Linux sentinel", () => {
+ expect(
+ shouldUseLinuxPortalCapture({
+ browserCaptureSourceId: "screen:linux-portal",
+ selectedSourceId: "screen:fallback:42",
+ }),
+ ).toBe(true);
+ });
+
+ it("keeps live Electron screen sources on browser getUserMedia", () => {
+ expect(
+ shouldUseLinuxPortalCapture({
+ browserCaptureSourceId: "screen:42:0",
+ selectedSourceId: "screen:42:0",
+ }),
+ ).toBe(false);
+ });
+});
+
describe("getScreenCaptureCursorSetting", () => {
it("normalizes only supported screen-capture cursor settings", () => {
expect(getScreenCaptureCursorSetting({ cursor: "motion" } as MediaTrackSettings)).toBe(
diff --git a/src/hooks/useScreenRecorder.ts b/src/hooks/useScreenRecorder.ts
index b6f34be9..2e71b2cc 100644
--- a/src/hooks/useScreenRecorder.ts
+++ b/src/hooks/useScreenRecorder.ts
@@ -128,6 +128,19 @@ type DesktopCaptureMediaDevices = {
getDisplayMedia: (constraints: unknown) => Promise<MediaStream>;
};
+export function shouldUseLinuxPortalCapture({
+ browserCaptureSourceId,
+ selectedSourceId,
+}: {
+ browserCaptureSourceId?: string;
+ selectedSourceId?: string;
+}) {
+ return (
+ selectedSourceId === LINUX_PORTAL_SOURCE.id ||
+ browserCaptureSourceId === LINUX_PORTAL_SOURCE.id
+ );
+}
+
type UseScreenRecorderReturn = {
recording: boolean;
paused: boolean;
@@ -684,7 +697,7 @@ export function useScreenRecorder(): UseScreenRecorderReturn {
// on Wayland that triggers an additional xdg-desktop-portal dialog.
// The sentinel is handled later by routing through getDisplayMedia,
// which lets the portal pick the source in a single dialog.
- if (source.id === "screen:linux-portal") {
+ if (source.id === LINUX_PORTAL_SOURCE.id) {
return source;
}
@@ -1430,7 +1443,7 @@ export function useScreenRecorder(): UseScreenRecorderReturn {
// Persist the synthetic Linux portal sentinel to main so that the
// setDisplayMediaRequestHandler can short-circuit getSources() and
// avoid triggering an extra portal dialog.
- if (!existingSource && selectedSource.id === "screen:linux-portal") {
+ if (!existingSource && selectedSource.id === LINUX_PORTAL_SOURCE.id) {
try {
await window.electronAPI.selectSource(selectedSource);
} catch (err) {
@@ -1655,7 +1668,10 @@ export function useScreenRecorder(): UseScreenRecorderReturn {
let videoTrack: MediaStreamTrack | undefined;
let systemAudioIncluded = false;
const mediaDevices = navigator.mediaDevices as DesktopCaptureMediaDevices;
- const useLinuxPortal = selectedSource.id === "screen:linux-portal";
+ const useLinuxPortal = shouldUseLinuxPortalCapture({
+ browserCaptureSourceId: browserCaptureSource.id,
+ selectedSourceId: selectedSource.id,
+ });
const browserScreenVideoConstraints = {
mandatory: {
chromeMediaSource: CHROME_MEDIA_SOURCE,