Skip to main content

Prepare a CSV File

Examples

Required columns

NumberTypeName
12startCue 12 GO

Global Properties (All Cue Types)

These columns work with any cue type:

Notes

Anything you would like to go in the "Notes" area of the cue.

Follow

Continue mode for the cue:

  • 0 - No Follow
  • 1 - Auto-Continue
  • 2 - Auto-Follow
tip

0, 1, 2 are the only options and the data must be a single number.

Color

The color of the cue. Available colors: none, berry, blue, crimson, cyan, forest, gray, green, hot pink, indigo, lavender, magenta, midnight, olive, orange, peach, plum, purple, red, sky blue, yellow.

See QLab's Color Options for details.

Target

The cue's target. The cue being targeted must be above the cue being created.

File Target

The location of assets for QLab to retrieve.

Available types:

  • Full paths, e.g. /Volumes/MyDisk/path/to/some/file.wav
  • Paths beginning with a tilde, e.g. ~/path/to some/file.mov
  • Relative paths, e.g. this/is/a/relative/path.mid
  • Paths beginning with a tilde (~) will be expanded; the tilde signifies "relative to the user's home directory".

Armed

Set the armed state: true or false

Flagged

Flag a cue: true or false

Auto Load

Enable auto-load: true or false

Duration

Cue duration in seconds

Pre Wait

Pre-wait time in seconds

Post Wait

Post-wait time in seconds


Cue types with additional options

Group Cues

Group Mode

info

Pre-Release - "Group Mode" is only available when run from source code.

NumberTypeNameGroup ModeNotes
G1groupGroup Cue 13This would create a timeline group cue
G2groupGroup Cue 26This would create a playlist group

Options:

  • 0 - List
  • 1 - Start first and enter
  • 2 - Start first
  • 3 - Timeline
  • 4 - Start random
  • 6 - Playlist
tip

This is not a typo, "6" is for Playlist type.


Text Cues

Text

NumberTypeNameText
T1textText Cue 1this text will be added to the text cue

The text to enter into the text cue.


Fade Cues

NumberTypeNameStop Target When DoneFade OpacityFade And Stop OthersFade And Stop Others TimeTarget
V1videoVideo Cue 1
F1fadeFade Cue 1false012.5V1
F2fadeFade Cue 2true131.0V1

Stop Target When Done

Stop the target cue when the fade completes: true or false

Fade Opacity

Fade opacity value (0-1, where 0 is transparent and 1 is opaque)

Auto-Enable

Setting Fade Opacity automatically enables the "Do Opacity" checkbox

Fade And Stop Others

Fade and stop mode:

  • 0 - None
  • 1 - Peers (cues at same level)
  • 2 - List or cart
  • 3 - All

Fade And Stop Others Time

Time in seconds for the fade and stop action (decimal values allowed)

Do Fade / Do Volume

Enable fading for general properties or volume: true or false


Audio Cues

NumberTypeNameLevelRatePitchInfinite LoopPlay CountStart TimeEnd TimePatch
A1audioMusic Cue-6.51.0truefalse10120.51

Level

Audio level/volume in dB (typically -60 to 12)

Rate

Playback rate (0.03 to 33.0, where 1.0 is normal speed)

Pitch

Preserve pitch when rate changes: true or false

Infinite Loop

Enable infinite looping: true or false

Play Count

Number of times to play (integer)

Start Time / End Time

Start and end time in seconds (decimal values allowed)

Patch

Audio patch number (1-16)

Gang

Level gang/group name for linked volume control


Video Cues

NumberTypeNameLevelRateStage NumberInfinite LoopPlay CountStart TimeEnd TimePatch
V1videoVideo Cue-6.51.01false10120.51

Stage Number

The stage number in order of the list in the "video outputs" setting

tip

Stages are in QLab 5 only.

Level

Video audio level/volume in dB

Rate

Playback rate (0.03 to 33.0)

Infinite Loop

Enable infinite looping: true or false

Play Count

Number of times to play

Start Time / End Time

Start and end time in seconds

Patch

Video patch number (1-16)


MIDI Cues

NumberTypeNameMIDI Message TypeMIDI Q NumberMIDI Q ListMIDI Device IDMIDI Patch NumberMIDI Control NumberMIDI Control ValueMIDI Raw String
M1midiMIDI Voice Cue 111210
M2midiMIDI MSC Cue 2212131
M3midiMIDI SysEx Cue 331F5 02

MIDI Message Type

  • 1 - MIDI Voice Message ("Musical MIDI")
  • 2 - MIDI Show Control Message (MSC)
  • 3 - MIDI SysEx Message

MIDI Q Number

The number of the cue. Specific to MSC cue types.

MIDI Q List

The Cue List for the MSC cue.

MIDI Device ID

The Device ID of the MSC Cue

MIDI Control Number

MIDI Control Value

MIDI Patch Name

The Name of the MIDI Patch

MIDI Patch Number

The patch of the MIDI cue in order by the workspace settings. Index 1 means the first patch in the patch list in Workspace Settings.

MIDI Raw String

info

Pre-Release - "MIDI Raw String" is currently only available when run from source code.

For Midi SysEx Messages

MIDI Command Format

Reference QLab Docs

MIDI Command

Reference QLab Docs


Network Cues

The way network cues work is slightly different in QLab 4 vs QLab 5

QLab 5

Network Patch Number

The number of the network patch. Based on the list in the workspace settings. 1 is at the top, etc...

Network Patch Name

The Name of the network patch.

Custom String

The best way to facilitate the vast amount of commands available in QLab 5 was to use custom string. You should be able to craft desired strings easily using common spreadsheet formulas and tools.


QLab 4

note

There are no plans to remove these features, but we will post here on this site if/when support for QLab 4 ends.

Message Type

Reference QLab Docs

OSC Cue Number

Only if using QLab Message Type

Command

For QLab Messages, review the QLab Docs

For OSC Messages, you may now include a raw string in the column.


See Complete Reference

For a comprehensive list of all available columns and cue types, see the CSV Column Reference.