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§
- Pending
Export View - Mirror of
screen_app::recording::PendingExportView(M-SAVE.1). A finished recording sitting in scratch awaiting the user’s format choice. Present inRecordingSummaryView::pending_exportafterstop_recordingand returned byrecording_pending_export. - Recording
Config View - Mirror of
screen_app::recording::RecordingConfig. Sent tostart_recording. - Recording
Status View Ipc - Mirror of
screen_app::recording::RecordingStatusView. Returned byrecording_statusand pushed as therecording-statusevent every 500 ms while a session is active. - Recording
Summary View - Mirror of
screen_app::recording::RecordingSummary. Returned bystop_recording. - Session
Streams View - Mirror of
screen_app::recording::SessionStreams. Per-channel flags chosen at session-start time. - Stream
Health View - 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.
formatis a slug ("mp4-h264"/"webm-vp9");output_diroverrides the configured folder whenSome. 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 theRwSignalstays at its defaultfalse. - 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).
Nonewhen 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>.