Control protocol / Reference

OSC commands

Connect Node:Cue to controllers, automation systems, and other production tools over the network.

Setup and conventions

Configure OSC input in Configuration > OSC. Add a receive endpoint, select the network interface, set its port, then send commands to that IP address and port.

  • Addresses are lowercase and start with /nodecue.
  • Values are sent as OSC arguments.
  • A first trigger argument of false, 0, 0.0, or nil is ignored.
  • Fade commands accept an optional duration in milliseconds as their first argument.
  • Pad and bus targets can be included in the address or sent as the first argument.

Cuelist

ActionRecommended addressAccepted aliasesArguments
Play armed cue/nodecue/cuelist/go/nodecue/cue/go, /nodecue/cues/go, play variantsOptional trigger
Stop cuelist playback/nodecue/cuelist/stop/nodecue/cue/stop, /nodecue/cues/stop_allOptional trigger
Pause / resume/nodecue/cuelist/pause/nodecue/cue/pause, resume and pause_resume variantsOptional trigger
Previous cue/nodecue/cuelist/back/nodecue/cuelist/previous, cue and cues variantsOptional trigger
Next cue/nodecue/cuelist/next/nodecue/cue/next, /nodecue/cues/nextOptional trigger
Fade out cuelist/nodecue/cuelist/fade_out/nodecue/cue/fade_out, /nodecue/cuelist/fade/outOptional duration, trigger

Pads

ActionRecommended addressAccepted aliasesArguments
Play pad by address/nodecue/pads/play/{pad_id}/nodecue/pad/play/{pad_id}Optional trigger
Play pad by argument/nodecue/pads/play/nodecue/pad/playpad_id, optional trigger
Stop pads playback/nodecue/pads/stop/nodecue/pad/stop, stop_all variantsOptional trigger
Pause / resume/nodecue/pads/pause/nodecue/pad/pause, resume and pause_resume variantsOptional trigger
Fade out pads/nodecue/pads/fade_out/nodecue/pad/fade_out, /nodecue/pads/fade/outOptional duration, trigger

Playlist

ActionRecommended addressAccepted aliasesArguments
Play selected track/nodecue/playlist/go/nodecue/playlist/playOptional trigger
Pause / resume/nodecue/playlist/pauseresume and pause_resume variantsOptional trigger
Stop playback/nodecue/playlist/stop-Optional trigger
Previous track/nodecue/playlist/back/nodecue/playlist/previousOptional trigger
Next track/nodecue/playlist/next-Optional trigger
Fade out playlist/nodecue/playlist/fade_out/nodecue/playlist/fade/outOptional duration, trigger

Global transport

ActionRecommended addressAccepted aliasesArguments
Stop all playback / panic/nodecue/panic/nodecue/stop_allOptional trigger
Fade out all playback/nodecue/global/fade_out/nodecue/fade_outOptional duration, trigger

Bus control

Bus IDs are zero-based: 0 Cuelist, 1 Pads, and 2 Playlist.

ActionRecommended addressAccepted aliasesArguments
Toggle mute by address/nodecue/bus/mute/{bus_id}/nodecue/bus/{bus_id}/mute and toggle variantsOptional trigger
Toggle mute by argument/nodecue/bus/mute/nodecue/bus/mute/togglebus_id, optional trigger

Examples

Play the armed Cuelist cue

/nodecue/cuelist/go

Play Pad 7

/nodecue/pads/play/7

Fade out all playback over 3 seconds

Address: /nodecue/global/fade_out
Argument: 3000

Toggle mute on the Pads bus

/nodecue/bus/mute/1