QLab and OSC (linking with lighting and sound)
Applies to: iPhone, iPad and Mac 1.3.7 (QLab link is β (Mac); on Mac it is available from 1.3.7)
When a cue starts (and at other moments), the app sends OSC messages to QLab, lighting consoles, or video software (Resolume, TouchDesigner, and so on) on the same network. This is a Pro feature.
- Messages are sent over UDP, so the app can't confirm they arrived. Always test before the show
- The app only drives QLab automatically when you turn that on in settings (everything starts off)
1. Add a destination
In Settings, go to "OSC output" → Add destination.
| Field | What to enter |
|---|---|
| Type | "Other" (lighting consoles, video software, etc.) or "QLab" |
| Name | A name you'll recognize |
| IP address | The IP of the receiving device (e.g. 192.168.1.10) |
| Port | 8000 by default for Other. 53000 for QLab |
After adding it, tap Test to check that it arrives. Each destination has a switch, so you can pause it for a while. Destination settings are per device (they don't sync).
Find QLab
When you set Type to "QLab", Find QLab (same network) appears (iPhone, iPad and Mac). Tap a Mac in the results to fill in the name, IP and port. If nothing shows up, enter the IP address by hand.
Passcode and workspace
If QLab's OSC Access has a passcode, enter it in Passcode (optional). The passcode is stored only on this device and is never included in sync or sharing.
Once you enter it, the app checks the connection automatically.
| Message | What to do |
|---|---|
| Connected to QLab | No action needed |
| Wrong passcode | Check the passcode in QLab's OSC Access |
| Allow control in QLab’s OSC Access | In QLab, go to Workspace Settings → Network → OSC Access and allow control |
| Can’t reach QLab | Check the IP, the network, and that QLab is running |
| Open a workspace in QLab | Open a workspace in QLab |
If two or more workspaces are open, buttons appear so you can choose which one to send to.
2. Turn on sending for a show
In Show info (ⓘ), turn these on from top to bottom.
| Switch | What it does |
|---|---|
| Send OSC | Sends OSC for this show |
| Send to QLab | When a cue starts, GOes the QLab cue with the same number |
| Panic on STOP | Sends Panic to QLab when you press Stop |
Change it per sheet
Turn off "Use show settings" in a sheet's settings to give just that sheet its own on/off settings.
How the QLab link works
- Number: the cue's position from the top of the sheet (1st cue → QLab cue 1). Number your QLab cues 1, 2, 3...
- It only sends when a person advances the cue, with NEXT, "Start now" and so on
- It does not send in these cases: sheets with AUTO on / undo, redo, reset / opening the run screen / syncing from another device
- Turn off Send to QLab on a cue to skip sending for that cue (on by default)
- When you use "Start now" in the cue list, you can choose whether to send with "Send the cue to QLab"
When the mark shows on the run screen, the QLab link is active (when AUTO is off). With QLab 5.3 or later, the app also shows QLab's current playhead (on iPhone as "Q 3.1", on iPad and Mac under the top bar). This is read-only; it doesn't control QLab.
What gets sent (Other destinations)
Destinations with Type "Other" receive the following. The address prefix is /sbl by default (you can change it in "Address prefix").
| Address | When | Contents |
|---|---|---|
| /sbl/cue/start | When a cue starts | Number, title, duration (seconds) |
| /sbl/cue/end | When a cue ends | Number, title |
| /sbl/show/end | When the sheet ends | — |
| /sbl/state | When the color changes | normal / warning / critical / overtime |
| /sbl/telop | When you change the message | Text, color |
| /sbl/remain | Every second (when "Send remaining time every second" is on) | Seconds remaining, "MM:SS" (negative when over time) |
OSC per cue
In the cue editor, under "OSC sent at start" → Add OSC, you can add messages that are sent when that cue starts. They go to every destination that is on.
- Custom: enter an address and arguments (integer, float, text)
- QLab: pick an action (GO, Start, Playhead, Stop, Pause, Resume, plus whole-workspace GO, Stop, Panic, and more) and a QLab cue number, and the app builds the address
Sending from a client
A client that has joined a share can also send to the destinations on its own device. This needs Pro and at least one destination on that device. The host's settings are not used.
- On the client's run screen, open "OSC settings" and turn on Send OSC, Send to QLab and Panic on STOP as needed (all off by default)
- Tap a cue → under "When NEXT is pressed", turn on Send to QLab / Send OSC (all off by default)
- Press NEXT at the bottom to send the next cue. Press STOP to send Panic (asks to confirm)
The client never sends on its own when the host's run changes. It only sends when you press NEXT on the client.
Pre-show checklist
- Test gets through
- QLab cue numbers match the order of cues in the sheet
- "Connected to QLab" is showing
- AUTO is off on sheets that use the QLab link
- The OSC mark on the run screen is green (red means sending failed)