transpose
Shift selected notes up or down by semitone, diatonic step, or octave, directly altering their pitches in the score.
Instructions
Transpose currently selected notes up or down in the score.
Directly modifies the score by altering the pitches of the current selection
in place. Relative and repeatable: calling it twice moves the selection twice
as far, with no absolute target pitch.
Returns:
Result dictionary with the command outcome and the catalog row
registry_status.
Note:
When to use: Shift existing selected notes by semitone, diatonic step,
or octave intervals.
When NOT to use: Do not use to enter new music (use write_score or
add_notes). Do not use to change key signatures (use set_key_signature).
Operates strictly on the active selection (reads are selection-only). If
nothing is selected, Dorico ignores the command and no notes are modified;
make a selection first or place the caret via goto_bar.
Parameters: direction sets shift orientation ('up'/'down'). chromatic
shifts by exact semitone when True or diatonically when False. octave=True
overrides chromatic and shifts by a full octave.
Maps to NoteEdit.Pitch{Up,Down}[Chromatic|Octave]. Read registry_status in
the returned result and verify the change in the score or via playback.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| octave | No | True shifts by a full octave (12 semitones or 8 diatonic steps) and overrides chromatic, which is then ignored. | |
| chromatic | No | True steps by an exact chromatic semitone. False steps diatonically within the current key signature, so the interval varies by scale degree. | |
| direction | Yes | Which way to shift pitch: 'up' moves higher, 'down' moves lower. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||