set_arrangement_time
Idempotent
Set the Arrangement playhead to a specific beat to determine where playback starts, and read back the confirmed position. Accepts fractional beats for precise timing.
Instructions
Move the Arrangement playhead to a beat and read the position back.
Writes ``song.current_song_time``. This moves where playback would start. It
does not start it. Use play to begin, or play with ``from_beat`` to do both in
one call.
Returns:
Dictionary with the write confirmation and the read-back song time.
Note:
Do not sample a moving transport through lom_batch. A read that follows a
jump inside the same batch still reports the position from before the move,
and it reports it without an error (see lom_batch). One call per position.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| at_beat | Yes | Position on the Arrangement timeline in beats from the start, where beat 0 is the beginning of the song. Fractional beats are accepted, so 33.5 is the second half of bar 9 in 4/4. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||