Store a list of cues from explicit content
gma3_store_cuesStore multiple grandMA3 sequence cues in one call from explicit looks, presets, or phasers, using create, merge, or overwrite modes with read-back verification.
Instructions
Store several cues of one sequence in one call, each from explicit content: a look (fixtures with presets, intensity, attribute values and/or a phaser) or several looks, with an optional name, timing, trigger, command and note (the cue's Note, e.g. scene metadata a plugin reads) per cue; a cue with a command needs no look (stored empty). mode create refuses (nothing sent) when any of the cues exists; merge and overwrite store into existing cues. The store creates the sequence when it does not exist; sequence_name names it: a new name another sequence has is refused before anything is sent, naming the holder (a duplicate makes lookups by name ambiguous; whether the console would store "#2" is not verified for sequences), unless on_name_taken: "allow_suffix"; in the batch form a name an earlier sequence of the call took counts as taken. fade, delay, out_fade, out_delay, trigger and time given for the call are defaults for every cue (a cue's own keys win; a cue with its own trigger takes none of the call's time); each stored cue's TrigType and TrigTime are read back against what it was given. presets {pool, from, to} (instead of cues): one cue per existing preset of the range on fixtures, named after it, with the call's timing and trigger. replace: true deletes the existing cues first (the sequence object, its settings and executor assignments stay, checked). sequence_settings (as gma3_configure_sequence) are applied after the build in the same call; a priority above ltp lists the running sequences it would switch off (Off When Overridden on), and protect_running: true turns that off on them. Built in the console's Preview environment: its own programmer and selection, so nothing is output and the operator's Normal programmer is untouched (checked before and after). Each cue starts from an empty programmer (ClearAll, sent only in Preview), its looks are applied in order (presets, then intensity, then values; a later look wins on shared fixtures), each look is checked in the programmer (preset links, values per fixture and cell), then the cue is stored. A look that did not apply stops the batch before that cue is stored; the cues already stored stay (nothing is undone or retried) and the result lists every cue with its status. A cue's stored values cannot be read back on 2.5.1; the cue's existence, name, timing, trigger, command and note are. A cue stored without a name takes the preset's name. Requires exclusive: true. The result is compact by default: outcome, verification, one line per cue (look details only for a cue that did not match), the observed cycle as its cue order and step intervals, and only the steps that did not succeed (with a count of the rest); detail: true returns every step, every look and every sample. Batch form (sequences): several sequences, each {sequence, sequence_name, mode, fixtures, cues}, each built in its own Preview session with these checks. Batch form: give the list instead of the single object's fields; the other arguments are defaults for every item (an item's own fields win). Each item gets the single form's checks and read-back, and its own outcome; items run in order, nothing is retried, an unknown outcome stops the rest, and the result has one line per item (detail: true for every step).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cues | No | 1 to 100 cues, stored in the order given. Required unless sequences or presets is given. | |
| fade | No | Cue in fade, seconds (Part 0 CueInFade). | |
| mode | No | Required (per sequence or for the whole batch). | |
| time | No | Trigger time in seconds (TrigTime). | |
| delay | No | Cue in delay, seconds. | |
| detail | No | Return every item's full result with its steps (default false: one line per item). | |
| verify | No | ||
| presets | No | One cue per existing preset of the range on fixtures, numbered from first_cue, named after the preset (instead of cues). | |
| replace | No | Delete every existing cue first, then store (mode create); the sequence and its executor assignments stay. | |
| trigger | No | go, time (needs time), follow (optional time), sound, bpm. | |
| fixtures | No | Default target for looks that do not name their own fixtures. | |
| out_fade | No | Out fade, seconds. | |
| sequence | No | Sequence number. Required unless sequences is given. | |
| data_pool | No | Data pool number (DataPool n). Default: the current data pool, as without this parameter. | |
| exclusive | No | Required (true). | |
| first_cue | No | With presets: the first cue number (default 1). | |
| out_delay | No | Out delay, seconds. | |
| sequences | No | Batch form: several sequences, each {sequence, sequence_name, mode, fixtures, cues}. | |
| on_name_taken | No | When another sequence has sequence_name: refuse (default, nothing is sent) or allow_suffix (store anyway). | |
| sequence_name | No | ||
| protect_running | No | With a priority above ltp: turn Off When Overridden off on the running sequences the override would switch off (default false: they are listed in a warning). | |
| 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). | |
| sequence_settings | No | Sequence settings applied after the build, as gma3_configure_sequence takes them (priority, off_when_overridden, wrap_around, ...). |