Live: get active document
live_get_active_documentIdentify the document currently open in the connected Inkscape instance. Returns the active document's identity for read-only use.
Instructions
Identify the document open in the connected live instance (read-only).
When to use: confirming WHICH document the live GUI has open. For its full scene use
live_get_scene; for the current selection use live_get_selection.
Key params: none. Requires an established session (live_connect).
Return shape: LiveDocumentRef — the active live document's identity.
Example: live_get_active_document()
Risk class: low (read-only over an established live session).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Document title / base filename. | |
| path | No | On-disk path as reported by Inkscape. | |
| object_count | No | Object node count, if reported. |