aboutsummaryrefslogtreecommitdiffhomepage
path: root/TUTORIAL.md
diff options
context:
space:
mode:
authorMAKIO135 <[email protected]>2019-01-17 10:00:25 +0100
committerMAKIO135 <[email protected]>2019-01-17 10:00:25 +0100
commit796b0388a243cb1fd3c30ffb3ed8b5a8303a471f (patch)
treef8ac1d9fd9230fb854131c51b239b0482dfbf6f1 /TUTORIAL.md
parentd90afc83a035f5f6bc6426a2d5b8d51ce4bc67f2 (diff)
downloadOrca-796b0388a243cb1fd3c30ffb3ed8b5a8303a471f.tar.gz
Orca-796b0388a243cb1fd3c30ffb3ed8b5a8303a471f.zip
remove Orca's OSC Guide
Diffstat (limited to 'TUTORIAL.md')
-rw-r--r--TUTORIAL.md54
1 files changed, 0 insertions, 54 deletions
diff --git a/TUTORIAL.md b/TUTORIAL.md
index 00bed47..5d9febc 100644
--- a/TUTORIAL.md
+++ b/TUTORIAL.md
@@ -89,57 +89,3 @@ ALSA pcm 'default' set buffer size 32768, period size 8192 bytes
```
We can see, that the program opens some ports.
In the next step will choose one of those to have ORCĪ› send its MIDI output to.
-
-## Orca's OSC Guide
-The [OSC](https://github.com/MylesBorins/node-osc) operator `=` takes one haste input that is **a string length** and locks the eastwardly ports and sends an OSC message on bang to the port `12000` on `localhost` by default and can be configured in [oscConfig.js](https://github.com/hundredrabbits/Orca/blob/master/desktop/core/bridge/oscConfig.js).
-The OSC operator `=` offers different usages, from its the most simple: `2=yo` will send `/yo` to `127.0.0.1:12000`.
-The [oscConfig.js](https://github.com/hundredrabbits/Orca/blob/master/desktop/core/bridge/oscConfig.js) file can also be modified to add predefined messages in `defs`. Each definition can take different options:
-- `path`: path to use for the OSC message
- ```js
- defs: {
- myKey: {
- path: '/Hello/Orca'
- }
- }
- ```
- `5=myKey` will send `/Hello/Orca` to `127.0.0.1:12000`
-
-- `pattern`: used to send values. Support integers, floats and strings values
- ```js
- defs: {
- A: {
- pattern: 'i' // send an integer
- },
- B: {
- pattern: 'f' // send a float (divides input value by 10)
- },
- C: {
- pattern: 's' // send a string
- }
- }
- ```
- `5=A 135` will send `/A` and the value `135` to `127.0.0.1:12000`
- `5=B 135` will send `/B` and the value `13.5` to `127.0.0.1:12000`
- `5=C 135` will send `/C` and the value `'135'` to `127.0.0.1:12000`
-
- `pattern` can also be used to send mutliple values
- ```js
- defs: {
- D: {
- pattern: 'ifs' // integer, float, string
- }
- }
- ```
- `9=D 3 12 yo` will send `/D` and the values `3`, `1.2`, `"yo"` to `127.0.0.1:12000`
-- `address` and `port`: used to configure alternate servers address or port
- ```js
- defs: {
- E: {
- address: '192.168.0.12',
- port: '6010'
- }
- }
- ```
- `1=E` will send `/E` to `192.168.0.12:6010`
-
-You can use the [oscListener.js](https://github.com/hundredrabbits/Orca/blob/master/examples/OSC/oscListener.js) to test OSC messages (needs [node-osc](https://github.com/MylesBorins/node-osc): `cd examples/OSC && npm i`). See it in action with [osc.orca](https://github.com/hundredrabbits/Orca/blob/master/examples/OSC/_osc.orca) and [oscConfig.js](https://github.com/hundredrabbits/Orca/blob/master/desktop/core/bridge/oscConfig.js).