Read a show object
gma3_get_objectRead any show-data object by reference to inspect its properties, schema, and children, so you can examine sequences, cues, fixtures, presets, groups, and other grandMA3 data.
Instructions
Read an object from the show data: name, class, address, all properties (as display text), optionally the property schema and a listing of its children. Use this to inspect sequences, cues, executors, fixtures, presets, groups, macros, pages, settings, etc. TAGS reads as a list of {tag, name, protect} (bridge 0.36.0; gma3_tags lists the tags and the objects that carry them).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ref | Yes | Object reference. Either command-line object syntax ("Sequence 1", "Sequence 1 Cue 3", "Fixture 101", "Group 5", "Macro 2", "Page 1.201"), a dotted show-data path from a root ("DataPool.Sequences", "Root.ShowData", "Patch.Fixtures"), a numeric address like "14.14.1.6.1", or one of: Root, ShowData, DataPool, SelectedSequence, CurrentCue, Patch, Programmer, Selection, CurrentExecPage. | |
| schema | No | Include property schema (name, type, readOnly, enum) | |
| children | No | Include a listing of child objects (default false) | |
| properties | No | Include property values (default true) | |
| child_limit | No | ||
| child_fields | No | Property names to include for each child | |
| child_offset | No |