Skip to content

Integrate with external systems

CanvasPro can drive external systems and respond to external events through its trigger system. A trigger is an action that runs when a scene or queue starts playing.

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 at a configured baud rate
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 Send scene data values directly to Ventuz

Triggers run asynchronously and do not block playback. Multiple triggers can be attached to the same scene or queue.

Attach a trigger to a scene

Triggers are configured on the scene or queue itself, on the Channels page.

  1. Open the scene or queue.
  2. Open its triggers panel.
  3. Add a trigger and pick its type.
  4. Fill in the trigger's variables (URL and method for HTTP, IP and port for OSC, port and baud for serial).
  5. 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, or other CanvasPro instance.

Field Notes
IP Target host
Port UDP port on the target
Path OSC address pattern, for example /cue/go
Data Optional payload values

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
Baud The baud rate
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 scene data values directly to the graphics engine.

What's next