Experimental:Stype Out CHOP
License: Only available in TouchDesigner Pro.
The Stype Out CHOP sends camera tracking information, including position, orientation and lens information, to an external device or program over the network using the Stype HF protocol. This can be used to emulate a physical Stype camera or to send data to another program/device that can process Stype tracking data. Data packets are sent out once per frame based on the current data in the CHOP channels. If one of the expected channels is not found in the input, then a default value will be sent.
The channels used by the Stype Out CHOP are:
- recording - 1 or 0, indicating the recording status on the Stype Kit (see Stype protocol for more information)
- focus_distance - 1 or 0, indicating how the focus field is used (see Stype protocol for more information)
- packet_number - a looping number from 0-255 indicating the packet number. By default the number is incremented each frame, but can also be generated manually (see Stype protocol for more information)
- hours, minutes, seconds, frames - timecode, may be zero if time information is not present
- tx, ty, tz - camera position, can be connected to the Camera COMP Translate parameters
- rx, ry, rz - camera rotation, can be connected to the Camera COMP Rotate parameters
- fov - camera field of view, can be connected to the Camera COMP FOV Angle parameter
- padded_fov - field of view expanded by the padding parameter, can be used in Camera COMP FOV Angle parameter
- aspect - aspect ratio of the camera
- focus - camera focus from 0 (closest) to 1 (infinite), can be used to simulate depth of field
- zoom - camera zoom from 0 (wide) to 1 (tele)
- centerx, centery - offset of the camera sensor in mm, used by the Stype TOP for calculating lens correction
- k1, k2 - radial lens distortion parameters, used by the Stype TOP for calculating lens correction
- pawidth, paheight - size of the sensor in mm, used by the Stype TOP for calculating lens correction
Parameters - Stype Out Page
active - Turn this parameter off to stop sending out data packets.
protocol - ⊞ - Selects the network protocol to use. Refer to the Network Protocols article for more information.
- Messaging (UDP)
- Multi-Cast Messaging (UDP)
netaddress - The network address of the computer to send the Stype data to. The address can be a domain name, an IP address (e.g. 100.123.45.78), or "localhost" to target the packets at another program on the same machine.
port - The port to send the data packets to.
localaddress - Specify an IP address to send from. This is useful when the system has multiple NICs (Network Interface Card) and you want to select which one to use.
timecodeop - Set the time with a reference to a timecode. A reference to either a CHOP with channels 'hour', 'second', 'minute', 'frame', a DAT with a timecode string in its first cell, or a Timecode Class object. When a timecode is not reference, the Stype CHOP will instead use 'hour', 'second', 'minute', 'frame' channels from the input CHOP.
Packet Number Source
packetnumber - ⊞ - Determine how the packet number field is generated. The packet number generally increments by 1 each frame and loops from 255 to 0.
generate- The packet number is automatically incremented by 1 each frame.
- From Channel input
input- The packet number is taken from the input CHOP.
Parameters - Common Page
timeslice - Turning this on forces the channels to be "Time Sliced". A Time Slice is the time between the last cook frame and the current cook frame.
scope - To determine which channels get affected, some CHOPs use a Scope string on the Common page. See Pattern Matching.
Sample Rate Match
srselect - ⊞ - Handle cases where multiple input CHOPs' sample rates are different. When Resampling occurs, the curves are interpolated according to the Interpolation Method Option, or "Linear" if the Interpolate Options are not available.
- Resample At First Input's Rate
first- Use rate of first input to resample others.
- Resample At Maximum Rate
max- Resample to the highest sample rate.
- Resample At Minimum Rate
min- Resample to the lowest sample rate.
- Error If Rates Differ
err- Doesn't accept conflicting sample rates.
exportmethod - ⊞ - This will determine how to connect the CHOP channel to the parameter. Refer to the Export article for more information.
- DAT Table by Index
datindex- Uses the docked DAT table and references the channel via the index of the channel in the CHOP.
- DAT Table by Name
datname- Uses the docked DAT table and references the channel via the name of the channel in the CHOP.
- Channel Name is Path:Parameter
autoname- The channel is the full destination of where to export to, such has
autoexportroot - This path points to the root node where all of the paths that exporting by Channel Name is Path:Parameter are relative to.
exporttable - The DAT used to hold the export information when using the DAT Table Export Methods (See above).
- Input 0: -