Skip to content

Groups

Groups are a collection of patched fixtures used for easier selection and programming. In addition to membership, a group stores layout and step-order information used by the LightShark interface and effects system.

Group fields

Field Type Meaning Notes
name String Display name of the group.
color_mark Unknown scalar Colour marker used to represent the group. Only an empty/default value has been observed so far.
visual_id Integer Position of the group in the Groups display.
patched_elements_ids Array of integers Patch IDs belonging to the group. Entries reference the patch id field.
grid Collection Visual placement of each group member in the group grid. Also used for ordering when group is in GRID mode. Each entry associates a patch ID with two layout values in the format of (patch_id) x92 (row) (col). Row/column is 0-indexed.
steps Collection Playback ordering or step assignment for group members when group is in STEP mode. Each entry associates a patch ID with a step value.
automatico Boolean Indicates that LightShark generated the group automatically.
group_id Integer Identifier used to refer to the group. (1-indexed)