Skip to content

Commit bfb0e4a

Browse files
committed
Tweak OSC documentation
Signed-off-by: falkTX <[email protected]>
1 parent 2ae3cf4 commit bfb0e4a

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

docs/OSC-REMOTE-CONTROL.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,33 @@
33
OSC (Open Sound Control) is a protocol commonly used for remote control over the network.
44
Starting with version 23.09, Cardinal allows remote control of the entire patch/project and individual parameters through OSC.
55

6+
Please note **OSC Remote Control is not available when using Cardinal as a plugin**, only in standalone.
7+
68
## Activating remote control
79

810
Make sure you are using version 23.08 or later of Cardinal, start up the standalone (both Native and JACK variants will work) and under "Engine" menu click on "Enable OSC remote control".
911

10-
NOTE: This option is not available when using Cardinal as a plugin, only in standalone.
11-
1212
![screenshot](Docs_Remote-Control-1.png "Screenshot")
1313

1414
This will ask you for which network port to use, Cardinal will default to 2228.
1515
Valid range is typically between 1025 and 32767.
1616
If unsure just stick the default value.
1717

18-
Depending on the OS security features you might be asked to allow network usage at this point.
19-
2018
![screenshot](Docs_Remote-Control-2.png "Screenshot")
2119

20+
Depending on the OS security features you might be asked to allow network usage at this point.
2221
If all went well opening the "Engine" menu again should show a checkmark, indicating that OSC remote control is enabled.
2322

2423
For the moment there is no error dialog or information in case things go wrong.
2524
If you are unable to connect, make sure your OS network firewall settings allows opening port 2228.
2625

26+
## TouchOSC example setup
27+
28+
A TouchOSC compatible file is available [here](https://github.com/DISTRHO/Cardinal/raw/main/patches/touchosc/24-direct-fader-params.tosc).
29+
30+
It maps Cardinal's 24 parameters into 3 pages of sliders, 8 per page, each with a different color.
31+
Inside Cardinal the Host Parameters and Host Parameters Map modules can be used as a way to control module knobs and other controls with it.
32+
2733
## Available messages
2834

2935
The following OSC messages are available:
@@ -54,4 +60,4 @@ NOTE: the first argument must of be int64 type, as regular 32-bit integer is not
5460
Sending a `/load` message will load the patch file contained in the message.
5561
Patch contents must be in compressed format, not plain-text json.
5662

57-
Cardinal reply back indicating either success or failure, using `/resp` path and "load" message.
63+
Cardinal replies back indicating either success or failure, using `/resp` path and "load" message.

0 commit comments

Comments
 (0)