Configure a sequence's playback settings
gma3_configure_sequenceConfigure a grandMA3 sequence's playback settings, lock, and tempo links, with preview and read-back verification; batch multiple sequences and see shared executor references.
Instructions
Set a sequence's playback settings by writing its properties: wrap_around (a chase loops only with Wrap Around on and a trigger on its first cue), priority, restart_mode, release_first_cue, auto_start, auto_stop, master_go_mode, auto_fix, auto_stomp, tracking, soft_ltp, off_when_overridden, kill_protect, swap_protect (protection from the Kill/Swap playback actions, not from editing), use_executor_time, include_link_last_go, xfade_mode, xfade_reload. lock: true/false sets the sequence's own Lock. Tempo links (SB-06): rate_master (a speed master 1-16 or "none": the cue timing (fades, delays, trigger times) runs at its effective BPM / 60, so 60 BPM is 1:1), speed_master (the phasers in the cues follow it), rate_scale and speed_scale (One, Mul2..Mul256, Div2..Div256), speed_from_rate. Masters are linked by name; a master without a unique name is refused. While a rate master is linked, moving the sequence's rate fader moves the shared master. Settings belong to the sequence, so they apply to EVERY executor that references it: the tool scans all pages and lists them (references) and warns when other executors share the sequence. Cue triggers and timing are set with gma3_set_cue_trigger / gma3_set_cue_timing. Never sends Go, On, Off, Toggle, Flash or any other playback keyword and does not touch the selection, the programmer or fader levels; playback state is read before and after (playback.activeBefore/activeAfter) and configuration alone does not start playback. A locked target is refused before anything is sent (the console silently ignores writes to it) unless unlock: true, which unlocks the owning object, applies the changes and locks it again (relocking is attempted even after a failed change). preview: true performs only the reads and returns the planned changes (from -> to); values already set are reported as unchanged and never sent. Each value is written with one 'set' request whose reply must read back the requested value, because the console silently keeps the previous value for anything it does not accept; the first failure stops the remaining changes. A value that could not be read is unknown, never a default: the call is refused when a value the plan depends on (requested property, Lock, page Lock) is missing, and a set reply without a value is an unknown step. verify (default true) reads every changed property and the lock back. Mutations from this server are serialised, but not isolated from other operators or clients. Batch form (sequences): the same settings on a list of sequences and ranges ("1 Thru 17"), each configured, checked and read back on its own; the result has one line per sequence (detail: true for every step).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lock | No | Final state of the sequence's Lock; lock: false on a locked sequence removes the lock (explicit unlock). | |
| detail | No | Return every item's full result with its steps (default false: one line per item). | |
| unlock | No | Allow unlocking a locked sequence for this call; the lock is restored afterwards (default false: refuse). | |
| verify | No | Read the changed settings back and compare (default true). | |
| preview | No | Only read and report the planned changes and sharing executors (default false). | |
| auto_fix | No | AutoFix (Yes/No). | |
| priority | No | Priority: super, swap, htp, highest, high, ltp, low, lowest. | |
| sequence | No | Sequence number (must exist). Required unless sequences is given. | |
| soft_ltp | No | SoftLTP (Yes/No). | |
| tracking | No | Tracking (Yes/No). | |
| auto_stop | No | AutoStop (Yes/No). | |
| data_pool | No | Data pool number (DataPool n). Default: the current data pool, as without this parameter. | |
| sequences | No | Batch form: the same settings on several sequences: numbers and "a Thru b" ranges, e.g. [1, "3 Thru 17", 20]; each sequence is configured and read back on its own. | |
| auto_start | No | AutoStart (Yes/No). | |
| auto_stomp | No | AutoStomp (Yes/No). | |
| rate_scale | No | RateScale: div256, div128, div64, div32, div16, div8, div4, div2, one, mul2, mul4, mul8, mul16, mul32, mul64, mul128, mul256. | |
| xfade_mode | No | XFadeMode: ab, split. | |
| rate_master | No | RateMaster: a speed master 1-16 or "none". | |
| speed_scale | No | SpeedScale: div256, div128, div64, div32, div16, div8, div4, div2, one, mul2, mul4, mul8, mul16, mul32, mul64, mul128, mul256. | |
| wrap_around | No | WrapAround (Yes/No). | |
| kill_protect | No | KillProtect (Yes/No). | |
| restart_mode | No | RestartMode: first_cue, current_cue, next_cue. | |
| speed_master | No | SpeedMaster: a speed master 1-16 or "none". | |
| swap_protect | No | SwapProtect (Yes/No). | |
| xfade_reload | No | XFadeReload (Yes/No). | |
| master_go_mode | No | MasterGoMode: none, go, on, top. | |
| speed_from_rate | No | SpeedFromRate (Yes/No). | |
| stop_on_failure | No | Batch form: stop at the first item that does not succeed (default false: independent items go on; an item on an object an earlier item failed on is skipped either way). | |
| release_first_cue | No | ReleaseFirstCue (Yes/No). | |
| use_executor_time | No | UseExecutorTime (Yes/No). | |
| off_when_overridden | No | OffWhenOverridden (Yes/No). | |
| include_link_last_go | No | IncludeLinkLastGo (Yes/No). |