Experimental:SocketIO DAT

From TouchDesigner Documentation
Revision as of 09:24, 21 August 2019 by Eric (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Summary
[edit]

The SocketIO DAT connects to a socket.io server at the specified URL.

Additional headers can be specified via the first input of the SocketIO DAT. This input should be in a table format with two columns, structured as name/value pairs.

The SocketIO DAT listens to specific events that the server emits. These events are added as listeners via the second input, structured as a single column of event names. Then, when the server emits these events the onReceiveEvent callback will be triggered.

The SocketIO DAT can also emit events to the server. This is done using the python emit method.

See also: WebSocket DAT, Web Client DAT

PythonIcon.pngsocketioDAT_Class


Parameters - Connect Page

Active active - When enabled, the SocketIO DAT is actively listening for events from the server, and can also emit events.  

URL url - The URL of the socket.io server.  

Verify Certificate (SSL) verifycert - Enables TLS (transport layer security) certificate verification.  


Parameters - Received Messages Page

Callbacks DAT callbacks - The Callbacks DAT will execute once for each message coming in.  

Execute from 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.

From Operator 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 Output clamp - The DAT is limited to 100 messages by default but with Clamp Output, this can be set to anything including unlimited.  

Maximum Lines maxlines - Limits the number of messages, older messages are removed from the list first.  

Clear Output clear - Deletes all lines except the heading. To clear with a python script op("opname").par.clear.pulse()  

Bytes Column bytes - Outputs the raw bytes of the message in a separate column.  


Parameters - Common Page

Language language - - Select how the DAT decides which script language to operate on.

  • Input input - The DAT uses the inputs script language.
  • Node node - The DAT uses it's own script language.

Edit/View Extension extension - - Select the file extension this DAT should expose to external editors.

  • dat dat - various common file extensions.
  • From Language language - pick extension from DATs script language.
  • Custom Extension custom - Specify a custom extension.

Custom Extension customext - Specifiy the custom extension.  

Word Wrap wordwrap - - Enable Word Wrap for Node Display.

  • Input input - The DAT uses the inputs setting.
  • On on - Turn on Word Wrap.
  • Off off - Turn off Word Wrap.


DATs
Art-Net • CHOP Execute • CHOP to • Clip • Convert • CPlusPlus • DAT •  Execute • DAT xport • Error • EtherDream • Evaluate • Examine • Execute • FIFO • File In • File Out • Folder • In • Indices • Info • Insert • Keyboard In • Lookup • Merge • MIDI Event • MIDI In • Monitors • MQTT Client • Multi Touch In • NDI • Null • OP Execute • OP Find • OSC In • OSC Out • Out • Panel Execute • Parameter • Parameter Execute • Perform • Render Pick • Reorder • Script • Select • Serial • Experimental:SocketIO • SOP to • Sort • Substitute • Switch • Table • TCP/IP • Text • Touch In • Touch Out • Transpose • TUIO In • UDP In • UDP Out • UDT In • UDT Out • Experimental:Web Client • Web • Experimental:Web Server • WebSocket • XML

An Operator Family that manipulates text strings: multi-line text or tables. Multi-line text is often a command Script, but can be any multi-line text. Tables are rows and columns of cells, each containing a text string.

The generic thing that holds an Operator, and includes Flags (display, bypass, lock, render, immune) and its position/size in the network. Whether you "lay down an Operator" or "lay down an Node", you're doing the same thing.

Any of the procedural data operators. OPs do all the work in TouchDesigner. They "cook" and output data to other OPs, which ultimately result in new images, data and audio being generated. See Node.