Cuelists

A cuelist is an ordered sequence of cues together with individual cue timing, crossfades, looping, and more behaviour.

Cuelist fields

Field	Type	Meaning	Notes
ms_flash_attack	Integer or null	Flash-button attack time in milliseconds.
autoreset	Boolean	Resets the cuelist after it reaches its configured end behavior.
at_end_pause	Boolean	Pauses when the end of the cuelist is reached.	Different from at_end_stop
loops	Integer	Number of chase or cuelist repetitions.	Value of 0 is used to indicated unlimited loops.
chase	Boolean	Enables chase-style playback.	When false, timing comes from each cuelist element.
ms_chase_time	Integer	Common chase interval in milliseconds. Used when chase mode is active.
visual_id	Integer	Position or number shown for the cuelist in the interface.
bpm_chase	Integer or null	Chase rate in LightShark's scaled BPM representation.	Enables up to 0.001 precision (scaled by 1000)
ms_flash_decay	Integer or null	Flash-button decay time in milliseconds.
pcrossfade	Integer	Crossfade percentage in fixed-point form.	Enables up to 0.001% precision (scaled by 1000)
ms_fadeout	Integer or null	Cuelist-level fade-out time.	Primarily relevant to chase timing.
direction	Integer	Chase direction enum.	Expected choices include forward, backward, random, and pong, but numeric mappings are undocumented.
at_end_stop	Boolean	Stops playback when the end of the cuelist is reached.
flash_mode	Integer	Selects the behavior of the flash control.	Enum values are currently undocumented.
cuelist_id	Integer	Stable identifier used by playbacks and other references.
ms_fadein	Integer or null	Cuelist-level fade-in time.	Primarily relevant to chase timing.
ms_crossfade	Integer or null	Cuelist-level crossfade time.	Primarily relevant to chase timing.
no_first_fade	Boolean	Skips the initial fade when the first cue starts.
name	String	Display name of the cuelist.
block_fx	Boolean	Prevents or suppresses FX during cuelist playback.	Exact scope requires behavioral verification.
cuelist_elements	Array of maps	Ordered cue references and their individual timing settings.	See Cuelist element fields.
ms_flash_hold	Integer or null	Flash-button hold time in milliseconds.
ms_stop_time	Integer or null	Time used when stopping the cuelist.

Cuelist element fields

Field	Type	Meaning	Notes
ms_fadeout	Integer or null	Fade-out time for this cue's transition.
cue_id	Integer	References a cue's cue_id.
ms_delay	Integer or null	Delay before this element executes.
next	Integer	Indicates next cue to be played after this cue, if specified	xFF is the default value, indicating "Next" behaviour/no specific next cue
dotted_id	Integer	Operator-facing cue number with punctuation removed.	For example, displayed cue 2.10 can be stored as 210. This is the same as the cue's visual_id.
ms_fadein	Integer or null	Fade-in time for this cue's transition.
ms_crossfade	Integer or null	Crossfade time for this cue's transition.
ms_duration	Integer or null	Duration of the cue
halt	Boolean	Prevents automatic advancement after this element.