Live: disconnect
live_disconnectDisconnect an active live editing session in Inkscape, functioning as a kill switch. Idempotent operation with no side effects on document content.
Instructions
Disconnect the current live session (the X1 disable switch). Idempotent.
When to use: ending a live session (or as a hard kill switch). To start one use live_connect;
to check state use live_status.
Key params: none. Idempotent — safe to call with no session.
Return shape: LiveSession — the now-disconnected session state.
Example: live_disconnect()
Risk class: low (tears down the transport; no document mutation).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | No | Clean human-readable status notes. | |
| enabled | Yes | Whether live mode is permitted (master gate, X1). | |
| connected | Yes | Whether a live transport is currently attached. | |
| transport | No | Active transport name, if connected. | |
| connected_at | No | UTC ISO-8601 connect timestamp. | |
| active_document | No | Identity of the live document at connect time. | |
| available_transports | No | Transports reported available on this host right now. |