read_selection
Get rhythmic and notation details of your current Dorico selection, including duration, dots, articulations, accidentals, and event type. Use this to inspect selected notes before making changes elsewhere.
Instructions
Read rhythmic and notation properties of the active selection.
Reports duration, dots, articulations, accidental and event type for whatever a
person has selected in Dorico. Nothing here can change the selection, so make it
in Dorico or move the caret with goto_bar first.
Returns:
Result dictionary with has_selection, and the properties when it is true.
An empty selection answers has_selection=False rather than an error.
Note:
Pitch and bar or beat position are not exposed by Dorico's Remote API, so
they are absent here and no amount of selecting will produce them. To read
pitches, export the flow with export_musicxml and read it with read_score,
or read a saved project with read_project_info.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||