rename_player
Rename a Dorico player by ID and return command completion status; it switches to Setup mode automatically because renaming is refused in Write mode.
Instructions
Rename a player by id.
Returns:
Result dictionary with the command and whether Dorico finished it.
Note:
Refused in Write mode, so this switches to Setup mode and back (Dorico
Elements 6.2.40). No query lists players; their ids come from a saved project
through read_playback_setup. Deleting a player by id is not possible: Dorico's
command acts on the selection in Setup mode.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"player": "<player>",
"name": "<name>"
},
"name": "rename_player"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The new name. | |
| player | Yes | Player id, see read_playback_setup. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||