Skip to main content

Module screen_ipc

Module screen_ipc 

Source
Expand description

JS-bridge bindings for the M-SCK.1 / .2 / .4 screen-capture commands (AUT-268 / AUT-269 / AUT-271).

Mirror of crate::camera_ipc / crate::mic_ipc / crate::system_audio_ipc for the screen video path. Each function invokes a __screen* helper in index.html which wraps window.__TAURI__.core.invoke(...).

Structsยง

DisplaySourceView
Mirror of crates/app/src/commands.rs::DisplaySourceView.
WindowSourceView
Mirror of crates/app/src/commands.rs::WindowSourceView.

Enumsยง

ScreenSourcesResult
Tagged result so the picker can render a TCC-denied error inline instead of swallowing it.

Functionsยง

js_error_string ๐Ÿ”’
list_screen_displays
Enumerate displays. Empty Vec outside Tauri.
list_screen_displays_js
__screenListScreenDisplays() โ€” Promise<DisplaySourceView[]>.
list_screen_windows
Enumerate visible windows.
list_screen_windows_js
__screenListScreenWindows() โ€” Promise<WindowSourceView[]>.
open_settings_screen_recording
Open System Settings โ†’ Privacy & Security โ†’ Screen & System Audio Recording. No-op outside Tauri.
open_settings_screen_recording_js
__screenOpenSettingsScreenRecording() โ€” opens the OS privacy pane where the user enables Screen & System Audio Recording.
request_screen_recording_permission
Trigger the platform Screen Recording permission flow. On macOS this is the call that creates the row in System Settings after a TCC reset.
request_screen_recording_permission_js
__screenRequestScreenRecordingPermission() โ€” triggers the macOS Screen & System Audio Recording TCC request.
screen_capture_frame_count
Cumulative frame counter. Returns 0 outside Tauri.
screen_capture_frame_count_js
__screenScreenCaptureFrameCount() โ€” Promise<number>.
screen_capture_status
true when a screen-capture session is active.
screen_capture_status_js
__screenScreenCaptureStatus() โ€” Promise<boolean>.
start_screen_capture
Start screen capture. source_id of None captures the primary display (M-SCK.0 default); Some("display-<id>") / Some("window-<id>") pin to a specific source (M-SCK.0.1 / AUT-291). Returns Ok(()) or Err(message).
start_screen_capture_js
__screenStartScreenCapture(sourceId?: string) โ€” Promise<void> (or string error). sourceId is "display-<id>" / "window-<id>" / null for primary display (M-SCK.0.1 / AUT-291).
stop_screen_capture
Stop screen capture.
stop_screen_capture_js
__screenStopScreenCapture() โ€” Promise<void>.