Updated June 20, 2024 for QLab 5.4.1.
Check out the change log to see what’s new in this release.
Welcome to QLab 5!
This manual is a comprehensive, in-depth reference manual intended to cover every aspect and detail of QLab, and provide adjacent information where relevant. It can be read straight through in case you’re the sort of person who likes reading reference manuals straight through, but it has been designed to allow you to read only the section that is relevant to a question you have or a problem you’re trying to solve.
QLab 5 contains context-specific links to this manual which can be found by right-clicking (or control-clicking) on cues or controls in the inspector, or by clicking buttons which refer to getting help.
Different people find different forms of learning to be the most approachable, and it is our aim to try to provide multi-modal access to learning QLab as much as possible.
The Tutorials section is home to self-contained examples that each explore a single topic in a focused and hands-on manner. Some tutorials are designed to accompany a specific section of the manual; these are linked from the relevant manual section. Other tutorials are meant to stand on their own. A few tutorials are simply essays on topics that aren’t part of QLab itself, but which many QLab users will find helpful in general.
You can download a PDF version of this documentation by clicking here.
What Is QLab
QLab 5 is a live media playback and show control program. Its design is based around concepts and conventions of the theatrical, broadcast, and cinematic industries, but it is intended to be flexible and adaptable enough to be used in many other contexts.
QLab runs on Mac computers, and generally follows the design and interaction principles of macOS. If you are new to the Mac, or if you would like a refresher on the basics of using a Mac, please check out our tutorial on the subject.
- What’s New in QLab 5. An overview of what’s new in QLab 5.
- Change Log. A full log of all changes in every release of QLab 5.
- System Recommendations. An exploration of minimum requirements and hardware & software compatibility.
- Preparing Your Mac. How to get the best possible QLab performance out of your Mac.
- Keyboard Shortcuts. A full listing of the default keyboard shortcuts in QLab.
- Licenses. Using licenses and license management.
- Features by License. Which features require which license?
- QLab Preferences. Preferences which apply to QLab as a whole.
- The Workspace. A visual tour of the main QLab window.
- Workspace Settings. A visual tour of the Workspace Settings window.
- Workspace Templates. Creating new workspaces according to your specific needs.
- Saving, Managing, and Moving Workspaces. Dealing with workspaces outside of QLab.
- Cues. What are cues? What types of cues does QLab have?
- The Inspector. The heart of cue programming and editing.
- Cue Lists. The basic unit of sequential cueing structure.
- Cue Carts. The basic unit of non-sequential cueing structure.
- Group Cues. The essential cue organizing tool.
- Cue Sequences. When two cues go walking, which one does the talking? (Spoiler: usually both.)
- The Tools Menu. Load to time, Renumber cues, Jump to cue, Record cue sequence, and some others.
- Find. Searching your workspace.
- Paste Cue Properties. a.k.a. Fancy Paste.
- The Launcher Window. A jumping-off point.
- The Workspace Status Window.
- Monitor Windows.
- The Timecode Status Window.
- Auditioning Cues.
- Override Controls.
- Introduction to Audio in QLab 5.
- Audio Cues.
- Mic Cues.
- The Audio Output Patch Editor.
- Fading Audio and Audio Effects.
- Introduction to Video in QLab 5.
- Video Cues.
- Camera Cues.
- Text Cues.
- Blend Mode reference videos.
- Video Output.
- Using NDI for networked video input and output.
- Fading Video and Video Effects.
- Introduction to Lighting in QLab 5.
- Light Cues.
- The Light Dashboard.
- The Lighting Command Language.
- The Light Patch Editor.
- The Light Library. A list of the light instrument definitions that are included with QLab.
- Collaboration. Multiuser collaborative editing of QLab workspaces.
- QLab Remote. QLab’s iOS remote-control app.
- Using OSC. Controlling QLab with OSC.
- Controlling QLab with MIDI and MSC (MIDI Show Control).
- Show control broadcast. Broadcasting show control status using MSC and OSC.
- Using Timecode. Controlling QLab with timecode.
- Network cues.
- MIDI cues.
- MIDI File cues.
- Timecode cues.
- OSC Dictionary.
- OSC Queries.
- AppleScript Dictionary.
- Script Cues.
- Parameter Reference.
- Transport cues. Start, Stop, Pause, Load, and Reset cues.
- Devamp cues.
- GoTo cues.
- Target cues.
- Arm and Disarm cues.
- Wait cues.
- Memo cues.
Getting Started
- Zero to Audio
- Zero to Video
- Zero to Lights
- Zero to MIDI
- Zero to Network
Core Concepts
- The Button
- Cue Sequences
- Audio Workflow
- Video Workflow
General Reference
- How To Use A Mac
- Basic Computer Networking for Theater
- Understanding USB-C
Video
- Blend Mode Demo
- Fading With Paths
MIDI, Networking, Scripting, and Show Control
- Timecode Tools
- Sam’s Toolbox
