Skip to main content

Module recording_ipc

Module recording_ipc 

Source
Expand description

JS-bridge bindings for the M-RECORD.1 coordinated-recording commands (start / stop / status) + the recording-status event.

Mirror of crate::screen_ipc / crate::mic_ipc / etc. The __screenStartRecording / __screenStopRecording / __screenRecordingStatus helpers in index.html wrap window.__TAURI__.core.invoke(...).

Structs§

PendingExportView
Mirror of screen_app::recording::PendingExportView (M-SAVE.1). A finished recording sitting in scratch awaiting the user’s format choice. Present in RecordingSummaryView::pending_export after stop_recording and returned by recording_pending_export.
RecordingConfigView
Mirror of screen_app::recording::RecordingConfig. Sent to start_recording.
RecordingStatusViewIpc
Mirror of screen_app::recording::RecordingStatusView. Returned by recording_status and pushed as the recording-status event every 500 ms while a session is active.
RecordingSummaryView
Mirror of screen_app::recording::RecordingSummary. Returned by stop_recording.
SessionStreamsView
Mirror of screen_app::recording::SessionStreams. Per-channel flags chosen at session-start time.
StreamHealthView
Mirror of screen_app::recording::StreamHealth.

Functions§

default_output_path
Resolve the default output path the recorder would write to if the user started recording right now with the given format. Returns empty string on IPC failure (caller treats as “use no override”).
default_output_path_js
__screenDefaultRecordingOutputPath(formatSlug?: string)Promise<string> returning the auto-generated default path (M-EXPORT.4).
discard_recording
Discard the pending recording (delete its scratch). Best-effort; errors are swallowed (M-SAVE.1).
discard_recording_js 🔒
__screenDiscardRecording()Promise<void> (M-SAVE.1).
export_recording
Export the pending recording. format is a slug ("mp4-h264" / "webm-vp9"); output_dir overrides the configured folder when Some. Returns the final absolute path on success (M-SAVE.1).
export_recording_js 🔒
__screenExportRecording(formatSlug?, outputDir?)Promise<string> (final path) or string error (M-SAVE.1).
install_recording_lock_listener
Native (non-wasm) stub of install_recording_lock_listener. Unit tests + non-browser builds get a no-op so the RwSignal stays at its default false.
install_recording_status_listener
Native (non-wasm) stub of install_recording_status_listener.
js_error_string 🔒
recording_pending_export
The recording awaiting export, if any (M-SAVE.1). None when nothing is pending or on IPC failure.
recording_pending_export_js 🔒
__screenRecordingPendingExport()Promise<PendingExportView | null> (M-SAVE.1).
recording_status
Synchronous mount-time snapshot of the recording status.
recording_status_js
__screenRecordingStatus()Promise<RecordingStatusView>.
reveal_in_file_manager
Open the OS file manager focused on path (M-EXPORT.4).
reveal_in_file_manager_js
__screenRevealRecordingInFileManager(path: string)Promise<void>. Opens the OS file manager focused on the given path (M-EXPORT.4).
start_recording
Start a coordinated recording session. Returns the session id on success.
start_recording_js
__screenStartRecording(config)Promise<u64> (session id) or string error.
stop_recording
Stop the active recording session.
stop_recording_js
__screenStopRecording()Promise<RecordingSummary>.