delete_clip
Delete a Session clip along with its notes and envelopes. Confirm to execute; without confirmation, previews what would be removed.
Instructions
Delete the clip in a Session slot, its notes and envelopes with it.
Requires confirm=True. With confirm=False it reports the clip name, length and
note count that the call would remove, and changes nothing.
Returns:
Dictionary reporting the deletion, or the loss report when unconfirmed.
Note:
This empties one Session slot. Slot indices do not shift, so nothing else
moves and no other index goes stale.
Emptying a clip is not the same as deleting it: write_clip_notes with an
empty list and mode='replace' leaves the clip in place with its length,
loop and envelopes intact. Prefer that where the slot should stay filled.
A clip already copied into the Arrangement by arrange is a separate clip and
survives this.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | LOM path to a Session clip, song.tracks[N].clip_slots[M] with or without a trailing .clip, as an alternative to track and slot. A song.tracks[N].arrangement_clips[i] path is refused with code region_not_addressable. | |
| slot | No | Clip slot index in track.clip_slots, counted from 0, which is the scene the clip sits in. Give track and slot, or give path instead. These are Session coordinates; an Arrangement clip has none. | |
| track | No | Session track index in song.tracks, counted from 0. Give track and slot, or give path instead. These are Session coordinates; an Arrangement clip has none. | |
| 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
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||