QLab

https://qlab.app/docs/v5/
Admin
QLab is a live media playback and show control program for macOS used in theater, broadcast, and...
Tokens:576,963
Snippets:3,989
Trust Score:9.8
Update:11 hours ago
Show doc for...
Tokens:
Raw
### start command example: start cue "1"

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Example of starting a specific cue by its ID.

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

--------------------------------

### start

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Start one or more cues or workspaces.

```APIDOC
## start

### Description
Start one or more cues or workspaces.

### Command
`start`

### Applies to
audio cue class
```

--------------------------------

### start

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Start one or more cues or workspaces.

```APIDOC
## start

### Description
Start one or more cues or workspaces.

### Command
`start`

### Applies to
Camera cue class
```

--------------------------------

### start

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Start one or more cues or workspaces.

```APIDOC
## start

### Description
Start one or more cues or workspaces.

### Command
start

### Applies to
midi cue
```

--------------------------------

### start

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Start one or more cues or workspaces.

```APIDOC
## start

### Description
Start one or more cues or workspaces.

### Command
`start`
```

--------------------------------

### start command syntax

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Syntax for the start command, which starts one or more cues or workspaces.

```applescript
start {reference}
```

--------------------------------

### shuffle example

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Shuffles the child cues of the front workspace's cue list. The example uses the 'start' command, which is likely a typo for 'shuffle'.

```applescript
tell application id "com.figure53.QLab.5" to tell front workspace
  start
end tell
```

--------------------------------

### start

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Starts playback of the specified cue or cue list.

```APIDOC
## start

### Description
Starts playback of the specified cue or cue list.

### Syntax
`start <cue>`

### Parameters
- **direct parameter** (cue) - Required - The cue or cue list to start.

### Example
```applescript
tell application "QLab"
    start cue 1
end tell
```
```

--------------------------------

### newCueWithChanges Example

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Example of using newCueWithChanges with the current light dashboard in the front workspace.

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

--------------------------------

### load cue by id example

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Example of loading a cue by its unique id.

```applescript
tell application id "com.figure53.QLab.5"
  -- load the cue whose cue id is 4
  load (cue 4)
end tell
```

--------------------------------

### go front workspace example

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Example of using the go command on the front workspace.

```applescript
tell application id "com.figure53.QLab.5"
  go front workspace
end tell
```

--------------------------------

### updateSelectedCues Example

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Example AppleScript that gets the current light dashboard and calls updateSelectedCues on it.

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

--------------------------------

### updateOriginatingCues Example

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Example AppleScript that gets the current light dashboard and calls updateOriginatingCues on it.

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

--------------------------------

### audition go example with front workspace

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Example of using audition go on the front workspace of QLab 5.

```applescript
applescript
tell application id "com.figure53.QLab.5" to tell front workspace
  audition go
end tell
```

--------------------------------

### go workspace by name example

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Example of using the go command on a workspace specified by name.

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

--------------------------------

### getGang command example

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Example showing how to get the gang for a specific row and column and display it in a dialog.

```applescript
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
```

--------------------------------

### getInputChannelName Example

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Example AppleScript that gets the input name for row 2 of cue 1 and displays it in a dialog.

```applescript
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
```

--------------------------------

### make audio cue example

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Creates an audio cue in the front workspace.

```applescript
tell application id "com.figure53.QLab.5"
  make front workspace type "audio"
end tell
```

--------------------------------

### getLevel Example

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Example AppleScript that gets the level at row 0, column 1 of cue 1 and displays it in a dialog.

```applescript
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
```

--------------------------------

### /settings/video/stage/{name}/region/{name}/enableGuide {boolean}

Source: https://qlab.app/docs/v5/scripting/osc-dictionary-v5/

Gets or sets the visibility of guides for a specified region. Read returns current visibility; write sets it to true or false.

```APIDOC
## /settings/video/stage/{name}/region/{name}/enableGuide {boolean}

### Description
Gets or sets the visibility of the guides for the specified region. If no argument is given, returns the current visibility. If a boolean argument is provided, sets the visibility to that value.

### Method
OSC

### Endpoint
/settings/video/stage/{name}/region/{name}/enableGuide

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the stage.
- **name** (string) - Required - The name of the region.

#### Query Parameters
- **boolean** (boolean) - Optional - When provided, sets the guide visibility to true or false. When omitted, reads the current visibility.

### Request Example
/settings/video/stage/MainStage/region/Front/enableGuide true

### Response
#### Success Response
- **boolean** (boolean) - The current visibility of the guides (when reading).

#### Response Example
/settings/video/stage/MainStage/region/Front/enableGuide

Returns: true
```

--------------------------------

### /settings/video/stage/{name}/regionIndex/{index}/enableGuide {boolean}

Source: https://qlab.app/docs/v5/scripting/osc-dictionary-v5/

Gets or sets the visibility of guides for a specified region by index. Read returns current visibility; write sets it to true or false.

```APIDOC
## /settings/video/stage/{name}/regionIndex/{index}/enableGuide {boolean}

### Description
Gets or sets the visibility of the guides for the specified region. If no argument is given, returns the current visibility. If a boolean argument is provided, sets the visibility to that value.

### Method
OSC

### Endpoint
/settings/video/stage/{name}/regionIndex/{index}/enableGuide

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the stage.
- **index** (integer) - Required - The index of the region.

#### Query Parameters
- **boolean** (boolean) - Optional - When provided, sets the guide visibility to true or false. When omitted, reads the current visibility.

### Request Example
/settings/video/stage/MainStage/regionIndex/0/enableGuide true

### Response
#### Success Response
- **boolean** (boolean) - The current visibility of the guides (when reading).

#### Response Example
/settings/video/stage/MainStage/regionIndex/0/enableGuide

Returns: true
```

--------------------------------

### /settings/video/stage/{name}/regionID/{region_id}/enableGuide {boolean}

Source: https://qlab.app/docs/v5/scripting/osc-dictionary-v5/

Gets or sets the visibility of guides for a specified region by region ID. Read returns current visibility; write sets it to true or false.

```APIDOC
## /settings/video/stage/{name}/regionID/{region_id}/enableGuide {boolean}

### Description
Gets or sets the visibility of the guides for the specified region. If no argument is given, returns the current visibility. If a boolean argument is provided, sets the visibility to that value.

### Method
OSC

### Endpoint
/settings/video/stage/{name}/regionID/{region_id}/enableGuide

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the stage.
- **region_id** (string) - Required - The ID of the region.

#### Query Parameters
- **boolean** (boolean) - Optional - When provided, sets the guide visibility to true or false. When omitted, reads the current visibility.

### Request Example
/settings/video/stage/MainStage/regionID/abc123/enableGuide true

### Response
#### Success Response
- **boolean** (boolean) - The current visibility of the guides (when reading).

#### Response Example
/settings/video/stage/MainStage/regionID/abc123/enableGuide

Returns: true
```

--------------------------------

### make cue list example

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Creates a new cue list in the front workspace.

```applescript
tell application id "com.figure53.QLab.5"
  make front workspace type "cue list"
end tell
```

--------------------------------

### GET/PUT /settings/audio/mapID/{map_ID}/testObject/running

Source: https://qlab.app/docs/v5/scripting/osc-dictionary-v5/

Gets or sets the running status of the test object in the specified map. When reading, returns TRUE if running, FALSE otherwise. When writing, starts or stops the test object.

```APIDOC
## GET/PUT /settings/audio/mapID/{map_ID}/testObject/running

### Description
Gets or sets the running status of the test object in the specified map. When reading, returns TRUE if running, FALSE otherwise. When writing, starts or stops the test object.

### Method
GET (read) / PUT (write)

### Endpoint
`/settings/audio/mapID/{map_ID}/testObject/running`

### Parameters
#### Path Parameters
- **map_ID** (string) - Required - The ID of the audio map.

#### Request Body (for write)
- **boolean** (boolean) - Required - Set to TRUE to start, FALSE to stop.

### Response
#### Success Response (200) - Read
- **boolean** (boolean) - TRUE if running, FALSE otherwise.

#### Success Response (200) - Write
No response body.

#### Response Example (Read)
```json
{
  "boolean": true
}
```
```

--------------------------------

### audition go example with workspace name

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Example of using audition go on a workspace specified by name.

```applescript
applescript
tell application id "com.figure53.QLab.5"
  audition go workspace "hamlet.qlab5"
end tell
```

--------------------------------

### GET/PUT /settings/audio/map/{map_name}/testObject/running

Source: https://qlab.app/docs/v5/scripting/osc-dictionary-v5/

Gets or sets the running status of the test object in the specified map. When reading, returns TRUE if running, FALSE otherwise. When writing, starts or stops the test object.

```APIDOC
## GET/PUT /settings/audio/map/{map_name}/testObject/running

### Description
Gets or sets the running status of the test object in the specified map. When reading, returns TRUE if running, FALSE otherwise. When writing, starts or stops the test object.

### Method
GET (read) / PUT (write)

### Endpoint
`/settings/audio/map/{map_name}/testObject/running`

### Parameters
#### Path Parameters
- **map_name** (string) - Required - The name of the audio map.

#### Request Body (for write)
- **boolean** (boolean) - Required - Set to TRUE to start, FALSE to stop.

### Response
#### Success Response (200) - Read
- **boolean** (boolean) - TRUE if running, FALSE otherwise.

#### Success Response (200) - Write
No response body.

#### Response Example (Read)
```json
{
  "boolean": true
}
```
```

--------------------------------

### audition preview example

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Example of using audition preview on cue "1" in the front workspace.

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

--------------------------------

### /settings/video/stageID/{stage_id}/regionIndex/{index}/enableGuide {boolean}

Source: https://qlab.app/docs/v5/scripting/osc-dictionary-v5/

Gets or sets the visibility of guides for a specified region by stage ID and region index. Read returns current visibility; write sets it to true or false.

```APIDOC
## /settings/video/stageID/{stage_id}/regionIndex/{index}/enableGuide {boolean}

### Description
Gets or sets the visibility of the guides for the specified region. If no argument is given, returns the current visibility. If a boolean argument is provided, sets the visibility to that value.

### Method
OSC

### Endpoint
/settings/video/stageID/{stage_id}/regionIndex/{index}/enableGuide

### Parameters
#### Path Parameters
- **stage_id** (string) - Required - The ID of the stage.
- **index** (integer) - Required - The index of the region.

#### Query Parameters
- **boolean** (boolean) - Optional - When provided, sets the guide visibility to true or false. When omitted, reads the current visibility.

### Request Example
/settings/video/stageID/1/regionIndex/0/enableGuide true

### Response
#### Success Response
- **boolean** (boolean) - The current visibility of the guides (when reading).

#### Response Example
/settings/video/stageID/1/regionIndex/0/enableGuide

Returns: true
```

--------------------------------

### /settings/video/stageID/{stage_id}/regionID/{region_id}/enableGuide {boolean}

Source: https://qlab.app/docs/v5/scripting/osc-dictionary-v5/

Gets or sets the visibility of guides for a specified region by stage ID and region ID. Read returns current visibility; write sets it to true or false.

```APIDOC
## /settings/video/stageID/{stage_id}/regionID/{region_id}/enableGuide {boolean}

### Description
Gets or sets the visibility of the guides for the specified region. If no argument is given, returns the current visibility. If a boolean argument is provided, sets the visibility to that value.

### Method
OSC

### Endpoint
/settings/video/stageID/{stage_id}/regionID/{region_id}/enableGuide

### Parameters
#### Path Parameters
- **stage_id** (string) - Required - The ID of the stage.
- **region_id** (string) - Required - The ID of the region.

#### Query Parameters
- **boolean** (boolean) - Optional - When provided, sets the guide visibility to true or false. When omitted, reads the current visibility.

### Request Example
/settings/video/stageID/1/regionID/abc123/enableGuide true

### Response
#### Success Response
- **boolean** (boolean) - The current visibility of the guides (when reading).

#### Response Example
/settings/video/stageID/1/regionID/abc123/enableGuide

Returns: true
```

--------------------------------

### getSolo Example

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Example of using getSolo on cue "6" for output 1, then displaying the result in a dialog. Note: the example uses getMute in the set line, which may be a typo in the source.

```applescript
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
```

--------------------------------

### /settings/video/stageID/{stage_id}/region/{name}/enableGuide {boolean}

Source: https://qlab.app/docs/v5/scripting/osc-dictionary-v5/

Gets or sets the visibility of guides for a specified region by stage ID and region name. Read returns current visibility; write sets it to true or false.

```APIDOC
## /settings/video/stageID/{stage_id}/region/{name}/enableGuide {boolean}

### Description
Gets or sets the visibility of the guides for the specified region. If no argument is given, returns the current visibility. If a boolean argument is provided, sets the visibility to that value.

### Method
OSC

### Endpoint
/settings/video/stageID/{stage_id}/region/{name}/enableGuide

### Parameters
#### Path Parameters
- **stage_id** (string) - Required - The ID of the stage.
- **name** (string) - Required - The name of the region.

#### Query Parameters
- **boolean** (boolean) - Optional - When provided, sets the guide visibility to true or false. When omitted, reads the current visibility.

### Request Example
/settings/video/stageID/1/region/Front/enableGuide true

### Response
#### Success Response
- **boolean** (boolean) - The current visibility of the guides (when reading).

#### Response Example
/settings/video/stageID/1/region/Front/enableGuide

Returns: true
```

--------------------------------

### POST /settings/audio/map/{map_name}/testObject/start

Source: https://qlab.app/docs/v5/scripting/osc-dictionary-v5/

Starts the test object in the specified map.

```APIDOC
## POST /settings/audio/map/{map_name}/testObject/start

### Description
Starts the test object in the specified map.

### Method
POST

### Endpoint
`/settings/audio/map/{map_name}/testObject/start`

### Parameters
#### Path Parameters
- **map_name** (string) - Required - The name of the audio map.

### Response
#### Success Response (200)
No response body.
```

--------------------------------

### start

Source: https://qlab.app/docs/v5/scripting/applescript-dictionary-v5/

Starts one or more cues or workspaces. Starting a workspace unpauses all paused cues; it does not start cues which are not paused.

```APIDOC
## start

### Description
Starts one or more cues or workspaces. Starting a workspace unpauses all paused cues; it does not start cues which are not paused.

### Syntax
```applescript
start {reference}
```

### Parameters
#### Direct Parameter
- **reference** (cue) - Required - The cue(s) or workspace(s) to start.

### Classes
- workspace
- any type of cue

### Examples
```applescript
tell application id "com.figure53.QLab.5" to tell front workspace
  start
end tell
```

```applescript
tell application id "com.figure53.QLab.5" to tell front workspace
  start cue "1"
end tell
```
```
Tokens:
Raw