Difference between revisions of "OSC In DAT"
|Line 112:||Line 112:|
|parSummary=To reduce which
|parSummary=To reduce which are generated, you can use name patterns to include or exclude . For example, <code>^*accel*</code> will exclude accelerometer coming in from an iOS or iPhone app like mrmr. See [[Pattern Matching]] for the syntax of the possible name patterns.
Latest revision as of 19:52, 24 February 2020
The OSC In DAT receives and parses full Open Sound Control packets using UDP by default. Each packet is parsed and appended as a row in the DAT's table. The table is FIFO "fisrt-in first-out" and limited to parameter-set number of lines. An optional script may be run for each packet received. Each packet/row represents either one OSC message, or an entire OSC bundle. Each argument is translated into readable ASCII text.
The supported argument tag types are:
- i int32
- f float32
- s OSC-string
- b OSC-blob
- h 64 bit big-endian two's complement integer
- t OSC-timetag
- d 64 bit ("double") IEEE 754 floating point number
- S alternate type represented as an OSC-string
- c ASCII character
- r 32 bit RGBA color
- m 4 byte MIDI message
- T True
- F False
- N Nil
- I Infinitum
- [ Beginning of an array
- ] End of an array
In the case of multi-vectored arguments (example "blob", "midi", "rgb", etc), the list of values is enclosed in double quotes. In the case of unknown argument types, a quoted list of decimal values representing the bytes of that argument are included instead.
NOTE for Windows OS - If experiencing connection issues make sure Windows Firewall is disabled.
Parameters - Connect Page
protocol - ⊞ - Select which protocol to use, refer to the Network Protocols article for more information.
- Messaging (UDP)
- Multi-Cast Messaging (UDP)
- Reliable Messaging (UDT Library)
address - For multi-cast protocol, this is the multi-cast address to listen for. For UDT protocol this is the IP address of the server.
port - The port which OSC-In will accept packets on.
shared - Use the same connection as other networking DATs using the same network protocol.
active - While on, the DAT receives information sent to the network port. While Off, no updating occurs. Data sent to the port is lost.
OSC Address Scope
addscope - To reduce which message are generated, you can use message address name patterns to include or exclude messages. For example,
^*accel* will exclude accelerometer messages coming in from an iOS or iPhone app like mrmr. See Pattern Matching for the syntax of the possible address name patterns.
Include Type Tag
typetag - Includes the argument list type tag in each message. It includes the parameter type keywords (in case the parsing application needs to identify parameter types).
Split Bundle into Messages
Split Message into Columns
Bundle Timestamp Column
Parameters - Received Messages Page
callbacks - The Callbacks DAT will execute once for each message received. See oscinDAT_Class for usage.
executeloc - ⊞ - Determines the location the script is run from.
- Current Node
current- The script is executed from the current node location.
- Callbacks DAT
callbacks- The script is executed from the location of the DAT specified in the Callbacks DAT parameter.
- Specified Operator
op- The script is executed from the operator specified in the From Operator parameter below.
fromop - The operator whose state change will trigger the DAT to execute its script when Execute from is set to Specified Operator. This operator is also the path that the script will be executed from if the Execute From parameter is set to Specified Operator.
clamp - The DAT is limited to 100 messages by default but with Clamp Output, this can be set to anything including unlimited.
maxlines - Limits the number of messages, older messages are removed from the list first.
clear - Deletes all lines except the heading. To clear with a python script
bytes - Outputs the raw bytes of the message in a separate column.
Parameters - Common Page
language - ⊞ - Select how the DAT decides which script language to operate on.
input- The DAT uses the inputs script language.
node- The DAT uses it's own script language.
extension - ⊞ - Select the file extension this DAT should expose to external editors.
dat- various common file extensions.
- From Language
language- pick extension from DATs script language.
- Custom Extension
custom- Specify a custom extension.
customext - Specifiy the custom extension.
wordwrap - ⊞ - Enable Word Wrap for Node Display.
input- The DAT uses the inputs setting.
on- Turn on Word Wrap.
off- Turn off Word Wrap.
- Input 0 -
|• • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • •|
A parameter in most CHOPs that restricts which channels of that CHOP will be affected. Normally all channels of a CHOP are affected by the operator.
Each operator can have a set of text strings that are its "tags". You can set them and search for them within TouchDesigner.