playback
Start, stop, or rewind Dorico's transport to hear your composition from the playhead, selection, or flow start.
Instructions
Start, stop or rewind Dorico playback.
Transport only: no note, dynamic or layout changes as a result.
Returns:
Result dictionary reporting whether the transport command was accepted.
Note:
Playback is the one way to hear whether a write landed, since kOK proves
only that the command was accepted (docs/protocol.md, 'Command Acceptance
vs Effect'). It makes sound, which matters if a person is in the room.
Use navigate to scroll the score without playing, and goto_bar to move the
caret. Neither of those moves the playhead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | No | What the transport should do: 'play', 'stop' or 'rewind'. | play |
| location | No | Where playback starts from, read only when action is 'play': 'kPlayhead' from the playhead, 'kSelection' from what is selected, 'kStartOfFlow' from the top, 'kLastStartPosition' from wherever the last play began. | kPlayhead |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||