delete_track
Destructive
Remove an entire track, including its devices and all Session and Arrangement clips, after confirmation. Use the unconfirmed mode to preview what will be deleted before committing.
Instructions
Delete a track with everything on it. Requires confirm=True.
The widest deletion here: the devices, every Session clip and every Arrangement
clip on that track go with it. With confirm=False it reports the track name, the
devices, the filled Session slots and the Arrangement clip count the call would
remove, and changes nothing.
Returns:
Dictionary reporting the deletion, or the loss report when unconfirmed.
Note:
Deleting shifts every later track down one index, so any track index read
before this call is wrong afterwards. Re-read with get_session, and where
several tracks are going, delete from the highest index downwards so the
earlier indices stay valid.
For something narrower, delete_clip empties one slot and delete_device takes
one device out of the chain, neither of which renumbers anything.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| track | Yes | Track index in song.tracks, counted from 0. | |
| confirm | No | True carries the removal out. False changes nothing and returns a report of what the call would remove, which is how to look before committing to it. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||