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.
(verb): make a workspace Audition GO.
audition go {workspace}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | workspace | The workspace to GO. |
The following classes respond to the audition go command:
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
(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.
preview {cue}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | cue | The cue(s) to preview. |
The following classes respond to the audition preview command:
tell application id "com.figure53.QLab.5" to tell front workspace
audition preview cue "1"
end tell
(verb): Set the cue’s timecode trigger to the current incoming timecode received by its parent cue list.
capture timecode {cue}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | cue | The cue whose timecode trigger is to be captured. |
The following classes respond to the capture timecode command:
tell application id "com.figure53.QLab.5" to tell front workspace
capture timecode cue "1"
end tell
(verb): clear the levels in the Light Dashboard.
clear {light dashboard}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | light dashboard | The Light Dashboard you want to clear. |
The following classes respond to the clear command:
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
(verb): collapse a Group cue or cue list.
collapse {group cue}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | group cue | The Group cue that will collapse. |
The following classes respond to the collapse command:
tell application id "com.figure53.QLab.5" to tell front workspace
collapse cue "1"
end tell
(verb): collate and start a Light cue.
collateAndStart {light cue}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | light cue | The Light cue that you want to collate and start. |
The following classes respond to the collateAndStart command:
tell application id "com.figure53.QLab.5" to tell front workspace
collateAndStart cue "1"
end tell
(verb): verify and prepare the script for use.
compile {script cue}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | script cue | The Script cue whose source you want to (re)compile. |
The following classes respond to the compile command:
tell application id "com.figure53.QLab.5" to tell front workspace
compile cue "1"
end tell
(verb): delete a cue or list of cues.
delete {cue}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | cue or list | The cue or cues to delete. |
The following classes respond to the delete command:
-- the cue whose cue number is "1"
delete cue "1"
-- one or several selected cues
delete selected
-- a list of cues based on position in the cue list
set listOfCues to cues 3 thru -1 of myCueList
delete listOfCues
-- an indivdual cue by position
delete last cue of myGroupCue
(verb): expand a Group cue or cue list.
expand {group cue}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | group cue | The Group cue that will expand. |
The following classes respond to the expand command:
tell application id "com.figure53.QLab.5" to tell front workspace
expand cue "1"
end tell
(verb): get the gang for a specified location in the cue’s matrix.
set theResult to getGang {cue} row {row_number} column {column_number}
text: the value of the gang at the specified location in the cue’s matrix.
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. |
The following classes respond to the getGang command:
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
(verb): get the input name for a specified input channel.
set theResult to getInputChannelName {cue} row {row_number}
text: the name for the input channel.
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | cue | The cue from which you want to get the audio input name. | |
row | integer | The row of the level matrix. Starts at 1. |
The following classes respond to the getGang command:
tell application id "com.figure53.QLab.5" to tell front workspace
set theName to getInputChannelName 1 row 2
display dialog "The input name for input 2 of cue 1 is: " & theName
end tell
(verb): get the level for a specified location in the cue’s matrix.
set theResult to getLevel {cue} row {row_number} column {column_number}
real number: the level in decibels of the specified location in the cue’s matrix.
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. |
The following classes respond to the getLevel command:
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 of cue 1 is: " & theLevel
end tell
(verb): get the status of the mute button for a specified output of the cue.
set theResult to getMute {cue} output {output_number}
boolean: the state of the specified mute control.
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | cue | The cue from which you want to get the mute state. | |
output | integer | The output of the level matrix. Output 0 is the main level. |
The following classes respond to the getMute command:
tell application id "com.figure53.QLab.5" to tell front workspace
set theMute to cue "6" getMute output 1
display dialog "The mute state of output 1 is: " & theMute
end tell
(verb): get the status of the solo button for a specified output of the cue.
set theResult to getSolo {cue} output {output_number}
boolean: the state of the specified solo control.
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | cue | The cue from which you want to get the solo state. | |
output | integer | The output of the level matrix. Output 0 is the main level. |
The following classes respond to the getMute command:
tell application id "com.figure53.QLab.5" to tell front workspace
set theSolo to cue "6" getMute output 1
display dialog "The solo state of output 1 is: " & theMute
end tell
(verb): make a workspace GO.
go {workspace}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | workspace | The workspace to GO. |
The following classes respond to the go command:
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
(verb): hardStop one or more cues or workspaces.
hardStop {reference}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | reference | The cue(s) or workspace(s) to hardStop. |
The following classes respond to the hardStop command:
tell application id "com.figure53.QLab.5"
hardStop cue "1"
end tell
tell application id "com.figure53.QLab.5"
hardStop front workspace
end tell
(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.
load {reference} time {real number}
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.
The following classes respond to the load command:
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
(verb): make a new cue in a workspace. The cue will be created below the currently selected cue.
make {workspace} type {text}
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”. |
The following classes respond to the make command:
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
(verb): move a cue or list of cues to a new location.
move {reference to cue or list} to {location specifier}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | reference to cue or list of cues | The cue or list of cues to move. | |
to | location specifier | The new location for the cue or cues. |
-- moving a cue
set theCue to cue "FROMCUE"
set theDestination to cue "DESTCUE"
move theCue to {after|before|beginning of|end of} theDestination
-- moving a list of cues
set theCues to {list_of_cues}
set theDestination to cue "DESTCUE"
move theCues to {after|before|beginning of|end of} theDestination
-- by position within a group or list
set theGroupCue to cue "MYGROUP"
set theDestination to cue "DESTCUE"
move last cue of theGroupCue to {after|before|beginning of|end of} theDestination
(verb): move the playhead to the next cue.
movePlayheadDown {specifier}
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. |
The following classes respond to the movePlayheadDown command:
-- 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
(verb): move the playhead to the top of the next cue sequence.
movePlayheadDownASequence {workspace}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | workspace | The workspace whose playhead will move. |
The following classes respond to the movePlayheadDownASequence command:
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
(verb): move the playhead to the previous cue.
movePlayheadUp {specifier}
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. |
The following classes respond to the movePlayheadUp command:
-- 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
(verb): move the playhead to the top of the previous cue sequence.
movePlayheadUpASequence {workspace}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | workspace | The workspace whose playhead will move. |
The following classes respond to the movePlayheadUpASequence command:
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
(verb): select the next cue.
moveSelectionDown {workspace}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | workspace | The workspace whose selection will change. |
The following classes respond to the moveSelectionDown command:
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
(verb): select the previous cue.
moveSelectionUp {workspace}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | workspace | The workspace whose selection will change. |
The following classes respond to the moveSelectionUp command:
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
(verb): create a new Light cue containing levels for all parameters of all instruments.
newCueWithAll {light dashboard}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | light dashboard | The Light Dashboard from which you want to create a new Light cue. |
The following classes respond to the newCueWithAll command:
tell application id "com.figure53.QLab.5" to tell front workspace
set theDashboard to current light dashboard
newCueWithAll theDashboard
end tell
(verb): create a new Light cue containing levels for all manually adjusted parameters in the Light Dashboard.
newCueWithChanges {light dashboard}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | light dashboard | The Light Dashboard from which you want to create a new Light cue. |
The following classes respond to the newCueWithChanges command:
tell application id "com.figure53.QLab.5" to tell front workspace
set theDashboard to current light dashboard
newCueWithChanges theDashboard
end tell
(verb): panic one or more cues or workspaces.
panic {reference}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | reference | The cue(s) or workspace(s) to panic. |
The following classes respond to the panic command:
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
(verb): pause one or more cues or workspaces.
pause {reference}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | reference | The cue(s) or workspace(s) to pause. |
The following classes respond to the pause command:
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
(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.
preview {cue}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | cue | The cue(s) to preview. |
The following classes respond to the preview command:
tell application id "com.figure53.QLab.5" to tell front workspace
preview cue "1"
end tell
(verb): remove light commands that have no effect from a Light cue.
prune {light cue}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | light cue | The Light cue(s) whose command text you want to prune. |
The following classes respond to the prune command:
tell application id "com.figure53.QLab.5" to tell front workspace
prune cue "1"
end tell
(verb): record all levels for all parameters of all instruments into the latest run Light cue.
recordAllToLatest {light dashboard}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | light dashboard | The Light Dashboard from which you want to record all to the latest cue. |
The following classes respond to the recordAllToLatest command:
tell application id "com.figure53.QLab.5" to tell front workspace
set theDashboard to current light dashboard
recordAllToLatest theDashboard
end tell
(verb): record all levels for all parameters of all instruments into the selected Light cue(s).
recordAllToSelected {light dashboard}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | light dashboard | The Light Dashboard from which you want to record all to the selected cue(s). |
The following classes respond to the recordAllToSelected command:
tell application id "com.figure53.QLab.5" to tell front workspace
set theDashboard to current light dashboard
recordAllToSelected theDashboard
end tell
(verb): redo the last undone action.
redo {reference}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | reference | The workspace or Light Dashboard in which you want to redo the last undone action. |
The following classes respond to the redo command:
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
(verb): remove existing light commands in the specified cue matching the command provided.
removeLightCommandsMatching {cue} command {text}
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. |
The following classes respond to the removeLightCommandsMatching command:
tell application id "com.figure53.QLab.5" to tell front workspace
removeLightCommandsMatching cue "1" command "myLight.intensity = 100"
end tell
(verb): replace a specified light command in the specified cue with a new light command.
replaceLightCommand {cue} oldCommandText {text} newCommandText {text}
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. |
The following classes respond to the replaceLightCommand command:
tell application id "com.figure53.QLab.5" to tell front workspace
replaceLightCommand cue "1" oldCommandText "myLight.intensity = 100" newCommandText "myLight.intensity = 80"
end tell
(verb): reset one or more cues or workspaces.
reset {reference}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | reference | The cue(s) or workspace(s) to reset. |
The following classes respond to the reset command:
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
(verb): revert changes in the specified Light Dashboard.
revert {light dashboard}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | light dashboard | The Light Dashboard in which you want to revert changes. |
The following classes respond to the revert command:
tell application id "com.figure53.QLab.5" to tell front workspace
set theDashboard to current light dashboard
revert theDashboard
end tell
(verb): save the last undone action.
save {reference}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | reference | The workspace or Light Dashboard in which you want to save the last undone action. |
The following classes respond to the save command:
tell application id "com.figure53.QLab.5" to tell front workspace
save
end tell
(verb): set the gang for a specified location in the cue’s matrix.
setGang {cue} row {row_number} column {column_number} gang {text}
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. |
The following classes respond to the setGang command:
tell application id "com.figure53.QLab.5" to tell front workspace
set cue "1" row 0 column 1 gang "a"
end tell
(verb): set the input name for a specified row of a cue.
setInputChannelName {cue} row {row_number} name {text}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | cue | The cue for which you want to set the audio input name. | |
name | text | The name for the input channel. | |
row | integer | The row of the level matrix. Starts at 1. |
The following classes respond to the setInputChannelName command:
tell application id "com.figure53.QLab.5" to tell front workspace
set cue "1" row 0 input "vocals"
end tell
(verb): set the level in decibels for a specified location in the cue’s matrix.
setLevel {cue} row {row_number} column {column_number} db {real number}
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. |
The following classes respond to the setLevel command:
tell application id "com.figure53.QLab.5" to tell front workspace
setLevel cue "1" row 0 column 1 db "-6"
end tell
(verb): add a light command to the specified cue or to the Light Dashboard.
setLight {reference} selector {text} value {real number or text}
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. |
The following classes respond to the setLight command:
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
(verb): set the status of the mute button for a specified output of the cue.
setMute {cue} output {output_number} mute {boolean}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | cue | The cue for which you want to set the mute. | |
output | integer | The output number. Output 0 is the main level. | |
mute | boolean | True = mute. False = unmute. |
The following classes respond to the setMute command:
tell application id "com.figure53.QLab.5" to tell front workspace
setMute cue "1" output 0 mute true
end tell
(verb): set the status of the solo button for a specified output of the cue.
setSolo {cue} output {output_number} solo {boolean}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | cue | The cue for which you want to set the mute. | |
output | integer | The output number. Output 0 is the main level. | |
solo | boolean | True = solo. False = unsolo. |
The following classes respond to the setSolo command:
tell application id "com.figure53.QLab.5" to tell front workspace
setSolo cue "1" output 0 mute true
end tell
(verb): shuffle the order of child cues in a Group cue.
shuffle {group cue}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | group cue | The Group cue(s) whose child cues you want to shuffle. |
The following classes respond to the start command:
tell application id "com.figure53.QLab.5" to tell front workspace
start
end tell
(verb): start one or more cues or workspaces.
start {reference}
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. |
The following classes respond to the start command:
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
(verb): stop one or more cues or workspaces.
stop {reference}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | cue | The cue(s) or workspace(s) to stop. |
The following classes respond to the stop command:
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
(verb): undo the last action.
undo {reference}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | cue | The workspace or Light Dashboard in which you want to undo the last action. |
The following classes respond to the undo command:
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
(verb): copy all manually adjusted levels into the latest run Light cue.
updateLatestCue {light dashboard}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | light dashboard | The Light Dashboard from which you want to update the latest cue. |
The following classes respond to the updateLatestCue command:
tell application id "com.figure53.QLab.5" to tell front workspace
set theDashboard to current light dashboard
updateLatestCue theDashboard
end tell
(verb): copy all manually adjusted levels into their originating Light cue(s).
updateOriginatingCues {light dashboard}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | light dashboard | The Light Dashboard from which you want to update the originating cue(s). |
The following classes respond to the updateOriginatingCues command:
tell application id "com.figure53.QLab.5" to tell front workspace
set theDashboard to current light dashboard
updateOriginatingCues theDashboard
end tell
(verb): copy all manually adjusted levels into the selected Light cue(s).
updateSelectedCues {light dashboard}
Parameter | Required? | Type | Description |
---|---|---|---|
direct parameter | light dashboard | The Light Dashboard from which you want to update the selected cue(s). |
The following classes respond to the updateSelectedCues command:
tell application id "com.figure53.QLab.5" to tell front workspace
set theDashboard to current light dashboard
updateSelectedCues theDashboard
end tell
(noun): the top-level scripting object of QLab.
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. |
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 |
The application class responds to the following commands:
Command | Description |
---|---|
open | Open QLab. |
This command has no effect in QLab. | |
quit | Quit QLab. |
*(noun), pl. audio cues *
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. |
Element | Access | Key Forms | Description |
---|---|---|---|
cue | get/make/delete | by name, by index, by uniqueID |
The audio 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. |
getGang | Get the gang for a specified location in the cue’s matrix. |
getInputChannelName | Get the input name for a specified row in the cue’s matrix. |
getLevel | Get the level for a specified location in the cue’s matrix. |
getMute | Get the status of the mute button of a specified output. |
getSolo | Get the status of the solo button of a specified output. |
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. |
setInputChannelName | Set the intput name for a specified row in the cue’s matrix. |
setLevel | Set the level for a specified location in the cue’s matrix. |
setMute | Set the status of the mute button of a specified output. |
setSolo | Set the status of the solo button of a specified output. |
start | Start one or more cues or workspaces. |
stop | Stop one or more cues or workspaces. |
The audio cue class inherits elements and properties from the cue class.
*(noun), pl. camera cues *
In addition to the properties listed here, camera cue inherits properties from cue.
Property | Access | Type | Description |
---|---|---|---|
anchor x | get/set | real number | Anchor along the x axis. |
anchor y | get/set | real number | Anchor along the y axis. |
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. |
fill stage | get/set | boolean | Is the cue displaying in fill stage mode? |
fill style | get/set | fill styles | How does the cue fill the stage? |
full screen | get/set | boolean | Is the cue displaying in full-stage mode? Deprecated in QLab 5.0 - use ‘fill stage’ instead. |
full surface | get/set | boolean | Is the cue displaying in full-stage mode? Deprecated in QLab 5.0 - use ‘fill stage’ instead. |
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% |
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 | boolean | Should the cue be scaled using smoothing interpolation? |
stage name | get/set | text | Video output stage name. Empty string or none means “unpatched.” |
stage number | get/set | integer | Video output stage number. 0 means “unpatched.” |
stage id | get/set | text | Video output stage unique ID. Empty string or none means “unpatched.” |
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.” |
Element | Access | Key Forms | Description |
---|---|---|---|
cue | get/make/delete | by name, by index, by uniqueID |
The camera 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. |
getGang | Get the gang for a specified location in the cue’s matrix. |
getInputChannelName | Get the input name for a specified row in the cue’s matrix. |
getLevel | Get the level for a specified location in the cue’s matrix. |
getMute | Get the status of the mute button of a specified output. |
getSolo | Get the status of the solo button of a specified output. |
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. |
setInputChannelName | Set the intput name for a specified row in the cue’s matrix. |
setLevel | Set the level for a specified location in the cue’s matrix. |
setMute | Set the status of the mute button of a specified output. |
setSolo | Set the status of the solo button of a specified output. |
start | Start one or more cues or workspaces. |
stop | Stop one or more cues or workspaces. |
The camera cue class inherits elements and properties from the cue class.
*(noun), pl. cues *
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 . |
continue mode | get/set | contine modes | The continue mode of this cue. |
cue target | get/set | cue | The cue this cue targets, if any. |
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. |
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. |
duration | get | real number | The duration of this cue’s action in seconds. Not editable for all cue types. |
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 color 2 | get/set | text | The name of this cue’s second 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 6 = (playlist only) play next 7 = (playlist only) play previous |
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. |
use q color 2 | get/set | boolean | Whether this cue will use the second cue color after it starts. |
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. |
Element | Access | Key Forms | Description |
---|---|---|---|
cue | get/make/delete | by name, by index, by uniqueID | Cues contained by this cue, if any. |
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. |
All cue classes inherit the elements and properties of the cue class.
The cue class is used in the following ways:
*(noun), pl. cue lists *
In addition to the properties listed here, cue list inherits properties from cue and from group cue.
Property | Access | Type | Description |
---|---|---|---|
current timecode text | get | text | The timecode currently being received. |
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 | sync mode | 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. |
timecode start behavior | get/set | timecode start | How cues in this list will behave when timecode starts. |
timecode stop behavior | get/set | timecode stop | How cues in this list will behave when timecode stops. |
Element | Access | Key Forms | Description |
---|---|---|---|
cue | get/make/delete | by name, by index, by uniqueID | Cues contained by this cue list, if any. |
The cue list 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. |
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. |
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. |
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. |
The cue list class inherits elements and properties from the group cue class.
The cue list class is used in the following ways:
*(noun), pl. devamp cues *
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? |
Element | Access | Key Forms | Description |
---|---|---|---|
cue | get/make/delete | by name, by index, by uniqueID |
The devamp 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. |
The devamp cue class inherits elements and properties from the cue class.
*(noun), pl. fade cues *
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. |
Element | Access | Key Forms | Description |
---|---|---|---|
cue | get/make/delete | by name, by index, by uniqueID |
The fade 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. |
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. |
The fade cue class inherits elements and properties from the cue class.
*(noun), pl. group cues *
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. |
playlist crossfade | get/set | boolean | Does this playlist group crossfade between its child cues? |
playlist crossfade duration | get/set | real number | The duration of the cue’s playlist crossfade in seconds. |
playlist loop | get/set | boolean | Does this playlist group loop? |
playlist shuffle | get/set | boolean | Does this playlist group shuffle the order of its child cues? |
Element | Access | Key Forms | Description |
---|---|---|---|
cue | get/make/delete | by name, by index, by uniqueID | Cues contained by this cue, if any. |
The fade 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. |
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. |
The group cue class inherits elements and properties from the cue class.
The cue list class inherits elements and properties from the group cue class.
The group cue class is used in the following ways:
*(noun), pl. light cues *
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? |
Element | Access | Key Forms | Description |
---|---|---|---|
cue | get/make/delete | by name, by index, by uniqueID |
The light 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. |
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. |
The light cue class inherits elements and properties from the cue class.
The light cue class is used in the following ways:
(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. |
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). |
The light dashboard class is used in the following ways:
*(noun), pl. load cues *
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. |
Element | Access | Key Forms | Description |
---|---|---|---|
cue | get/make/delete | by name, by index, by uniqueID |
The load 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. |
The load cue class inherits elements and properties from the cue class.
*(noun), pl. mic cues *
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. |
Element | Access | Key Forms | Description |
---|---|---|---|
cue | get/make/delete | by name, by index, by uniqueID |
The mic 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. |
getGang | Get the gang for a specified location in the cue’s matrix. |
getInputChannelName | Get the input name for a specified row in the cue’s matrix. |
getLevel | Get the level for a specified location in the cue’s matrix. |
getMute | Get the status of the mute button of a specified output. |
getSolo | Get the status of the solo button of a specified output. |
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. |
setInputChannelName | Set the intput name for a specified row in the cue’s matrix. |
setLevel | Set the level for a specified location in the cue’s matrix. |
setMute | Set the status of the mute button of a specified output. |
setSolo | Set the status of the solo button of a specified output. |
start | Start one or more cues or workspaces. |
stop | Stop one or more cues or workspaces. |
The mic cue class inherits elements and properties from the cue class.
*(noun), pl. midi cues *
In addition to the properties listed here, midi cue inherits properties from cue.
Property | Access | Type | Description |
---|---|---|---|
byte combo | get/set | integer | (MIDI voice message type) 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 | (MIDI voice message type) First byte of the MIDI message. |
byte two | get/set | integer | (MIDI voice message type) Second byte of the MIDI message. |
channel | get/set | integer | (MIDI voice message type) MIDI channel number. |
command | get/set | midi command | (MIDI voice message type) MIDI command. |
command format | get/set | integer | (MSC message type) MSC command format. |
command number | get/set | integer | (MSC message type) MSC command. |
control number | get/set | integer | (MSC message type) MSC control number. |
control value | get/set | integer | (MSC message type) MSC control value. |
deviceID | get/set | integer | (MSC message type) MSC device ID number. |
end value | get/set | integer | (MIDI voice message type) The end value for a faded MIDI message. |
fade | get/set | boolean | (MIDI voice message type) Does the MIDI message fade? |
macro | get/set | integer | (MSC message type) MSC macro parameter. |
message type | get/set | midi type | The type of MIDI message for this cue (msd, sysex, or voice.) |
midi patch id | get/set | text | The unique ID of this cue’s MIDI patch. Empty string or none means “unpatched.” |
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.” |
msc frames | get/set | integer | (MSC message type) MSC frames parameter. |
msc hours | get/set | integer | (MSC message type) MSC hours parameter. |
msc minutes | get/set | integer | (MSC message type) MSC minutes parameter. |
msc seconds | get/set | integer | (MSC message type) MSC seconds parameter. |
msc subframes | get/set | integer | (MSC message type) MSC subframes 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. |
q_list | get/set | text | (MSC message type) Q List message parameter. |
q_number | get/set | text | (MSC message type) Q Number message parameter. |
q_path | get/set | text | (MSC message type) Q Path message parameter. |
send time with set | get/set | boolean | (MSC message type) Send the timecode parameters with the SET command? |
smpte format | get/set | smpte format | (MSC message type) SMPTE format of the timecode parameters. |
start value | get/set | integer | (MIDI voice message type) The start value for a faded MIDI message. |
sysex message | get/set | text | (SysEx message type) The raw SysEx message. Use only hexadecimal characters and whitespace. Omit the starting F0 and the ending F7 . |
Element | Access | Key Forms | Description |
---|---|---|---|
cue | get/make/delete | by name, by index, by uniqueID |
The midi 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. |
The midi cue class inherits elements and properties from the cue class.
*(noun), pl. midi file cues *
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. |
Element | Access | Key Forms | Description |
---|---|---|---|
cue | get/make/delete | by name, by index, by uniqueID |
The midi file 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. |
The midi file cue class inherits elements and properties from the cue class.
*(noun), pl. network cues *
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. |
Element | Access | Key Forms | Description |
---|---|---|---|
cue | get/make/delete | by name, by index, by uniqueID |
The network 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. |
The network cue class inherits elements and properties from the cue class.
(noun)
Property | Access | Type | Description |
---|---|---|---|
dmx output enabled | get/set | boolean | Allow DMX 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.) |
The override controller class is used in the following ways:
-- 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
*(noun), pl. script cues *
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. |
Element | Access | Key Forms | Description |
---|---|---|---|
cue | get/make/delete | by name, by index, by uniqueID |
The script 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. |
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. |
The script cue class inherits elements and properties from the cue class.
The script cue class is used in the following ways:
*(noun), pl. target cues *
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. |
Element | Access | Key Forms | Description |
---|---|---|---|
cue | get/make/delete | by name, by index, by uniqueID |
The target 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. |
The target cue class inherits elements and properties from the cue class.
*(noun), pl. text cues *
In addition to the properties listed here, text cue inherits properties from cue.
Property | Access | Type | Description |
---|---|---|---|
anchor x | get/set | real number | Anchor along the x axis. |
anchor y | get/set | real number | Anchor along the y axis. |
blend mode | get/set | text | Display name of the video blend mode. |
fill stage | get/set | boolean | Is the cue displaying in fill stage mode? |
fill style | get/set | fill styles | How does the cue fill the stage? |
full screen | get/set | boolean | Is the cue displaying in full-stage mode? Deprecated in QLab 5.0 - use ‘fill stage’ instead. |
full surface | get/set | boolean | Is the cue displaying in full-stage mode? Deprecated in QLab 5.0 - use ‘fill stage’ instead. |
fixed width | get/set | number | Fixed width of the text cue. Setting this to 0 specifies “auto” width. |
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% |
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? | |
stage name | get/set | text | Video output stage name. Empty string or none means “unpatched.” |
stage number | get/set | integer | Video output stage number. 0 means “unpatched.” |
stage id | get/set | text | Video output stage unique ID. Empty string or none means “unpatched.” |
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. |
Element | Access | Key Forms | Description |
---|---|---|---|
cue | get/make/delete | by name, by index, by uniqueID |
The text 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. |
The text cue class inherits elements and properties from the cue class.
*(noun), pl. timecode cues *
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. |
Element | Access | Key Forms | Description |
---|---|---|---|
cue | get/make/delete | by name, by index, by uniqueID |
The timecode 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. |
The timecode cue class inherits elements and properties from the cue class.
*(noun), pl. video cues *
In addition to the properties listed here, video cue inherits properties from cue.
Property | Access | Type | Description |
---|---|---|---|
anchor x | get/set | real number | Anchor along the x axis. |
anchor y | get/set | real number | Anchor along the y axis. |
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. |
end time | get/set | real number | Time in the target file where playback ends. |
fill stage | get/set | boolean | Is the cue displaying in fill stage mode? |
fill style | get/set | fill styles | How does the cue fill the stage? |
full screen | get/set | boolean | Is the cue displaying in full-stage mode? Deprecated in QLab 5.0 - use ‘fill stage’ instead. |
full surface | get/set | boolean | Is the cue displaying in full-stage mode? Deprecated in QLab 5.0 - use ‘fill stage’ instead. |
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% |
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? | |
stage name | get/set | text | Video output stage name. Empty string or none means “unpatched.” |
stage number | get/set | integer | Video output stage number. 0 means “unpatched.” |
stage id | get/set | text | Video output stage unique ID. Empty string or none means “unpatched.” |
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. |
Element | Access | Key Forms | Description |
---|---|---|---|
cue | get/make/delete | by name, by index, by uniqueID |
The video 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. |
getGang | Get the gang for a specified location in the cue’s matrix. |
getInputChannelName | Get the input name for a specified row in the cue’s matrix. |
getLevel | Get the level for a specified location in the cue’s matrix. |
getMute | Get the status of the mute button of a specified output. |
getSolo | Get the status of the solo button of a specified output. |
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. |
setInputChannelName | Set the intput name for a specified row in the cue’s matrix. |
setLevel | Set the level for a specified location in the cue’s matrix. |
setMute | Set the status of the mute button of a specified output. |
setSolo | Set the status of the solo button of a specified output. |
start | Start one or more cues or workspaces. |
stop | Stop one or more cues or workspaces. |
The video cue class inherits elements and properties from the cue class.
*(noun), pl. workspaces *
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 | 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? |
live fade preview | get/set | boolean | Is live fade preview currently enabled for this workspace? |
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. |
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. |
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. |
The workspace class is used in the following ways:
Constant | Description |
---|---|
absolute | |
relative |
The absolute relative enumeration is used in the following ways:
Constant | Description |
---|---|
audio | |
video |
The clock types enumeration is used in the following ways:
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. |
The continue modes enumeration is used in the following ways:
Constant | Description |
---|---|
disabled | |
enabled |
The enabled disabled enumeration is used in the following ways:
Constant | Description |
---|---|
fill | Fill the entire stage with the cue, preserving aspect ratio. Some portion of the cue may be cut off. |
fit | Fit the cue inside the stage, preserving aspect ratio. Some empty space may be left to the sides or top and bottom of the cue. |
stretch | Fill the stage by stretching the cue height and width to match the stage. |
The fill styles enumeration is used in the following ways:
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. |
The group modes enumeration is used in the following ways:
Constant | Description |
---|---|
sliders | |
tiles |
The light dashboard view mode enumeration is used in the following ways:
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 |
The midi command enumeration is used in the following ways:
Constant | Description |
---|---|
msc | MIDI Show Control message. |
sysex | MIDI System Exclusive message. |
voice | MIDI Voice message. |
The midi type enumeration is used in the following ways:
Constant | Description |
---|---|
ltc | Linear/Longitudinal Timecode. |
mtc | MIDI Timecode. |
The mtc ltc enumeration is used in the following ways:
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. |
The smpte format enumeration is used in the following ways:
Constant | Description |
---|---|
lookback time | start cues whose timecode triggers precede the incoming timecode by the lookback window. |
recent hour | start cues whose timecode triggers fall within the most recent hour of incoming timecode. |
recent minute | start cues whose timecode triggers fall within the most recent minute of incoming timecode. |
skip | do not start cues whose timecode triggers precede the incoming timecode. |
start all | start all cues whose timecode triggers precede the incoming timecode. |
The timecode start enumeration is used in the following ways:
Constant | Description |
---|---|
hard pause | hard pause timecode triggered cues when incoming timecode stops. |
hard stop | hard stop timecode triggered cues when incoming timecode stops. |
none | do nothing when incoming timecode stops. |
The timecode stop enumeration is used in the following ways:
A 2-item record representing the offset and length of a substring.
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. |
The range record is used in the following ways:
A 4-item record representing red, green, blue, and alpha percentage values of a color.
Property | Access | Type | Description |
---|---|---|---|
red | get/set | real number | |
green | get/set | real number | |
blue | get/set | real number | |
alpha | get/set | real number |
The rgba color record record is used in the following ways:
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
A 2-item record representing a position defined by a numeric row and column value.
Property | Access | Type | Description |
---|---|---|---|
column | get/set | integer | |
row | get/set | integer |
The row column record is used in the following ways:
A 2-item record representing the play count and end time of a slice.
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. |
The slice marker record record is used in the following ways:
A record representing the formatting aspects of a text string.
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) |
The text format record record is used in the following ways:
Still have a question?
Our support team is always happy to help.