stop
Idempotent
Halt transport playback in Ableton Live, with an option to also halt every playing Session clip. Quantized timing aligns clip halts to the global launch grid for precise live control.
Instructions
Stop transport playback, and optionally every playing Session clip.
Returns:
Dictionary reporting the transport stop and, where asked for, the clip stop.
Note:
With ``quantized=True`` the clips stop on the next grid point rather than at
once, so an immediate read can still show a clip playing without anything
having gone wrong. Use play to resume playback, or set_arrangement_time(time=0)
to rewind the Arrangement timeline to the beginning.
Stopping does not restore a parameter a clip envelope was driving. The envelope
leaves the parameter at its last reached value and Live keeps no static baseline
underneath to restore.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| clips | No | True also stops every playing Session clip through song.stop_all_clips. False stops the transport only: the flag exists because that alone does not stop the Session clips. | |
| quantized | No | True lets the clip stop fall on the global launch quantisation grid, so it can lag the call by up to a bar. False stops the clips immediately. Only read when clips is true. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||