Integrate with external systems¶
CanvasPro can drive external systems through its trigger system. A trigger is an action that runs when a scene or queue starts playing, or when an operator presses a control panel button.
Triggers only send. CanvasPro does not listen for OSC or serial input. To control CanvasPro from another system, use its HTTP API or a control panel; see Control CanvasPro from another system.
Trigger types¶
| Trigger type | What it does |
|---|---|
| HTTP request | Send an HTTP request to a configured URL |
| OSC send | Send an OSC message to an IP, port and path |
| Serial command | Send a string out a serial port |
| Start scene | Start a specific scene on a channel |
| Start preset | Start a preset across selected frames |
| Start asset | Start a particular asset inside a template |
| Start by name match | Start any items whose name matches a pattern |
| Start scene data | Push a template variable value to every frame |
Triggers run asynchronously and do not block playback. Multiple triggers can be attached to the same scene or queue. Start scene data is offered only on control panel buttons.
Attach a trigger to a scene¶
Triggers are configured on the scene or queue itself, on the Channels page.
- Open the scene or queue.
- Open its triggers panel.
- Add a trigger and pick its type.
- Fill in the trigger's variables (URL and method for HTTP, IP and port for OSC, port and command for serial).
- Save.
The next time the scene or queue starts, the trigger runs.
HTTP trigger¶
Send a request to any HTTP endpoint when a scene or queue starts.
| Field | Notes |
|---|---|
| Method | GET, POST, PUT or DELETE |
| URL | Full URL to the target endpoint |
| Body | Optional JSON or text body for POST / PUT |
OSC trigger¶
Send an OSC message to a control surface, lighting desk, media server or other show control system. CanvasPro sends OSC; it does not receive it.
| Field | Notes |
|---|---|
| IP | Target host |
| Port | UDP port on the target |
| Path | OSC address pattern, for example /cue/go |
| Data | Optional text, sent as a single string argument |
Serial trigger¶
Send a string out a serial port. Useful for hardware control panels and legacy AV gear.
| Field | Notes |
|---|---|
| Port | The serial port name, for example COM7 |
| Command | The string to send |
CanvasPro-controlling triggers¶
Several trigger types let one part of CanvasPro tell another part to do something. These are useful for chaining: when scene A finishes, start scene B on a different channel.
- Start scene sends a chosen scene to a specific channel.
- Start preset starts a preset across one or more frames.
- Start asset starts a particular asset inside a template.
- Start by name match starts every item whose name matches a pattern.
- Start scene data sends a template variable value to every frame.
Control CanvasPro from another system¶
CanvasPro accepts control from outside in two ways:
- HTTP API. Another system (a show controller, a scheduler, a script) can send HTTP requests to the CanvasPro instance to put scenes and queues on air, cue and take, and run triggers. Requests must carry a sign-in token for a CanvasPro user account; a request without one is refused.
- Control panels. A control panel is a grid of buttons on the On Air page's Grid view. Each button runs its triggers when pressed, with a tap on a touch screen or a mouse click. Use a panel to give an operator one-press control of the moments they fire most.
CanvasPro does not listen for OSC, serial or other inbound protocols. A device that can only send OSC cannot trigger CanvasPro directly; use a show controller that can send HTTP instead.
What's next¶
- Channels for where triggers are configured
- Live override for the operator-driven equivalents
- On Air for the Grid view and its control panels