QLab 5ScriptingQLab's AppleScript Dictionary

QLab's AppleScript Dictionary

The list of commands, functions, properties, and so on that AppleScript can use to interact with an application is called that application’s dictionary. You can find QLab’s AppleScript dictionary here, or view it within the Script Editor application, which is found in /Applications/Utilities.

In Script Editor, choose Open Dictionary… from the File menu, and choose QLab from the list of applications.

AppleScript dictionaries are grouped by “suite”; all applications that use AppleScript must include the Standard Suite, and then any application-specific commands or properties are generally grouped together into another suite named after the application.

This documentation only describes the commands, classes, enumerations, and records from the QLab Suite. Items from the Standard Suite can also be used in QLab, such as the save command, which saves a specified workspace.

Readers are enthusiastically encouraged to use the navigation sidebar on this page, as AppleScript dictionaries are exceedingly verbose. Readers of the PDF version of this manual are encouraged to brace themselves accordingly.

Commands


audition go

(verb): make a workspace Audition GO.

Syntax

audition go {workspace}

Parameters

Parameter Required? Type Description
direct parameter workspace The workspace to GO.

Classes

The following classes respond to the audition go command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  audition go
end tell
tell application id "com.figure53.QLab.5"
  audition go workspace "hamlet.qlab5"
end tell

audition preview

(verb): Audition preview one or more cues. Previewing a cue starts the action of that cue, skipping pre-waits and ignoring auto-follows and auto-continues.

Syntax

  preview {cue}

Parameters

Parameter Required? Type Description
direct parameter cue The cue(s) to preview.

Classes

The following classes respond to the audition preview command:

  • any type of cue

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  audition preview cue "1"
end tell

capture timecode

(verb): Set the cue’s timecode trigger to the current incoming timecode received by its parent cue list.

Syntax

  capture timecode {cue}

Parameters

Parameter Required? Type Description
direct parameter cue The cue whose timecode trigger is to be captured.

Classes

The following classes respond to the capture timecode command:

  • any type of cue

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  capture timecode cue "1"
end tell

clear

(verb): clear the levels in the Light Dashboard.

Syntax

clear {light dashboard}

Parameters

Parameter Required? Type Description
direct parameter light dashboard The Light Dashboard you want to clear.

Classes

The following classes respond to the clear command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  set theDashboard to current light dashboard
  tell theDashboard to clear
end tell
tell application id "com.figure53.QLab.5" to tell front workspace
  set theDashboard to current light dashboard
  clear theDashboard
end tell

collapse

(verb): collapse a Group cue or cue list.

Syntax

collapse {group cue}

Parameters

Parameter Required? Type Description
direct parameter group cue The Group cue that will collapse.

Classes

The following classes respond to the collapse command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  collapse cue "1"
end tell

collateAndStart

(verb): collate and start a Light cue.

Syntax

collateAndStart {light cue}

Parameters

Parameter Required? Type Description
direct parameter light cue The Light cue that you want to collate and start.

Classes

The following classes respond to the collateAndStart command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  collateAndStart cue "1"
end tell

compile

(verb): verify and prepare the script for use.

Syntax

compile {script cue}

Parameters

Parameter Required? Type Description
direct parameter script cue The Script cue whose source you want to (re)compile.

Classes

The following classes respond to the compile command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  compile cue "1"
end tell

expand

(verb): expand a Group cue or cue list.

Syntax

expand {group cue}

Parameters

Parameter Required? Type Description
direct parameter group cue The Group cue that will expand.

Classes

The following classes respond to the expand command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  expand cue "1"
end tell

getGang

(verb): get the gang for a specified location in the cue’s matrix.

Syntax

set theResult to getGang {cue} row {row_number} column {column_number}

Result

text: the value of the gang at the specified location in the cue’s matrix.

Parameters

Parameter Required? Type Description
direct parameter cue The cue from which you want to get the gang.
column integer The column of the level matrix. Column 0 is the main and input levels column.
row integer The row of the level matrix. Row 0 is the main and output levels row.

Classes

The following classes respond to the getGang command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  set theGang to getGang 1 row 0 column 1
  display dialog "The gang for row 0, column 1 is: " & theGang
end tell

getLevel

(verb): get the level for a specified location in the cue’s matrix.

Syntax

set theResult to getLevel {cue} row {row_number} column {column_number}

Result

real number: the level in decibels of the specified location in the cue’s matrix.

Parameters

Parameter Required? Type Description
direct parameter cue The cue from which you want to get the level.
column integer The column of the level matrix. Column 0 is the main and input levels column.
row integer The row of the level matrix. Row 0 is the main and output levels row.

Classes

The following classes respond to the getLevel command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  set theLevel to getLevel 1 row 0 column 1
  display dialog "The level for row 0, column 1 is: " & theLevel
end tell

go

(verb): make a workspace GO.

Syntax

go {workspace}

Parameters

Parameter Required? Type Description
direct parameter workspace The workspace to GO.

Classes

The following classes respond to the go command:

Examples

tell application id "com.figure53.QLab.5"
  go front workspace
end tell
tell application id "com.figure53.QLab.5"
  go workspace "hamlet.qlab5"
end tell

hardStop

(verb): hardStop one or more cues or workspaces.

Syntax

hardStop {reference}

Parameters

Parameter Required? Type Description
direct parameter reference The cue(s) or workspace(s) to hardStop.

Classes

The following classes respond to the hardStop command:

Examples

tell application id "com.figure53.QLab.5"
  hardStop cue "1"
end tell
tell application id "com.figure53.QLab.5"
  hardStop front workspace
end tell

load

(verb): load one or more cues or workspaces to a given time. A negative value loads that many seconds back from the end of the cue.

Syntax

load {reference} time {real number}

Parameters

Parameter Required? Type Description
direct parameter reference The cue(s) or workspace(s) to load.
time real number Load time.

Note: Because “load” is both a noun and a verb in QLab (load vs. Load cue), you need to place the reference within parentheses; see examples below.

Classes

The following classes respond to the load command:

Examples

tell application id "com.figure53.QLab.5"
  -- load the cue whose cue number is "1"
  load (cue "1")
end tell
tell application id "com.figure53.QLab.5"
  -- load the cue whose cue number is "2" to 15 seconds
  load (cue "2") time 15
end tell
tell application id "com.figure53.QLab.5"
  -- load the cue whose cue number is "3" to 20 seconds before the end of the cue
  load (cue "3") time -20
end tell
tell application id "com.figure53.QLab.5"
  -- load the cue whose cue id is 4
  load (cue 4)
end tell
tell application id "com.figure53.QLab.5"
  -- this does not work!
  -- AppleScript thinks you're talking about a Load cue whose cue number is "5"
  load cue "5"
end tell

make

(verb): make a new cue in a workspace. The cue will be created below the currently selected cue.

Syntax

make {workspace} type {text}

Parameters

Parameter Required? Type Description
direct parameter workspace The workspace in which the cue will be made.
type text The name of the kind of cue you want to create (audio, video, camera, etc.) To create a new cue list, use “cue list”. To create a new cue cart, use “cue cart”.

Classes

The following classes respond to the make command:

Examples

tell application id "com.figure53.QLab.5"
  make front workspace type "audio"
end tell
tell application id "com.figure53.QLab.5"
  make front workspace type "cue list"
end tell
tell application id "com.figure53.QLab.5"
  make workspace "hamlet.qlab5" type "midi"
end tell

movePlayheadDown

(verb): move the playhead to the next cue.

Syntax

movePlayheadDown {specifier}

Parameters

Parameter Required? Type Description
direct parameter workspace or cue number If addressing this command to QLab in general, this refers to the workspace whose playhead will move. If addressing this command to a workspace, this refers to the cue number of a cue list. If this reference is left out, the active cue list is assumed.

Classes

The following classes respond to the movePlayheadDown command:

Examples

-- move the playhead to the next cue in the active cue list of the front workspace
tell application id "com.figure53.QLab.5" to tell front workspace
  movePlayheadDown
end tell
-- move the playhead to the next cue in the active cue list of a specific workspace
tell application id "com.figure53.QLab.5"
  movePlayheadDown workspace "hamlet.qlab5"
end tell
-- move the playhead to the next cue in a cue list numbered "101" in the front workspace
tell application id "com.figure53.QLab.5" to tell front workspace
  movePlayheadDown cue "101"
end tell
-- move the playhead to the next cue in a cue list numbered "101" in a specific workspace
tell application id "com.figure53.QLab.5" to tell cue "101" of workspace "ophelia"
  movePlayheadDown
end tell

movePlayheadDownASequence

(verb): move the playhead to the top of the next cue sequence.

Syntax

movePlayheadDownASequence {workspace}

Parameters

Parameter Required? Type Description
direct parameter workspace The workspace whose playhead will move.

Classes

The following classes respond to the movePlayheadDownASequence command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  movePlayheadDownASequence
end tell
tell application id "com.figure53.QLab.5"
  movePlayheadDownASequence workspace "hamlet.qlab5"
end tell

movePlayheadUp

(verb): move the playhead to the previous cue.

Syntax

movePlayheadUp {specifier}

Parameters

Parameter Required? Type Description
direct parameter workspace or cue number If addressing this command to QLab in general, this refers to the workspace whose playhead will move. If addressing this command to a workspace, this refers to the cue number of a cue list. If this reference is left out, the active cue list is assumed.

Classes

The following classes respond to the movePlayheadUp command:

Examples

-- move the playhead to the next cue in the active cue list of the front workspace
tell application id "com.figure53.QLab.5" to tell front workspace
  movePlayheadUp
end tell
-- move the playhead to the next cue in the active cue list of a specific workspace
tell application id "com.figure53.QLab.5"
  movePlayheadUp workspace "hamlet.qlab5"
end tell
-- move the playhead to the next cue in a cue list numbered "101" in the front workspace
tell application id "com.figure53.QLab.5" to tell front workspace
  movePlayheadUp cue "101"
end tell
-- move the playhead to the next cue in a cue list numbered "101" in a specific workspace
tell application id "com.figure53.QLab.5" to tell cue "101" of workspace "ophelia"
  movePlayheadUp
end tell

movePlayheadUpASequence

(verb): move the playhead to the top of the previous cue sequence.

Syntax

movePlayheadUpASequence {workspace}

Parameters

Parameter Required? Type Description
direct parameter workspace The workspace whose playhead will move.

Classes

The following classes respond to the movePlayheadUpASequence command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  movePlayheadUpASequence
end tell
tell application id "com.figure53.QLab.5"
  movePlayheadUpASequence workspace "hamlet.qlab5"
end tell

moveSelectionDown

(verb): select the next cue.

Syntax

moveSelectionDown {workspace}

Parameters

Parameter Required? Type Description
direct parameter workspace The workspace whose selection will change.

Classes

The following classes respond to the moveSelectionDown command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  moveSelectionDown
end tell
tell application id "com.figure53.QLab.5"
  moveSelectionDown workspace "hamlet.qlab5"
end tell

moveSelectionUp

(verb): select the previous cue.

Syntax

moveSelectionUp {workspace}

Parameters

Parameter Required? Type Description
direct parameter workspace The workspace whose selection will change.

Classes

The following classes respond to the moveSelectionUp command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  moveSelectionUp
end tell
tell application id "com.figure53.QLab.5"
  moveSelectionUp workspace "hamlet.qlab5"
end tell

newCueWithAll

(verb): create a new Light cue containing levels for all parameters of all instruments.

Syntax

newCueWithAll {light dashboard}

Parameters

Parameter Required? Type Description
direct parameter light dashboard The Light Dashboard from which you want to create a new Light cue.

Classes

The following classes respond to the newCueWithAll command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  set theDashboard to current light dashboard
  newCueWithAll theDashboard
end tell

newCueWithChanges

(verb): create a new Light cue containing levels for all manually adjusted parameters in the Light Dashboard.

Syntax

newCueWithChanges {light dashboard}

Parameters

Parameter Required? Type Description
direct parameter light dashboard The Light Dashboard from which you want to create a new Light cue.

Classes

The following classes respond to the newCueWithChanges command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  set theDashboard to current light dashboard
  newCueWithChanges theDashboard
end tell

panic

(verb): panic one or more cues or workspaces.

Syntax

  panic {reference}

Parameters

Parameter Required? Type Description
direct parameter reference The cue(s) or workspace(s) to panic.

Classes

The following classes respond to the panic command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  panic
end tell
tell application id "com.figure53.QLab.5"
  panic front workspace
end tell
tell application id "com.figure53.QLab.5" to tell front workspace
  panic cue "1"
end tell

pause

(verb): pause one or more cues or workspaces.

Syntax

  pause {reference}

Parameters

Parameter Required? Type Description
direct parameter reference The cue(s) or workspace(s) to pause.

Classes

The following classes respond to the pause command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  pause
end tell
tell application id "com.figure53.QLab.5"
  pause front workspace
end tell
tell application id "com.figure53.QLab.5" to tell front workspace
  pause cue "1"
end tell

preview

(verb): preview one or more cues. Previewing a cue starts the action of that cue, skipping pre-waits and ignoring auto-follows and auto-continues.

Syntax

  preview {cue}

Parameters

Parameter Required? Type Description
direct parameter cue The cue(s) to preview.

Classes

The following classes respond to the preview command:

  • any type of cue

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  preview cue "1"
end tell

prune

(verb): remove light commands that have no effect from a Light cue.

Syntax

  prune {light cue}

Parameters

Parameter Required? Type Description
direct parameter light cue The Light cue(s) whose command text you want to prune.

Classes

The following classes respond to the prune command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  prune cue "1"
end tell

recordAllToLatest

(verb): record all levels for all parameters of all instruments into the latest run Light cue.

Syntax

  recordAllToLatest {light dashboard}

Parameters

Parameter Required? Type Description
direct parameter light dashboard The Light Dashboard from which you want to record all to the latest cue.

Classes

The following classes respond to the recordAllToLatest command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  set theDashboard to current light dashboard
  recordAllToLatest theDashboard
end tell

recordAllToSelected

(verb): record all levels for all parameters of all instruments into the selected Light cue(s).

Syntax

  recordAllToSelected {light dashboard}

Parameters

Parameter Required? Type Description
direct parameter light dashboard The Light Dashboard from which you want to record all to the selected cue(s).

Classes

The following classes respond to the recordAllToSelected command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  set theDashboard to current light dashboard
  recordAllToSelected theDashboard
end tell

redo

(verb): redo the last undone action.

Syntax

  redo {reference}

Parameters

Parameter Required? Type Description
direct parameter reference The workspace or Light Dashboard in which you want to redo the last undone action.

Classes

The following classes respond to the redo command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  redo
end tell
tell application id "com.figure53.QLab.5" to tell front workspace
  set theDashboard to current light dashboard
  redo theDashboard
end tell

removeLightCommandsMatching

(verb): remove existing light commands in the specified cue matching the command provided.

Syntax

  removeLightCommandsMatching {cue} command {text}

Parameters

Parameter Required? Type Description
direct parameter cue The cue from which you want to remove light commands.
command text The full text of the light command you want to remove.

Classes

The following classes respond to the removeLightCommandsMatching command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  removeLightCommandsMatching cue "1" command "myLight.intensity = 100"
end tell

replaceLightCommand

(verb): replace a specified light command in the specified cue with a new light command.

Syntax

  replaceLightCommand {cue} oldCommandText {text} newCommandText {text}

Parameters

Parameter Required? Type Description
direct parameter cue The cue in which you want to replace light commands.
newCommandText text The full text of the light command that will replaced the old.
oldCommandText text The full text of the light command that will be replaced.

Classes

The following classes respond to the replaceLightCommand command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  replaceLightCommand cue "1" oldCommandText "myLight.intensity = 100" newCommandText "myLight.intensity = 80"
end tell

reset

(verb): reset one or more cues or workspaces.

Syntax

  reset {reference}

Parameters

Parameter Required? Type Description
direct parameter reference The cue(s) or workspace(s) to reset.

Classes

The following classes respond to the reset command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  reset cue "1"
end tell
tell application id "com.figure53.QLab.5" to tell front workspace
  reset
end tell
tell application id "com.figure53.QLab.5"
  reset workspace "hamlet.qlab5"
end tell

revert

(verb): revert changes in the specified Light Dashboard.

Syntax

  revert {light dashboard}

Parameters

Parameter Required? Type Description
direct parameter light dashboard The Light Dashboard in which you want to revert changes.

Classes

The following classes respond to the revert command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  set theDashboard to current light dashboard
  revert theDashboard
end tell

save

(verb): save the last undone action.

Syntax

  save {reference}

Parameters

Parameter Required? Type Description
direct parameter reference The workspace or Light Dashboard in which you want to save the last undone action.

Classes

The following classes respond to the save command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  save
end tell

setGang

(verb): set the gang for a specified location in the cue’s matrix.

Syntax

setGang {cue} row {row_number} column {column_number} gang {text}

Parameters

Parameter Required? Type Description
direct parameter cue The cue for which you want to set the gang.
column integer The column of the level matrix. Column 0 is the main and input levels column.
gang text The gang to set.
row integer The row of the level matrix. Row 0 is the main and output levels row.

Classes

The following classes respond to the setGang command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  set cue "1" row 0 column 1 gang "a"
end tell

setLevel

(verb): set the level in decibels for a specified location in the cue’s matrix.

Syntax

setLevel {cue} row {row_number} column {column_number} db {real number}

Parameters

Parameter Required? Type Description
direct parameter cue The cue for which you want to set the level.
column integer The column of the level matrix. Column 0 is the main and input levels column.
db real number The level in decibels to set.
row integer The row of the level matrix. Row 0 is the main and output levels row.

Classes

The following classes respond to the setLevel command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  setLevel cue "1" row 0 column 1 db "-6"
end tell

setLight

(verb): add a light command to the specified cue or to the Light Dashboard.

Syntax

setLight {reference} selector {text} value {real number or text}

Parameters

Parameter Required? Type Description
direct parameter reference The Light cue or Light Dashboard for which you want to add a light command.
selector text The instrument or group name for the command you want to add. Using a parameter name as well is optional.
value real number or text Optional parameter value to set.

Classes

The following classes respond to the setLight command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  setLight cue "1" selector "myLight"
end tell
tell application id "com.figure53.QLab.5" to tell front workspace
  set theDashboard to current light dashboard
  setLight theDashboard selector "myLight.red" value "50"
end tell

start

(verb): start one or more cues or workspaces.

Syntax

start {reference}

Parameters

Parameter Required? Type Description
direct parameter cue The cue(s) or workspace(s) to start. Starting a workspace unpauses all paused cues; it does not start cues which are not paused.

Classes

The following classes respond to the start command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  start
end tell
tell application id "com.figure53.QLab.5" to tell front workspace
  start cue "1"
end tell

stop

(verb): stop one or more cues or workspaces.

Syntax

stop {reference}

Parameters

Parameter Required? Type Description
direct parameter cue The cue(s) or workspace(s) to stop.

Classes

The following classes respond to the stop command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  stop
end tell
tell application id "com.figure53.QLab.5" to tell front workspace
  stop cue "1"
end tell

undo

(verb): undo the last action.

Syntax

undo {reference}

Parameters

Parameter Required? Type Description
direct parameter cue The workspace or Light Dashboard in which you want to undo the last action.

Classes

The following classes respond to the undo command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  undo
end tell
tell application id "com.figure53.QLab.5" to tell front workspace
  set theDashboard to current light dashboard
  undo theDashboard
end tell

updateLatestCue

(verb): copy all manually adjusted levels into the latest run Light cue.

Syntax

  updateLatestCue {light dashboard}

Parameters

Parameter Required? Type Description
direct parameter light dashboard The Light Dashboard from which you want to update the latest cue.

Classes

The following classes respond to the updateLatestCue command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  set theDashboard to current light dashboard
  updateLatestCue theDashboard
end tell

updateOriginatingCues

(verb): copy all manually adjusted levels into their originating Light cue(s).

Syntax

  updateOriginatingCues {light dashboard}

Parameters

Parameter Required? Type Description
direct parameter light dashboard The Light Dashboard from which you want to update the originating cue(s).

Classes

The following classes respond to the updateOriginatingCues command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  set theDashboard to current light dashboard
  updateOriginatingCues theDashboard
end tell

updateSelectedCues

(verb): copy all manually adjusted levels into the selected Light cue(s).

Syntax

  updateSelectedCues {light dashboard}

Parameters

Parameter Required? Type Description
direct parameter light dashboard The Light Dashboard from which you want to update the selected cue(s).

Classes

The following classes respond to the updateSelectedCues command:

Examples

tell application id "com.figure53.QLab.5" to tell front workspace
  set theDashboard to current light dashboard
  updateSelectedCues theDashboard
end tell

Classes


application

(noun): the top-level scripting object of QLab.

Properties

Property Access Type Description
frontmost get boolean Is this the frontmost (active) application?
name get text The name of the application.
overrides get override controller Application-wide communication overrides.
preferences get preferences controller Application-wide preferences and settings.
version get text The version of the application.

Elements

Element Access Key Forms Description
document get by name, by index, by range, relative to others, by whose/where, by unique ID
window get by name, by index, by range, relative to others, by whose/where, by unique ID
workspace get by name, by index, by range, relative to others, by whose/where, by unique ID

Commands

The application class responds to the following commands:

Command Description
open Open QLab.
print This command has no effect in QLab.
quit Quit QLab.

audio cue

(noun), pl. audio cues

Properties

In addition to the properties listed here, audio cue inherits properties from cue.

Property Access Type Description
audio input channels get integer The number of audio input channels for this cue (i.e. the number of distinct channels in the target audio file.)
audio output patch name get/set text The name of this cue’s audio output patch. none means “unpatched.”
audio output patch number get/set integer The 1-indexed number of this cue’s audio output patch. 0 means “unpatched.”
audio output patch id get/set text The unique ID of this cue’s audio output patch. Empty string or none means “unpatched.”
end time get/set real number Time in the target file where playback ends.
infinite loop get/set boolean Does this cue loop infinitely?
integrated fade get/set enabled or disabled State of the integrated fade checkbox.
last slice infinite loop get/set boolean Does the last slice of this cue loop infinitely?
last slice play count get/set integer Number of times the last slice of this cue plays. Always >= 1.
lock fade to cue get/set enabled or disabled State of the lock fade to start/end checkbox.
patch get/set integer The 1-indexed number of this cue’s audio output patch. Deprecated in QLab 5.0 - use audio output patch number instead.
play count get/set boolean Number of times this cue plays. Always >= 1.
preserve pitch get/set enabled disabled State of the preserve pitch checkbox.
rate get/set real number Playback rate of this cue.
slice markers get/set list of slice marker record List of slice markers in this cue.
start time get/set real number Time in the target file where playback begins.

Elements

Element Access Key Forms Description
cue get/make/delete by name, by index, by uniqueID

Commands

The audio cue class responds to the following commands:

Command Description
getGang Get the gang for a specified location in the cue’s matrix.
getLevel Get the level for a specified location in the cue’s matrix.
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.
panic Panic one or more cues or workspaces.
pause Pause one or more cues or workspaces.
preview Preview one or more cues.
reset Reset one or more cues or workspaces.
setGang Set the gang for a specified location in the cue’s matrix.
setLevel Set the level for a specified location in the cue’s matrix.
start Start one or more cues or workspaces.
stop Stop one or more cues or workspaces.

Superclass

The audio cue class inherits elements and properties from the cue class.


camera cue

(noun), pl. camera cues

Properties

In addition to the properties listed here, camera cue inherits properties from cue.

Property Access Type Description
audio input channels get integer The number of audio input channels for this cue (i.e. the number of distinct channels in the target audio file.)
audio input patch name get/set text The name of this cue’s audio input patch. none means “unpatched.”
audio input patch number get/set integer The 1-indexed number of this cue’s audio input patch. 0 equals “unpatched.”
audio input patch id get/set text The unique ID of this cue’s audio input patch. Empty string or none equals “unpatched.”
audio output patch name get/set text The name of this cue’s audio output patch. none means “unpatched.”
audio output patch number get/set integer The 1-indexed number of this cue’s audio output patch. 0 means “unpatched.”
audio output patch id get/set text The unique ID of this cue’s audio output patch. Empty string or none means “unpatched.”
blend mode get/set text Display name of the video blend mode.
camera patch get/set integer The 1-indexed number of this cue’s camera patch. Deprecated in QLab 5.0 - use video input patch number instead.
do video effect get/set boolean Apply a video effect?
full screen get/set boolean Is the cue displaying in full-stage mode?
full surface get/set boolean Is the cue displaying in full-stage mode?
layer get/set integer The display layer of this cue. 0 is the bottom layer; 1000 is the top layer.
opacity get/set real number The opacity of this cue. 0 = 0%; 0.5 = 50%; 1 = 100%
anchor x get/set real number Anchor along the x axis.
anchor y get/set real number Anchor along the y axis.
scale x get/set real number The X-axis scale of this cue.
scale y get/set real number The Y-axis scale of this cue.
smooth get/set Should the cue be scaled using smoothing interpolation?
translation x get/set real number The X-axis translation (position) of this cue.
translation y get/set real number The Y-axis translation (position) of this cue.
video input patch name get/set text The name of this cue’s video input patch. none means “unpatched.”
video input patch number get/set integer The 1-indexed number of this cue’s video input patch. 0 means “unpatched.”
video input patch id get/set text The unique ID of this cue’s video input patch. Empty string or none means “unpatched.”

Elements

Element Access Key Forms Description
cue get/make/delete by name, by index, by uniqueID

Commands

The camera cue class responds to the following commands:

Command Description
getGang Get the gang for a specified location in the cue’s matrix.
getLevel Get the level for a specified location in the cue’s matrix.
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.
panic Panic one or more cues or workspaces.
pause Pause one or more cues or workspaces.
preview Preview one or more cues.
reset Reset one or more cues or workspaces.
setGang Set the gang for a specified location in the cue’s matrix.
setLevel Set the level for a specified location in the cue’s matrix.
start Start one or more cues or workspaces.
stop Stop one or more cues or workspaces.

Superclass

The camera cue class inherits elements and properties from the cue class.


cue

(noun), pl. cues

Properties

All cues have properties from this list, but not every type of cue has every property. For example, only cue type which accept a file target (Audio, Video, and MIDI file) have the file target property.

Property Access Type Description
action elapsed get real number The time in seconds that have elapsed in the action of this cue.
armed get/set boolean Is this cue armed?
autoload get/set boolean Does this cue auto-load?
broken get boolean Is this cue broken?
cart position get row column record The row and column numbers for the position of this cue within a cart. A cue that is not contained within a cart will return row and column 0.
color condition get/set color conditions The condition under which this cue will display its assigned color.
continue mode get/set contine modes The continue mode of this cue.
cue target get/set cue The cue this cue targets, if any.
duck level get/set real number The “duck or boost others” audio level. Accepts a range of -120 to 12.
duck others get/set enabled or disabled The “duck or boost others” setting of this cue.
duck time get/set real number The “duck or boost others” fade time.
current duration get real number The current duration of this cue’s action in seconds. This property reflects the temporary duration, if it has been set. Otherwise, it returns this cue’s duration.
duration get real number The duration of this cue’s action in seconds. Not
fade and stop others get/set integer The “fade and stop others” setting of the cue:
0 = disabled
1 = peers
2 = list
3 = all
fade and stop others time get/set real number The “fade and stop others” time in seconds.
file target get/set file The file this cue targets, if any.
flagged get/set boolean Is this cue flagged?
hotkey trigger get/set enabled or disabled State of the hotkey trigger checkbox.
loaded get boolean Is this cue loaded?
midi byte one get/set string Byte 1 of this cue’s MIDI trigger, if any.
midi byte one string get/set string Display string of byte 1 of this cue’s MIDI trigger, if any.
midi byte two get/set integer Byte 2 of this cue’s MIDI trigger, if any.
midi byte two string get/set string Display string of byte 2 of this cue’s MIDI trigger, if any.
midi command get/set midi commands Type of MIDI command used for this cue’s MIDI trigger, if any. NOTE: pitch bend messages cannot be used for MIDI triggers.
midi trigger get/set enabled or disabled State of the MIDI trigger checkbox.
midi trigger channel get/set integer MIDI channel used for the MIDI trigger of the cue. 0 is the workspace channel, -1 is “any channel”.
notes get/set text The notes for this cue.
parent get cue The parent cue of this cue.
parent list get cue The cue list or cue cart that contains this cue.
paused get boolean Is this cue paused?
percent action elapsed get real number The percentage of this cue’s action that has elapsed.
percent post wait elapsed get real number The percentage of this cue’s post-wait that has elapsed.
percent pre wait elapsed get real number The percentage of this cue’s pre-wait that has elapsed.
post wait get/set real number The time in seconds before this cue auto-continues, if this cue is set to auto-continue.
post wait elapsed get real number The time in seconds of this cue’s post-wait that has elapsed.
pre wait get/set real number The time in seconds that this cue’s action will delay after being started.
pre wait elapsed get real number The time in seconds of this cue’s pre-wait that has elapsed.
q color get/set text The name of this cue’s color, or “none” if no color is set.
q default name get text The name that QLab would give to this cue by default.
q display name get text The name of this cue as displayed in the standby view. Never empty.
q list name get text The name of this cue as displayed in the cue list or cart. Might be a default name.
q name get/set text The name of this cue.
q number get/set text The number of this cue. Unique if present. May be empty.
q type get text The name of this type of cue (i.e. “Audio”, “Video”, etc.)
running get boolean Is this cue running?
second trigger action get/set integer The second trigger action of the cue:
0 = do nothing
1 = panic
2 = stop
3 = hard stop
4 = hard stop and restart
5 = devamp
second trigger on release get/set enabled or disabled State of the “second trigger on release” checkbox.
temp duration get/set real number The temporary duration of this cue’s action in seconds. Not all cues support temporary durations. Setting the temporary duration does not mark the document as edited. Reset the cue to restore its original, saved duration.
timecode bits get/set integer The bits field of the timecode trigger of this cue.
timecode frames get/set integer The frames field of the timecode trigger of this cue.
timecode hours get/set integer The hours field of the timecode trigger of this cue.
timecode minutes get/set integer The minutes field of the timecode trigger of this cue.
timecode seconds get/set integer The seconds field of the timecode trigger of this cue.
timecode show as timecode get/set boolean True if the timecode trigger is shown as timecode; false if shown as real time.
timecode text get/set text Text representation of the timecode trigger.
timecode trigger get/set enabled or disabled State of the timecode trigger checkbox.
uniqueID get text The unique ID of this cue.
wall clock hours get/set integer The hours field of the wall clock trigger of this cue.
wall clock minutes get/set integer The minutes field of the wall clock trigger of this cue.
wall clock seconds get/set integer The seconds field of the wall clock trigger of this cue.
wall clock trigger get/set enabled or disabled State of the wall clock trigger checkbox.

Elements

Element Access Key Forms Description
cue get/make/delete by name, by index, by uniqueID Cues contained by this cue, if any.

Commands

The cue class responds to the following commands:

Command Description
audition preview Audition preview one or more cues. Previewing starts only the action of the cue, skipping any prewait and not continuing to other cues.
capture timecode Set the cue’s timecode trigger to the current incoming timecode received by its parent cue list.
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.
panic Panic one or more cues or workspaces.
pause Pause one or more cues or workspaces.
preview Preview one or more cues.
reset Reset one or more cues or workspaces.
start Start one or more cues or workspaces.
stop Stop one or more cues or workspaces.

Subclasses

All cue classes inherit the elements and properties of the cue class.

Where Used

The cue class is used in the following ways:


cue list

(noun), pl. cue lists

Properties

In addition to the properties listed here, cue list inherits properties from cue and from group cue.

Property Access Type Description
ltc sync channel get/set integer Audio channel supplying an LTC sync signal.
mtc sync source name get/set text Name of the MIDI device supplying an MTC sync signal.
playback position get/set cue The playback position of a cue list is the cue which is standing by and which will start at the next GO.
playhead get/set cue Synonym for playback position.
smpte format get/set smpte format The SMPTE format of the incoming timecode.
sync mode get/set mtc or ltc Which type of incoming timecode this cue list listens for.
sync to timecode get/set enabled or disabled State of the sync to timecode checkbox.

Elements

Element Access Key Forms Description
cue get/make/delete by name, by index, by uniqueID Cues contained by this cue list, if any.

Commands

The cue list class responds to the following commands:

Command Description
collapse Collapse the cue list in the sidebar.
expand Expand the cue list in the sidebar.
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.

| [movePlayheadUp] | panic | Panic one or more cues or workspaces. | | pause | Pause one or more cues or workspaces. | | preview | Preview one or more cues. | | reset | Reset one or more cues or workspaces. | | start | Start one or more cues or workspaces. | | stop | Stop one or more cues or workspaces. |

Superclass

The cue list class inherits elements and properties from the group cue class.

Where Used

The cue list class is used in the following ways:


devamp cue

(noun), pl. devamp cues

Properties

In addition to the properties listed here, devamp cue inherits properties from cue.

Property Access Type Description
start next cue when slice ends get/set boolean Start the next cue at the moment the target slice ends?
stop target when slice ends get/set boolean Stop the target at the moment the target slice ends?

Elements

Element Access Key Forms Description
cue get/make/delete by name, by index, by uniqueID

Commands

The devamp cue class responds to the following commands:

Command Description
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.
panic Panic one or more cues or workspaces.
pause Pause one or more cues or workspaces.
preview Preview one or more cues.
reset Reset one or more cues or workspaces.
start Start one or more cues or workspaces.
stop Stop one or more cues or workspaces.

Superclass

The devamp cue class inherits elements and properties from the cue class.


fade cue

(noun), pl. fade cues

Properties

In addition to the properties listed here, fade cue inherits properties from cue.

Property Access Type Description
audio fade mode get/set absolute or relative Set absolute or relative mode for fading audio levels.
fade mode get/set absolute or relative Deprecated in QLab 5.0 - use audio fade mode instead.
do opacity get/set boolean Does this cue animate opacity?
do rotation get/set boolean Does this cue animate rotation?
do scale get/set boolean Does this cue animate scale?
do translation get/set boolean Does this cue animate translation?
opacity get/set real number Video opacity to fade to. 0 = 0%; 0.5 = 50%; 1 = 100%
preserve aspect ratio get/set boolean Does this cue preserve aspect ratio?
rotation get/set real number Rotation in degrees when this cue’s rotation type is set to a single-axis mode (modes 1, 2, or 3). When rotation type is 3D orientation (mode 0), this cannot be used to set and returns 0.0 when used to get.
rotation type get/set integer 0 = 3D orientation
1 = X axis
2 = Y axis
3 = Z axis
scale x get/set real number X-axis scale to fade to.
scale y get/set real number Y-axis scale to fade to.
stop target when done get/set boolean Stop the target cue when this cue completes?
video fade mode get/set absolute or relative Set absolute or relative mode for fading video geometry.

Elements

Element Access Key Forms Description
cue get/make/delete by name, by index, by uniqueID

Commands

The fade cue class responds to the following commands:

Command Description
getGang Get the gang for a specified location in the cue’s matrix.
getLevel Get the level for a specified location in the cue’s matrix.
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.
panic Panic one or more cues or workspaces.
pause Pause one or more cues or workspaces.
preview Preview one or more cues.
reset Reset one or more cues or workspaces.
setGang Set the gang for a specified location in the cue’s matrix.
setLevel Set the level for a specified location in the cue’s matrix.
start Start one or more cues or workspaces.
stop Stop one or more cues or workspaces.

Superclass

The fade cue class inherits elements and properties from the cue class.


group cue

(noun), pl. group cues

Properties

In addition to the properties listed here, group cue inherits properties from cue.

Property Access Type Description
mode get/set group modes The playback behavior of this group.

Elements

Element Access Key Forms Description
cue get/make/delete by name, by index, by uniqueID Cues contained by this cue, if any.

Commands

The fade cue class responds to the following commands:

Command Description
collapse Collapse the cue list in the cue list.
expand Expand the cue list in the cue list.
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.
panic Panic one or more cues or workspaces.
pause Pause one or more cues or workspaces.
preview Preview one or more cues.
reset Reset one or more cues or workspaces.
start Start one or more cues or workspaces.
stop Stop one or more cues or workspaces.

Superclass

The group cue class inherits elements and properties from the cue class.

Subclasses

The cue list class inherits elements and properties from the group cue class.

Where Used

The group cue class is used in the following ways:

  • direct parameter to the collapse command.
  • direct parameter to the expand command.

light cue

(noun), pl. light cues

Properties

In addition to the properties listed here, light cue inherits properties from cue.

Property Access Type Description
always collate get/set boolean Flag for whether this cue should always collate the effects of previous light cues in the same list when it runs.
command text get/set text The light command text of this cue.
subcontroller get/set boolean Is this cue used as a subcontroller in the Light Dashboard?

Elements

Element Access Key Forms Description
cue get/make/delete by name, by index, by uniqueID

Commands

The light cue class responds to the following commands:

Command Description
collateAndsStart Collate and start the light cue.
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.
panic Panic one or more cues or workspaces.
pause Pause one or more cues or workspaces.
preview Preview one or more cues.
prune Remove light commands that have no effect from a light cue.
removeLightCommandsMatching Remove existing light commands in the specified cue matching the command provided.
replaceLightCommand Replace a specified light command in the specified cue with a new light command.
reset Reset one or more cues or workspaces.
setLight Add a light command to the specified cue.
start Start one or more cues or workspaces.
stop Stop one or more cues or workspaces.

Superclass

The light cue class inherits elements and properties from the cue class.

Where Used

The light cue class is used in the following ways:


light dashboard

(noun)

Property Access Type Description
dashboard fade time get/set real number The duration in seconds over which the next light command entered will fade from current to new level(s). Resets to 0.0 after each use.
dashboard mode get/set light dashboard view mode The view mode of the Light Dashboard.
dashboard visibility get/set boolean Is the Light Dashboard currently visible?
properties get/set record All of the Light Dashboard’s properties.

Commands

The light dashboard class responds to the following commands:

Command Description
clear Clear the levels in the light dashboard
newCueWithAll Create a new Light cue containing levels for all parameters of all instruments.
newCueWithChanges Create a new Light cue containing levels for all manually adjusted parameters in the light dashboard.
recordAllToLatest Record all levels for all parameters of all instruments into the latest run Light cue.
recordAllToSelected Record all levels for all parameters of all instruments into the selected Light cue(s).
redo Redo the last undone action.
revert Revert changes in the light dashboard.
setLight add a light command to the light dashboard.
undo Undo the last action.
updateLatestCue Copy all manually adjusted levels into the latest run Light cue.
updateOriginatingCues Copy all manually adjusted levels into their originating Light cue(s).
updateSelectedCues Copy all manually adjusted levels into the selected Light cue(s).

Where Used

The light dashboard class is used in the following ways:


load cue

(noun), pl. load cues

Properties

In addition to the properties listed here, load cue inherits properties from cue.

Property Access Type Description
load time get/set real number Load target cue to this time.

Elements

Element Access Key Forms Description
cue get/make/delete by name, by index, by uniqueID

Commands

The load cue class responds to the following commands:

Command Description
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.
panic Panic one or more cues or workspaces.
pause Pause one or more cues or workspaces.
preview Preview one or more cues.
reset Reset one or more cues or workspaces.
start Start one or more cues or workspaces.
stop Stop one or more cues or workspaces.

Superclass

The load cue class inherits elements and properties from the cue class.


mic cue

(noun), pl. mic cues

Properties

In addition to the properties listed here, mic cue inherits properties from cue.

Property Access Type Description
audio input channels get integer The number of audio input channels for this cue.
audio input patch name get/set text The name of this cue’s audio input patch. none means “unpatched.”
audio input patch number get/set integer The 1-indexed number of this cue’s audio input patch. 0 equals “unpatched.”
audio input patch id get/set text The unique ID of this cue’s audio input patch. Empty string or none equals “unpatched.”
audio output patch name get/set text The name of this cue’s audio output patch. none means “unpatched.”
audio output patch number get/set integer The 1-indexed number of this cue’s audio output patch. 0 means “unpatched.”
audio output patch id get/set text The unique ID of this cue’s audio output patch. Empty string or none equals “unpatched.”
patch get/set integer The 1-indexed number of this cue’s audio output patch. Deprecated in QLab 5.0 - use audio input patch number or audio output patch number instead.

Elements

Element Access Key Forms Description
cue get/make/delete by name, by index, by uniqueID

Commands

The mic cue class responds to the following commands:

Command Description
getGang Get the gang for a specified location in the cue’s matrix.
getLevel Get the level for a specified location in the cue’s matrix.
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.
panic Panic one or more cues or workspaces.
pause Pause one or more cues or workspaces.
preview Preview one or more cues.
reset Reset one or more cues or workspaces.
setGang Set the gang for a specified location in the cue’s matrix.
setLevel Set the level for a specified location in the cue’s matrix.
start Start one or more cues or workspaces.
stop Stop one or more cues or workspaces.

Superclass

The mic cue class inherits elements and properties from the cue class.


midi cue

(noun), pl. midi cues

Properties

In addition to the properties listed here, midi cue inherits properties from cue.

Property Access Type Description
byte combo get/set integer Value when first and second bytes of the MIDI message are interpreted as parts of one number. Used for pitch bend messages.
byte one get/set integer First byte of the MIDI Voice message.
byte two get/set integer Second byte of the MIDI Voice message.
channel get/set integer MIDI Voice channel number.
command get/set midi command MIDI Voice command.
command format get/set integer MSC command format.
command number get/set ionteger MSC command.
control number get/set integer MSC control number.
control value get/set integer MSC control value.
deviceID get/set integer MSC device ID number.
end value get/set integer The end value for a faded MIDI message.
fade get/set boolean Does the MIDI message fade?
msc frames get/set integer MSC frames parameter.
msc hours get/set integer MSC hours parameter.
macro get/set integer MSC macro parameter.
message type get/set midi type The type of MIDI message for this cue.
midi patch name get/set text The name of this cue’s MIDI patch. none means “unpatched.”
midi patch number get/set integer The 1-indexed number of this cue’s MIDI patch. 0 means “unpatched.”
midi patch id get/set text The unique ID of this cue’s MIDI patch. Empty string or none means “unpatched.”
msc minutes get/set integer MSC minutes parameter.
patch get/set integer The 1-indexed number of this cue’s MIDI patch. Deprecated in QLab 5.0 - use midi patch number instead.
msc seconds get/set integer MSC seconds parameter.
send time with set get/set boolean Send the timecode parameters with the SET command?
smpte format get/set smpte format SMPTE format of the timecode parameters.
start value get/set integer The start value for a faded MIDI message.
msc subframes get/set integer MSC subframes parameter.
sysex message get/set text The raw SysEx message. Use only hexadecimal characters and whitespace. Omit the starting F0 and the ending F7.

Elements

Element Access Key Forms Description
cue get/make/delete by name, by index, by uniqueID

Commands

The midi cue class responds to the following commands:

Command Description
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.
panic Panic one or more cues or workspaces.
pause Pause one or more cues or workspaces.
preview Preview one or more cues.
reset Reset one or more cues or workspaces.
start Start one or more cues or workspaces.
stop Stop one or more cues or workspaces.

Superclass

The midi cue class inherits elements and properties from the cue class.


midi file cue

(noun), pl. midi file cues

Properties

In addition to the properties listed here, midi file cue inherits properties from cue.

Property Access Type Description
midi patch name get/set text The name of this cue’s MIDI patch. none means “unpatched.”
midi patch number get/set integer The 1-indexed number of this cue’s MIDI patch. 0 means “unpatched.”
midi patch id get/set text The unique ID of this cue’s MIDI patch. Empty string or none means “unpatched.”
patch get/set integer The 1-indexed number of this cue’s MIDI patch. Deprecated in QLab 5.0 - use midi patch number instead.
rate get/set real number Playback rate of the MIDI file.

Elements

Element Access Key Forms Description
cue get/make/delete by name, by index, by uniqueID

Commands

The midi file cue class responds to the following commands:

Command Description
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.
panic Panic one or more cues or workspaces.
pause Pause one or more cues or workspaces.
preview Preview one or more cues.
reset Reset one or more cues or workspaces.
start Start one or more cues or workspaces.
stop Stop one or more cues or workspaces.

Superclass

The midi file cue class inherits elements and properties from the cue class.


network cue

(noun), pl. network cues

Properties

In addition to the properties listed here, network cue inherits properties from cue.

Property Access Type Description
custom message get/set text The custom OSC message, for custom type messages. Deprecated in QLab 5.0 - use parameter values instead.)
fade entries get/set list of text The list of {x,y} coordinates representing entries which define the shape (1D) or path (2D) of the current fade.
fade fps get/set integer The rate in frames per second in which fade values are sent. Must be a positive integer between 1 and 120.
fade from get/set real number The starting value for a 1D fade.
fade number type get/set integer Whether the fade sends integer (0) or float (1) values.
fade path height get/set real number The maximum Y value for the grid displayed in the inspector for a 2D fade. Must not be a negative number.
fade path width get/set real number The maximum X value for the grid displayed in the inspector for a 2D fade. Must not be a negative number.
fade to get/set real number The ending value for a 1D fade.
fade type get/set integer 0 = no fade/resend
1 = 1D fade
2 = 2D fade
Writeable only for string type parameters.
network patch name get/set text The name of this cue’s Network patch. none means “unpatched.”
network patch number get/set integer The 1-indexed number of this cue’s Network patch. 0 means “unpatched.”
network patch id get/set text The unique ID of this cue’s Network patch. Empty string or none means “unpatched.”
parameter fades enabled get/set list of boolean The list of boolean values that represent the fade-enabled states of all fade-able parameters in this Network cue.
parameter values get/set list of text, boolean, or number The list of parameter values used to configure the current command.
patch get/set integer The 1-indexed number of this cue’s Network patch. Deprecated in QLab 5.0 - use network patch number instead.
q_command get/set number The QLab OSC command for QLab-type Network cues. Deprecated in QLab 5.0 - use parameter values instead.
q_num get/set text The QLab cue number for QLab-type Network cues. Deprecated in QLab 5.0 - use parameter values instead.
q_params get/set text The QLab command parameters for QLab-type Network cues. Not all messages have parameters. Deprecated in QLab 5.0 - use parameter values instead.
udp message get/set text The raw UDP message for UDP-type Network cues. Deprecated in QLab 5.0 - use parameter values instead.

Elements

Element Access Key Forms Description
cue get/make/delete by name, by index, by uniqueID

Commands

The network cue class responds to the following commands:

Command Description
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.
panic Panic one or more cues or workspaces.
pause Pause one or more cues or workspaces.
preview Preview one or more cues.
reset Reset one or more cues or workspaces.
start Start one or more cues or workspaces.
stop Stop one or more cues or workspaces.

Superclass

The network cue class inherits elements and properties from the cue class.


override controller

(noun)

Properties

Property Access Type Description
artnet enabled get/set boolean Allow Art-net input and output (default is TRUE.)
midi input enabled get/set boolean Allow MIDI Voice input (default is TRUE.)
midi output enabled get/set boolean Allow MIDI Voice output (default is TRUE.)
msc input enabled get/set boolean Allow MSC input (default is TRUE.)
msc output enabled get/set boolean Allow MSC output (default is TRUE.)
osc input enabled get/set boolean Allow OSC input (default is TRUE.)
osc output enabled get/set boolean Allow OSC output (default is TRUE.)
overrides visibility get/set boolean Is the Overrides Controls window visible?
sysex input enabled get/set boolean Allow SysEx (other than MSC and MTC) input (default is TRUE.)
sysex output enabled get/set boolean Allow SysEx (other than MSC and MTC) output (default is TRUE.)
timecode input enabled get/set boolean Allow timecode input (default is TRUE.)
timecode output enabled get/set boolean Allow timecode output (default is TRUE.)

Where Used

The override controller class is used in the following ways:

  • overrides property of the application class.

Examples

-- override MIDI output (i.e. "don't output any MIDI")
tell application id "com.figure53.QLab.5"
  tell overrides to set midi output enabled to false
end tell
-- open the override controls window
tell application "QLab" to tell overrides to set overrides visibility to true

preferences controller

(noun)

Properties

Property Access Type Description
live fade preview get/set boolean Is live fade preview enabled?

Where Used

The preferences controller class is used in the following ways:

  • preferences property of the application class.

Example

-- turn on live fade preview
tell application id "com.figure53.QLab.5"
  tell preferences to set live fade preview to true
end tell

script cue

(noun), pl. script cues

Properties

In addition to the properties listed here, script cue inherits properties from cue.

Property Access Type Description
script source get/set text AppleScript source for the cue. The script will be recompiled when set.

Elements

Element Access Key Forms Description
cue get/make/delete by name, by index, by uniqueID

Commands

The script cue class responds to the following commands:

Command Description
compile Verify and prepare the script for use.
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.
panic Panic one or more cues or workspaces.
pause Pause one or more cues or workspaces.
preview Preview one or more cues.
reset Reset one or more cues or workspaces.
start Start one or more cues or workspaces.
stop Stop one or more cues or workspaces.

Superclass

The script cue class inherits elements and properties from the cue class.

Where Used

The script cue class is used in the following ways:

  • direct parameter to the compile command.

target cue

(noun), pl. target cues

Properties

In addition to the properties listed here, target cue inherits properties from cue.

Property Access Type Description
assigned number get/set text The cue number of the cue to assign. The cue with this number will be assigned as the new target of the cue which this cue targets.

Elements

Element Access Key Forms Description
cue get/make/delete by name, by index, by uniqueID

Commands

The target cue class responds to the following commands:

Command Description
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.
panic Panic one or more cues or workspaces.
pause Pause one or more cues or workspaces.
preview Preview one or more cues.
reset Reset one or more cues or workspaces.
start Start one or more cues or workspaces.
stop Stop one or more cues or workspaces.

Superclass

The target cue class inherits elements and properties from the cue class.


text cue

(noun), pl. text cues

Properties

In addition to the properties listed here, text cue inherits properties from cue.

Property Access Type Description
blend mode get/set text Display name of the video blend mode.
do video effect get/set boolean Apply a video effect?
fixed width get/set number Fixed width of the text cue. Setting this to 0 specifies “auto” width.
full screen get/set boolean Is the cue displaying in full-stage mode?
full surface get/set boolean Is the cue displaying in full-stage mode?
layer get/set integer The display layer of this cue. 0 is the bottom layer; 1000 is the top layer.
live text get/set text Live text of this cue. Setting this does not mark the workspace as edited.
live text alignment get/set text Text alignment of the live text of this cue. Possible values are “left”, “center”, “right”, and “justify”. Setting this does not mark the workspace as edited.
live text format get/set list of text format record The list of text formats in the live text of this cue. Setting this does not mark the workspace as edited.
live text output size get list of number A 2-item list representing the width and height of the live text of this cue.
opacity get/set real number The opacity of this cue. 0 = 0%; 0.5 = 50%; 1 = 100%
anchor x get/set real number Anchor along the x axis.
anchor y get/set real number Anchor along the y axis.
preserve aspect ratio get/set boolean Does this cue preserve aspect ratio?
scale x get/set real number The X-axis scale of this cue.
scale y get/set real number The Y-axis scale of this cue.
smooth get/set Should the cue be scaled using smoothing interpolation?
text get/set text Text of this cue.
text alignment get/set text Text alignment of this cue. Possible values are “left”, “center”, “right”, and “justify”.
text format get/set list of text format record The list of text formats in the text of this cue.
text output size get list of number A 2-item list representing the width and height of the text of this cue.
translation x get/set real number The X-axis translation (position) of this cue.
translation y get/set real number The Y-axis translation (position) of this cue.
video input patch name get/set text The name of this cue’s video input patch. none means “unpatched.”
video input patch number get/set integer The 1-indexed number of this cue’s video input patch. 0 means “unpatched.”
video input patch id get/set text The unique ID of this cue’s video input patch. Empty string or none means “unpatched.”

Elements

Element Access Key Forms Description
cue get/make/delete by name, by index, by uniqueID

Commands

The text cue class responds to the following commands:

Command Description
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.
panic Panic one or more cues or workspaces.
pause Pause one or more cues or workspaces.
preview Preview one or more cues.
reset Reset one or more cues or workspaces.
start Start one or more cues or workspaces.
stop Stop one or more cues or workspaces.

Superclass

The text cue class inherits elements and properties from the cue class.


timecode cue

(noun), pl. timecode cues

Properties

In addition to the properties listed here, timecode cue inherits properties from cue.

Property Access Type Description
audio output patch name get/set text (For cues in LTC mode.) The name of this cue’s audio output patch. none means “unpatched.”
audio output patch number get/set integer (For cues in LTC mode.) The 1-indexed number of this cue’s audio output patch. 0 means “unpatched.”
audio output patch id get/set text (For cues in LTC mode.) The unique ID of this cue’s audio output patch. Empty string or none means “unpatched.”
midi patch name get/set text (For cues in MTC mode.) The name of this cue’s MIDI patch. none means “unpatched.”
midi patch number get/set integer (For cues in MTC mode.) The 1-indexed number of this cue’s MIDI patch. 0 means “unpatched.”
midi patch id get/set text (For cues in MTC mode.) The unique ID of this cue’s MIDI patch. Empty string or none means “unpatched.”
patch get/set integer (For cues in LTC mode.) The 1-indexed number of this cue’s audio output patch. Deprecated in QLab 5.0 - use audio output patch number instead.
patch get/set integer (For cues in MTC mode.) The 1-indexed number of this cue’s MIDI patch. Deprecated in QLab 5.0 - use midi patch number instead.
smpte format get/set smpte format SMPTE format of the outgoing timecode.
start time offset get/set real number Time in seconds where the timecode clock begins counting.
type get/set mtc or ltc The type of timecode used by this cue.

Elements

Element Access Key Forms Description
cue get/make/delete by name, by index, by uniqueID

Commands

The timecode cue class responds to the following commands:

Command Description
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.
panic Panic one or more cues or workspaces.
pause Pause one or more cues or workspaces.
preview Preview one or more cues.
reset Reset one or more cues or workspaces.
start Start one or more cues or workspaces.
stop Stop one or more cues or workspaces.

Superclass

The timecode cue class inherits elements and properties from the cue class.


video cue

(noun), pl. video cues

Properties

In addition to the properties listed here, video cue inherits properties from cue.

Property Access Type Description
audio input channels get integer The number of audio input channels for this cue (i.e. the number of distinct channels in the target audio file.)
audio output patch name get/set text The name of this cue’s audio output patch. none means “unpatched.”
audio output patch number get/set integer The 1-indexed number of this cue’s audio output patch. 0 means “unpatched.”
audio output patch id get/set text The unique ID of this cue’s audio output patch. Empty string or none means “unpatched.”
blend mode get/set text Display name of the video blend mode.
clock type get/set audio or video The clock type of the cue.
do video effect get/set boolean Apply a video effect?
end time get/set real number Time in the target file where playback ends.
full screen get/set boolean Is the cue displaying in full-stage mode?
full surface get/set boolean Is the cue displaying in full-stage mode?
hold at end get/set boolean Should the final frame of the video be left visible when playback reaches the end of the file?
infinite loop get/set boolean Does this cue loop infinitely?
integrated fade get/set enabled or disabled State of the integrated fade checkbox.
last slice infinite loop get/set boolean Does the last slice of this cue loop infinitely?
last slice play count get/set integer Number of times the last slice of this cue plays. Always >= 1.
layer get/set integer The display layer of this cue. 0 is the bottom layer; 1000 is the top layer.
lock fade to cue get/set enabled or disabled State of the lock fade to start/end checkbox.
opacity get/set real number The opacity of this cue. 0 = 0%; 0.5 = 50%; 1 = 100%
anchor x get/set real number Anchor along the x axis.
anchor y get/set real number Anchor along the y axis.
patch get/set integer The 1-indexed number of this cue’s audio output patch. Deprecated in QLab 5.0 - use audio output patch number instead.
play count get/set boolean Number of times this cue plays. Always >= 1.
preserve aspect ratio get/set boolean Does this cue preserve aspect ratio?
preserve pitch get/set enabled or disabled State of the preserve pitch checkbox.
rate get/set real number Playback rate of this cue.
scale x get/set real number The X-axis scale of this cue.
scale y get/set real number The Y-axis scale of this cue.
slice markers get/set list of slice marker record List of slice markers in this cue.
smooth get/set Should the cue be scaled using smoothing interpolation?
start time get/set real number Time in the target file where playback begins.
translation x get/set real number The X-axis translation (position) of this cue.
translation y get/set real number The Y-axis translation (position) of this cue.

Elements

Element Access Key Forms Description
cue get/make/delete by name, by index, by uniqueID

Commands

The video cue class responds to the following commands:

Command Description
getGang Get the gang for a specified location in the cue’s matrix.
getLevel Get the level for a specified location in the cue’s matrix.
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.
panic Panic one or more cues or workspaces.
pause Pause one or more cues or workspaces.
preview Preview one or more cues.
reset Reset one or more cues or workspaces.
setGang Set the gang for a specified location in the cue’s matrix.
setLevel Set the level for a specified location in the cue’s matrix.
start Start one or more cues or workspaces.
stop Stop one or more cues or workspaces.

Superclass

The video cue class inherits elements and properties from the cue class.


workspace

(noun), pl. workspaces

Properties

Property Access Type Description
active cues get list of cue The list of active cues (running or paused) in this workspace.
always audition get/set boolean Is the workspace currently set to always audition?
current cue list get/set [cue list](./#cue list) The cue list that’s currently visible in the main window of the workspace.
current light dashboard get light dashboard The current Light Dashboard for the workspace.
edit mode get/set boolean Is the workspace currently in edit mode?
inspector visibility get/set boolean Is the inspector visible?
selected get/set list of cue The currently selected cue(s) in the current cue list.
show mode get/set boolean Is the workspace currently in show mode?
unique id get text The unique ID of the workspace.

Elements

Element Access Key Forms Description
cue get by name, by unique id The complete list of cues in this workspace.
cue list get/make/delete by name, by index, by unique id The list of cue lists in the workspace.

Commands

The workspace class responds to the following commands:

Command Description
audition go Make a workspace Audition GO.
go Make a workspace GO.
hardStop hardStop one or more cues or workspaces.
load Load one or more cues or workspaces to a given time.
make Create a new cue.
movePlayheadDown Move the playhead in the active cue list to the next cue.
movePlayheadDownASequence Move the playhead in the active cue list to top of the next cue sequence.
movePlayheadUp Move the playhead in the active cue list to the previous cue.
movePlayheadUpASequnce Move the playhead in the active cue list to top of the previous cue sequence.
moveSelectionDown Select the next cue.
moveSelectionUp Select the previous cue.
panic Panic one or more cues or workspaces.
pause Pause one or more cues or workspaces.
redo Redo the last undone action.
reset Reset one or more cues or workspaces.
start Start one or more cues or workspaces.
stop Stop one or more cues or workspaces.
undo Undo the last action.

Where Used

The workspace class is used in the following ways:

  • element of application class.
  • direct parameter to the make command.

Enumerations


absolute relative

Constants

Constant Description
absolute
relative

Where Used

The absolute relative enumeration is used in the following ways:

  • audio fade mode property of the fade cue class.
  • video fade mode property of the fade cue class.

color conditions

Constants

Constant Description
after_action Cue has this color after its action runs. Reset the cue to reset the color.
always Cue always has this color.

Where Used

The color conditions enumeration is used in the following ways:

  • color condition property of the cue class.

continue modes

Constants

Constant Description
auto_continue Automatically continue to the next cue after completing the post-wait.
auto_follow Automatically continue to the next cue after completing the action of the cue.
do_not_continue Do not automatically continue to the next cue.

Where Used

The continue modes enumeration is used in the following ways:

  • continue mode property of the cue class.

enabled disabled

Constants

Constant Description
disabled
enabled

Where Used

The enabled disabled enumeration is used in the following ways:

  • fade property of the midi cue class.
  • hotkey trigger property of the cue class.
  • integrated fade property of the audio cue class.
  • integrated fade property of the video cue class.
  • lock fade to cue property of the audio cue class.
  • lock fade to cue property of the video cue class.
  • midi trigger property of the cue class.
  • preserve pitch property of the audio cue class.
  • preserve pitch property of the video cue class.
  • sync to timecode property of the cue list class.
  • timecode trigger property of the cue class.
  • wall clock trigger property of the cue class.

group modes

Constants

Constant Description
cue_list The group is a cue list.
timeline Timeline - start all children simultaneously.
start_first_and_enter Start first child and enter into group.
start_first Start first child and go to next cue.
start_random Start a random child and then go to the next cue.
playlist Playlist - one cue at a time.

Where Used

The group modes enumeration is used in the following ways:


light dashboard view mode

Constants

Constant Description
sliders
tiles

Where Used

The light dashboard view mode enumeration is used in the following ways:


midi command

Constants

Constant Description
channel_pressure
control_change
key_pressure a.k.a. aftertouch
note_off
note_on
pitch_bend a.k.a. pitch wheel
program_change

Where Used

The midi command enumeration is used in the following ways:

  • command property of the midi cue class.
  • midi command property of the cue class.

midi type

Constants

Constant Description
msc MIDI Show Control message.
sysex MIDI System Exclusive message.
voice MIDI Voice message.

Where Used

The midi type enumeration is used in the following ways:

  • message type property of the midi cue class.

mtc ltc

Constants

Constant Description
ltc Linear/Longitudinal Timecode.
mtc MIDI Timecode.

Where Used

The mtc ltc enumeration is used in the following ways:

  • sync mode property of the cue list class.

smpte format

Constants

Constant Description
fps_24 24 frames per second.
fps_25 25 frames per second.
fps_30_drop 30 frames per second, drop frame.
fps_30_non_drop 30 frames per second, non-drop frame.

Where Used

The smpte format enumeration is used in the following ways:


Records


range record

A 2-item record representing the offset and length of a substring.

Properties

Property Access Type Description
rangeLength get/set integer or text The length of the substring range.
rangeOffset get/set integer or text The 1-indexed location of the starting character of a substring range.

Where Used

The range record is used in the following ways:


rgba color record

A 4-item record representing red, green, blue, and alpha percentage values of a color.

Properties

Property Access Type Description
red get/set real number
green get/set real number
blue get/set real number
alpha get/set real number

Where Used

The rgba color record record is used in the following ways:

Examples

This script will set the color of all the text in cue 2 to a nice purple-y color:

tell application id "com.figure53.QLab.5" to tell front workspace
  set aNiceColor to {rgbaColor:{red:0.5, green:0.2, blue:0.6, alpha:1}}
  set text format of cue "2" to aNiceColor
end tell

This script will set the color of the underline of all the text in cue 2 to primary blue:

tell application id "com.figure53.QLab.5" to tell front workspace
  set aNiceColor to {underlineRgbaColor:{red:0, green:0, blue:1, alpha:1}}
  set text format of cue "2" to aNiceColor
end tell

row column record

A 2-item record representing a position defined by a numeric row and column value.

Properties

Property Access Type Description
column get/set integer
row get/set integer

Where Used

The row column record is used in the following ways:

  • cart position property of the cue class.

slice marker record

A 2-item record representing the play count and end time of a slice.

Properties

Property Access Type Description
playCount get/set integer The number of times a slice will play. Play count -1 = infinite loop.
time get/set real number The end time of a slice.

Where Used

The slice marker record record is used in the following ways:

  • slice markers property of the audio cue class.
  • slice markers property of the video cue class.

text format record

A record representing the formatting aspects of a text string.

Properties

Property Access Type Description
backgroundRgbaColor get/set rgba color record An RGBA color record representing the percentage values for the red, green, blue, and alpha components of the background color of this format.
fontFamily get/set text The font family for this format. (e.g. “Helvetica”, “Courier New”)
fontName get/set text The font name for this format. (e.g. “CourierNewPS-BoldItalicMT”)
fontSize get/set real The font size for this format.
fontStyle get/set text The font style (face) for this format. (e.g. “Regular”, “Light Oblique”)
lineSpacing get/set real number The line spacing for this format.
range get/set range record A range record representing the index and length for the substring that has this format.
rgbaColor get/set rgba color record An RGBA color record representing the percentage values for the red, green, blue, and alpha components of the text color of this format.
strikethroughRgbaColor get/set rgba color record An RGBA color record representing the percentage values for the red, green, blue, and alpha components of the strikethrough color of this format.
strikethroughStyle get/set text The strikethrough style of this format. Possible values are “none”, “single”, and “double”.
underlineRgbaColor get/set rgba color record An RGBA color record representing the percentage values for the red, green, blue, and alpha components of the underline color of this format.
underlineStyle get/set text The underline style of this format. Possible values are “none”, “single”, and “double”.
wordIndex get/set integer An optional 1-indexed word number to which this format should be applied. When used, the “range” property will be ignored. (setting only)

Where Used

The text format record record is used in the following ways:

  • live text format property of the text cue class.
  • text format property of the text cue class.

Still have a question?

Our support team is always happy to help.

Business Hours
M-F 9am-7pm (ET)
Current time at our headquarters