get_status
Check Dorico's current application state—active mode, note input, selection, and undo availability—to verify whether a command took effect without sending additional commands.
Instructions
Return Dorico's current pushed application status snapshot.
The state of the application rather than of the music: which mode is active,
whether note input is running, whether anything is selected, whether an undo is
available.
Returns:
Result dictionary carrying the merged status snapshot.
Note:
Dorico pushes status as deltas and this is the accumulated snapshot of them,
so it costs nothing to read and needs no command to be sent.
This is also how to check whether a command that answered kOK actually took
effect, since kOK only says the UI queue accepted it (docs/protocol.md,
'Command Acceptance vs Effect'). For the properties of the selected notes
rather than the state of the application, use read_selection.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||