Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

OSC Control

PRISM speaks OSC (Open Sound Control) over UDP, so any fader surface on earth can run the show: TouchOSC on a tablet, an encoder rack, Ableton, Resolume — and QLab. Faders, encoders and buttons go in; PRISM broadcasts its show state out so your tools can mirror it.

OSC is optional — everything it does is also in the UI. The PRISM server listens as soon as it starts; there is nothing to enable.

Ports

DirectionDefaultWhat it carries
In9000/udpCommands from your OSC device
Out127.0.0.1:9001/udpShow-state broadcast

Both are configurable in the server environment: PRISM_OSC_PORT (in) and PRISM_OSC_OUT (out, comma-separated host:port list for multiple receivers). Point the out port at another machine to feed its display; if the port is already in use, that direction is disabled with a warning and the rest of the server is unaffected.

Sending commands (in)

All values are floats 0.0–1.0 unless noted. Playbacks and cues are addressed by name (use _ where the name has a space, e.g. Main_Show) or by numeric id.

Transport

AddressEffect
/go/{playback}GO — the shortcut for the most common trigger. Starts a playback that is off, just like the GO button.
/execute/{playback}/{command}Full transport: go, back, prev, pause, off, flash_on, flash_off, black_on, black_off, top — same semantics as the buttons in the Playback window.
/execute/{playback}/goto/{cue}Jump straight to a named cue in the playback’s sequence (uses the cue’s own timing).
/execute/{playback}/load/{cue}Arm a cue as the next GO’s destination (GM3-style Load).

Levels

AddressEffect
/fader/{n} {level}Move fader n (1-based, left to right) to level. Live level control: moving a running fader to zero blanks that playback.
/master {level}Grand master fader (0–1). Scales dimmer channels only.
/blackout {0 | 1}Global blackout on/off.

Programmer

AddressEffect
/programmer/{fixture}/{component} {value}Capture a value on a fixture, like typing it in the Controls window. Components: dimmer, red, green, blue, pan, tilt, hue, saturation.

Sending one component does not wipe the others — /programmer/5/red 1.0 keeps the green and blue you already captured. Recall the capture to a cue with the normal Save-to-cue flow (UI or the AI assistant).

Notes

  • Multiple commands in one OSC bundle are all applied.
  • An unknown address, a bad number, or a name that doesn’t match is ignored (logged) — a typo on a stage laptop never takes the show down.
  • Commands go through the same paths as the UI and multi-user sessions: a station without write permission gets the same refusal from OSC as from anywhere else.

Receiving show state (out)

PRISM sends one OSC bundle per state change (coalesced to at most 20 bundles/sec). Addresses:

AddressArgument
/prism/mastergrand master level (0–1)
/prism/blackout0 or 1
/prism/fader/{n}fader level (0–1)
/prism/fader/{n}/running0 or 1
/prism/playback/{playback}/running0 or 1 ({playback} = playback name, spaces as _)
/prism/playback/{playback}/levellive level (0–1)
/prism/playback/{playback}/paused0 or 1
/prism/playback/{playback}/cuecurrent cue name (string)
/prism/playback/{playback}/prevprevious cue name — only sent while a previous cue exists
/prism/playback/{playback}/nextnext cue name — only sent while a next cue exists

Playback addresses appear only while the playback is running — a stopped playback’s addresses leave the bundle. The prev / cue / next names let a remote display (or QLab’s screen) show exactly what the console shows, without any name-matching on your side.

Pairing with QLab

QLab can both trigger PRISM and display it:

  1. QLab → PRISM. Add a trigger (Button) whose output is an OSC message. Example: message /go/Main_Show, target = the PRISM machine’s IP, port 9000. Use /execute/Main_Show/pause for pause, /master with a control for a QLab fader (map the fader’s 0–1 value directly). QLab’s control room can then run a video/cue stack and the lights in the same click order.
  2. PRISM → QLab. Point PRISM’s out port at QLab’s machine: set PRISM_OSC_OUT to qlab-machine-ip:9001 (QLab’s default OSC input port) and send PRISM’s state addresses into QLab’s OSC input. Bind /prism/playback/Main_Show/cue to a screen element to mirror the current cue name. Only playbacks that are running appear in the stream.

A QLab show that triggers a PRISM show is the whole-stack pattern: QLab sequences media, PRISM runs the lights, one operator, no dongle.

Pairing with TouchOSC

A ten-minute layout:

  1. New layout, Wi-Fi port → target = the PRISM machine’s IP, port 9000.
  2. Slider → output address /master → your grand master.
  3. Button → /go/Main_Show (set the button’s output value to anything, e.g. 1) → your GO.
  4. Slider → /fader/1 → a playback level.
  5. For a remote display, add a second Wi-Fi port as input (the machine PRISM’s out port points at, port 9001) and map /prism/playback/Main_Show/cue to a text label.

Security

OSC over UDP is unauthenticated by design — like DMX on your LAN, any device that can reach the port can drive the console. Keep PRISM on a trusted control network; do not expose port 9000 to the internet.