API reference
OSC API
Open Sound Control addresses for triggering content, controlling outputs, and receiving state broadcasts.
Open Sound Control addresses for controlling Lightpath and receiving state
broadcasts. Two channels: input messages received by Lightpath, output
messages broadcast by Lightpath.
| Channel | Default port | Where to configure |
|---|
| Input | 8000 | Integrations → Incoming control → OSC input — one port for the whole install |
| Output | per destination | Integrations → OSC — each destination carries its own address and port |
Trigger content by sending OSC messages to the Lightpath server.
| Address | Args | Description |
|---|
/lightpath/content/<contentName> | [1] | Trigger content by name in the address path. Type (look/sequence/scene/playlist) is auto-detected. Case-insensitive, ignores special characters. |
/lightpath/content | ["contentName"] | Trigger content by string argument. Supports full names with spaces. |
Content you trigger stays on an output until the schedule next changes it: an
event starting there, or an event that was playing there ending. The project's
Default Content doesn't replace it in the meantime.
A scheduled event comes first. Triggering content skips any output an event is
playing on right now, and plays on the rest; if an event is playing on all of
them, nothing plays. Skips are written to the log. To play over an event
anyway, take the output off the schedule first, from the Controller's
Schedule section or over the HTTP API.
Execute actions and set toggle states.
| Address | Args | Description |
|---|
/lightpath/action/<name> | [1] | Execute an action by name in the address path |
/lightpath/action | ["actionName"] | Execute an action by string argument: its ID or its name. The ID keeps working after the action is renamed. |
/lightpath/action/<name>/state | [0 or 1] | Set a toggle action to a specific state |
Brightness and power state.
| Address | Args | Description |
|---|
/lightpath/<output>/brightness | [0.0 – 1.0] | Set output brightness. Values > 1 are divided by 100. Case-insensitive. |
/lightpath/<output>/enabled | [0 or 1] | Power toggle: 1 = enabled, 0 = disabled |
| Address | Args | Description |
|---|
/lightpath/<output>/playlist/pause | [] | Pause the playlist on this output |
/lightpath/<output>/playlist/resume | [] | Resume the playlist on this output |
/lightpath/<output>/playlist/stop | [] | Stop the playlist on this output |
/lightpath/<output>/playlist/next | [] | Advance to the next track |
/lightpath/<output>/playlist/prev | [] | Go to the previous track |
/lightpath/<output>/playlist/track | [trackIndex] | Jump to a specific track (0-based) |
/lightpath/<output>/playlist/loop | [] | Toggle loop mode |
The global playlist is the scene rotation.
| Address | Args | Description |
|---|
/lightpath/playlist/pause | [] | Pause the global playlist |
/lightpath/playlist/resume | [] | Resume the global playlist |
/lightpath/playlist/stop | [] | Stop the global playlist |
/lightpath/playlist/track | [trackIndex] | Jump to a specific track |
/lightpath/playlist/loop | [] | Toggle global playlist loop |
| Address | Args | Description |
|---|
/lightpath/stop | [] | Stop all playback across all outputs |
Accept Resolume clip-connect messages.
| Address | Args | Description |
|---|
/composition/layers/<layer>/clips/<clip>/connect | [3] | Resolume clip-connect format. Triggers on value 3 ("selected"). Requires custom mapping. |
/lightpath/resolume/content/<contentName> | [1] | Alternative Resolume-compatible addressing |
Broadcasting can be toggled in install settings.
| Address | Args | Description |
|---|
/lightpath/content/<normalizedName> | [1] | Normalized content name (lowercase, no special chars) |
/lightpath/content | ["Content Name"] | Full content name with original formatting |
/lightpath/resolume/content/<normalizedName> | [1] | Resolume-compatible output format |
| Address | Args | Description |
|---|
/lightpath/content/<normalizedName> | [0] | Content name with value 0 indicating stop |
/lightpath/content/stop | ["Content Name"] | Stop event with full content name |
Disabled by default — can be high-frequency during transitions.
| Address | Args | Description |
|---|
/lightpath/<output>/brightness | [0.0 – 1.0] | Output brightness value |
Pause, resume, and stop state changes.
| Address | Args | Description |
|---|
/lightpath/<output>/playlist/state | [0 | 1 | -1] | Per-output state: 0 = paused, 1 = playing, -1 = stopped |
/lightpath/playlist/state | ["outputName", "state"] | State with output name and state string |
/lightpath/playlist/global/state | [0 | 1 | -1] | Global playlist state |
| Address | Args | Description |
|---|
/lightpath/<output>/playlist/track | [trackIndex] | Per-output track change (0-based) |
/lightpath/playlist/track | ["outputName", trackIndex, "trackName"] | Track change with full details |
/lightpath/playlist/global/track | [trackIndex, "sceneName"] | Global playlist track change |
| Address | Args | Description |
|---|
/lightpath/<output>/enabled | [0 or 1] | Output power state |
| Address | Args | Description |
|---|
/lightpath/action/<normalizedName> | [1] or [0 | 1] | Action executed. For toggle actions, includes state. |
/lightpath/action | ["Action Name", 1] | Action with full name and state |
