Skip to content

References ​

Technical protocol and API references for integrating Exaplay 3 with external systems — show control, automation, and custom tooling. For guided setup using these protocols, see External Show Control.

Reference Pages ​

ReferenceCovers
TCP Command APIPersistent-connection command & control — dotted/comma syntax, Global/Composition/Timeline/CueList commands, example sessions, connecting from Medialon/Crestron/QSC/CueLab
UDP Command APIConnectionless command & control — the same command set as TCP, and when to use UDP instead
OSC ReferenceEvery OSC address Exaplay receives (transport, cues, show state, timecode, Inputs) and what it sends
Cue Script ReferenceThe lines a cue can run — dotted commands, OSC>, TCP>/UDP>, ARTNET>, WAIT>, TRACKING> and more
HTTP REST APIHTTP endpoints for transport, cues, Playlists, property values (/data), projectors, streams and Inputs
Status Push (WebSocket)The /status WebSocket: what is playing, which cue, Blank, Show Mode — pushed on change, for Companion, Q-SYS, Crestron, Node-RED and your own tools
Effects ReferenceThe in-engine visual effects — every effect id, its parameters, and the effect-name / effect.* values that set them from any protocol

If you only need a browser page that fires cues and shows status, you do not have to work at this level: Custom Web Interfaces wraps the REST API in HTML attributes.

These are detailed specifications, not tutorials — most feature and workflow pages link back here for the full command/parameter list rather than repeating it.

Exaplay 3 User Documentation