This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
beyond:osc_commands [2020/01/10 13:32] Bob Varkevisser [OSC to Script servers] |
beyond:osc_commands [2020/01/21 15:03] Bob Varkevisser [OSC to Object server] |
||
---|---|---|---|
Line 6: | Line 6: | ||
===== OSC Message ===== | ===== OSC Message ===== | ||
- | |||
OSC Message contains 3 parts: | OSC Message contains 3 parts: | ||
Line 15: | Line 14: | ||
As example, for control of master position. | As example, for control of master position. | ||
- | ===== Supported Argument types ===== | + | |
+ | ===== OSC in Object tree ===== | ||
+ | |||
+ | To find OSC commands/ | ||
+ | Open up the tools menu and click object tree to make it visible. | ||
+ | |||
+ | {{: | ||
+ | |||
+ | Once the Object tree is visible, you are able to browse the tree it self by double clicking on items. | ||
+ | |||
+ | {{: | ||
+ | |||
+ | Once you clicked on an address or command you can take the command from the OSC address bar and use that on various locations. | ||
+ | |||
+ | The OSC address bar with command is highlighted in the example below. | ||
+ | |||
+ | {{: | ||
+ | |||
+ | This OSC address can be used in many locations. | ||
+ | |||
+ | - Internally in the Pangoscript editor | ||
+ | - In BEYOND Universe | ||
+ | - At the midi controller configuration panels | ||
+ | - In third-party OSC applications like Lemur, TouchOSC etc. | ||
+ | |||
+ | Note that not all third-party OSC applications will process OSC as they should. | ||
+ | A known issue is that TouchOSC is not able to process OSC commands to use the | ||
+ | cue grid to its full potential. | ||
+ | |||
+ | |||
+ | ===== OSC to PangoScript GATEWAY ===== | ||
+ | |||
+ | |||
+ | Server transform the OSC message to the command first and then the command goes to execution. The command appear in the system in the same way as it could be from the keyboard, or the mouse. This kind of servers also has fixed address and corresponding set of arguments. Actually, the address of such OSC server is a way to describe BEYOND command. And it was main intention - to give OSC the ability to do the same what the Script can do. Both parts (OSC and Script) produce a Command at the end, and why not to mix both worlds. | ||
+ | |||
+ | Address of message and number of arguments should correspond to the PangoScript command. Available following addressing: | ||
+ | |||
+ | / | ||
+ | / | ||
+ | / | ||
+ | / | ||
+ | / | ||
+ | / | ||
+ | |||
+ | " | ||
+ | |||
+ | The " | ||
+ | |||
+ | |Address|Type|Commentary| | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |/ | ||
+ | |||
+ | |||
+ | |||
+ | ==== Supported Argument types ==== | ||
BEYOND support integer number (i), float point number (f), and string (s). Other data types ignored. You need to ensure that OSC client send correct type of argument to BEYOND. | BEYOND support integer number (i), float point number (f), and string (s). Other data types ignored. You need to ensure that OSC client send correct type of argument to BEYOND. | ||
Line 44: | Line 226: | ||
/ | / | ||
- | ===== Direct servers | + | ===== Other OSC Servers ===== |
+ | ==== Direct servers ==== | ||
This kind of server provide a direct access to internal object of BEYOND. No extra layers, or something in between. BEYOND receive the OSC packet, analyze the address and if the address point on direct server, the BEYOND execute it right after the address parsing. Such servers has fixed address part and number of arguments. | This kind of server provide a direct access to internal object of BEYOND. No extra layers, or something in between. BEYOND receive the OSC packet, analyze the address and if the address point on direct server, the BEYOND execute it right after the address parsing. Such servers has fixed address part and number of arguments. | ||
Line 187: | Line 370: | ||
" | " | ||
- | ===== OSC to PangoScript GATEWAY ===== | ||
- | |||
- | Server transform the OSC message to the command first and then the command goes to execution. The command appear in the system in the same way as it could be from the keyboard, or the mouse. This kind of servers also has fixed address and corresponding set of arguments. Actually, the address of such OSC server is a way to describe BEYOND command. And it was main intention - to give OSC the ability to do the same what the Script can do. Both parts (OSC and Script) produce a Command at the end, and why not to mix both worlds. | ||
- | |||
- | Address of message and number of arguments should correspond to the PangoScript command. Available following addressing: | ||
- | |||
- | / | ||
- | / | ||
- | / | ||
- | / | ||
- | / | ||
- | / | ||
- | |||
- | " | ||
- | |||
- | The " | ||
- | |||
- | |Address|Type|Commentary| | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
- | |/ | ||
Line 453: | Line 487: | ||
What commands can be served by /cue/ server? The most definitely is the Live Control group commands, and FX. The command like cue start, or cue stop, is an area of /general/ server | What commands can be served by /cue/ server? The most definitely is the Live Control group commands, and FX. The command like cue start, or cue stop, is an area of /general/ server | ||
- | |||
- | ==== OSC to Object server ==== | ||
- | |||
- | |||
- | Address of server start from prefix /object . After this follow name of object and finally the name of property. As example, we have object Main Graphics (projection zone) and it has property SizeX. The address for access is | ||
- | / | ||
- | The message must comes with one value (argument). It could be string or number. | ||