OSC Remote Control

CueCollab can be controlled remotely via OSC (Open Sound Control) messages.
This allows integration with external tools, consoles, and automation systems.

As per OSC standard, please mind the order of arguments when sending messages.
For example, if a message expects a string followed by an integer, sending them in reverse order may lead to unexpected behavior.

Quick Reference

Announcement

Address	Arguments	Description
/announcement/show	message, type, scope, showDuration, autoClose, allowClose	Send an announcement
/announcement/clear	—	Dismiss current announcement

Environment

Address	Arguments	Description
/environment/scene	name	Set current scene name

Notepad

Address	Arguments	Description
/notepad/create	text, author, list, timecode, scene	Create a notepad entry

Recording

Address	Arguments	Description
/recording/start	—	Start recording
/recording/stop	—	Stop recording
/recording/autopilot	enabled	Enable or disable Recording Autopilot
/recording/schedule	enabled	Enable or disable Recording Schedule
/recording/autostart	enabled	Enable or disable Recording Autopilot (deprecated)

Timecode

Address	Arguments	Description
/timecode/jump	timecode	Jump to a timecode
/timecode/trigger	timecode	Trigger a timecode

---

Announcement

/announcement/show

Sends an announcement to all connected clients. The announcement appears as an overlay on the targeted views and can be configured to auto-close or require manual dismissal.

#	Name	Type	Required	Default	Description
1	message	string	yes	—	The announcement message text
2	type	string	no	"blue"	Color style: blue, green, yellow, or red
3	scope	string	no	"user,admin,displays"	Comma-separated list of targets: user, admin, displays, recording
4	showDuration	number	no	300	How long the announcement remains active, in seconds
5	autoClose	number	no	0	Auto-dismiss after this many seconds on the client (0 = no auto-close)
6	allowClose	boolean	no	true	Whether the user can manually close the announcement

Send a simple announcement to everyone

/announcement/show "Half hour call"

Send an urgent red announcement to all views

/announcement/show "STOP - Safety check" "red"

Send a green announcement to displays only, auto-closing after 10 seconds

/announcement/show "Beginners please" "green" "displays" 300 10

Send a non-dismissable announcement to all views

/announcement/show "Do not start — director on stage" "red" "user,admin,displays,recording" 600 0 false

/announcement/clear

Dismisses the currently active announcement on all connected clients immediately.

Clear all announcements

/announcement/clear

---

Environment

/environment/scene

Sets the current scene name.

#	Name	Type	Required	Default	Description
1	name	string	yes	—	The name of the current scene

Set the current scene name

/environment/scene "Scene 1"

---

Notepad

/notepad/create

Creates a new notepad entry with the given text and optional metadata.

#	Name	Type	Required	Default	Description
1	text	string	yes	—	The content of the notepad entry
2	author	string	no	""	The author of the entry
3	list	string	no	""	The list to add the entry to
4	timecode	string	no	"?"	Timecode in HH:MM:SS:FF format, "" for generic, or "?" to use current
5	scene	string	no	"?"	Scene name, "" for empty, or "?" to use current

Create a notepad entry at current timecode

/notepad/create "This is a note"

Create a notepad entry at current timecode with author and list

/notepad/create "This is a note" "Alice" "Lights"

Create a notepad entry with a specific timecode

/notepad/create "This is a note" "Alice" "Lights" "01:02:03:04"

Create a notepad entry in the generic section without a list

/notepad/create "This is a note" "Alice" "" ""

---

Recording

/recording/start

Starts the recording.

Start recording

/recording/start

/recording/stop

Stops the recording.

Stop recording

/recording/stop

/recording/autopilot

Enables or disables the Recording Autopilot. When enabled, recording starts and stops automatically based on timecode.

#	Name	Type	Required	Default	Description
1	enabled	boolean	yes	—	true or 1 to enable, false or 0 to disable

Enable Autopilot

/recording/autopilot true

Disable Autopilot

/recording/autopilot false

/recording/schedule

Enables or disables the Recording Schedule. When enabled, all configured schedules are active and will trigger start/stop at their configured times.

#	Name	Type	Required	Default	Description
1	enabled	boolean	yes	—	true or 1 to enable, false or 0 to disable

Enable the Recording Schedule

/recording/schedule true

Disable the Recording Schedule

/recording/schedule false

/recording/autostart

Deprecated

/recording/autostart is deprecated for consistency and will be removed in v1.
Use /recording/autopilot instead — it has identical behavior.

Enables or disables the auto-start recording feature.

#	Name	Type	Required	Default	Description
1	enabled	boolean	yes	—	true or 1 to enable, false or 0 to disable

---

Timecode

/timecode/jump

Jumps to a specific timecode position (including selecting the range) without triggering it.
This updates the current timecode display but does not trigger any other action like recording or callsheet jumps.

This command will only be executed if no other timecode source is currently active. If a timecode source is active, this command will be ignored to prevent conflicts.

#	Name	Type	Required	Default	Description
1	timecode	string	yes	—	Timecode in HH:MM:SS:FF format

Jump to 1 hour, 2 minutes, 3 seconds, frame 4

/timecode/jump "01:02:03:04"

/timecode/trigger

The equivalent to playing a single-frame timecode at the specified position.
This will trigger recording if configured and a jump in the callsheet.

This command will only be executed if no other timecode source is currently active. If a timecode source is active, this command will be ignored to prevent conflicts.

#	Name	Type	Required	Default	Description
1	timecode	string	yes	—	Timecode in HH:MM:SS:FF format

Trigger timecode at 1 hour, 2 minutes, 3 seconds, frame 4

/timecode/trigger "01:02:03:04"