Controlling / Network, Database Modules

2026-MAY-11 Author: Aximmetry

Introduction

This document describes the built-in Flow Graph modules of the following categories for compounds:

Controlling / Network - Modules that exchange data over network protocols, including TCP, UDP, HTTP, OSC-style messaging, and tracking links.
Controlling / Database - Modules that read, write, and transform structured data, files, and collection payloads for storage workflows.

Controlling / Network

This section describes the built-in Flow Graph modules that exchange data over network protocols, including TCP, UDP, HTTP, OSC-style messaging, and tracking links.

Body Tracking

Category: Controlling / Network
Access: All editions.
Function: Consumes body-tracking protocol data and outputs tracking results.
Input pins:
- ⏺ Engine (integer, Engine) - Selects which machine runs this module in a multi-machine setup (All selects every machine). On other machines the module stays idle and does not open the selected body-tracking device.
- ⏺ Device (text) - Body-tracking device to read frames from.
- ⏺ Receive (logical) - When on, opens the selected device and reads tracking frames.
- ⏺ Immediate (logical) - When on, reads the latest frame immediately without sync delay.
- ⏺ Timecode Sync (logical) - When on, reads frames by matching RefTimecode when timecode is detected.
- ⏺ Ref Timecode (integer) - Reference timecode used for synchronized frame lookup.
- ⏺ Delay (double precision scalar) - Additional read delay applied when synchronized or delayed reading is used.
- ⏺ Detail (integer, Body Tracking Detail) - Tracking detail level requested from the body-tracking device.
Output pins:
- ⏺ Center (vector) - Tracked body center position.
- ⏺ Head (vector) - Tracked head position.
- ⏺ Points (vector) - Tracked point positions as a flat vector of XYZ values.
- ⏺ Bones (vector) - Tracked bone connections as point-index pairs.
- ⏺ Named Points (collection) - Tracked points keyed by their point names.
- ⏺ Stability (scalar) - Tracking stability value reported by the device.
- ⏺ TC Detected (logical) - On when timecode is detected on incoming frames.
- ⏺ Timecode (integer) - Timecode of the current output frame.
- ⏺ Frame Index (integer) - Frame index of the current output frame.
- ⏺ Timestamp (double precision scalar) - Timestamp of the current output frame.
- ⏺ Time Delta (double precision scalar) - Difference between input timing and synchronized output timing.
- ⏺ Sync Delta (double precision scalar) - Current synchronization offset used by timecode syncing.
- ⏺ Buffer Level (integer) - Number of buffered frames available in the sync reader.

Camera Controller

Category: Controlling / Network
Access: All editions.
Function: Sends camera control commands over a network link using values from its inputs.
Input pins:
- ⏺ Engine (integer, Engine) - Selects which machine runs this module in a multi-machine setup (All selects every machine). On other machines the module stays idle and does not open the selected camera-controller device.
- ⏺ Device (text) - Camera-controller device that receives command packets.
- ⏺ Open (logical) - When on, opens the selected camera-controller device.
- ⏺ Command Bytes (vector) - Command packet to send, where each vector element represents one byte value from 0 to 255.
- ⏺ Priority (integer) - Execution priority used when sending commands within the frame.
- ⏺ Auto Send (logical) - When on, sends automatically when CommandBytes changes.
- ⏺ Send (trigger) - Sends the current command packet once.
Output pins:

Camera Tracking

Category: Controlling / Network
Access: All editions.
Function: Consumes camera-tracking protocol data and exposes pose and lens data.
Input pins:
- ⏺ Engine (integer, Engine) - Selects which machine runs this module in a multi-machine setup (All selects every machine). On other machines the module stays idle and does not open the selected camera-tracking device.
- ⏺ Device (text) - Camera-tracking device that provides position and lens frames.
- ⏺ Calibration Profile (text) - Calibration profile used to map incoming raw sensor data to physical lens data.
- ⏺ Zoom Device (text) - Optional zoom-encoder device used as a separate lens-data source.
- ⏺ Receive (logical) - When on, opens the selected tracking devices and reads frames.
- ⏺ Immediate (logical) - When on, reads the latest frames immediately without sync delay.
- ⏺ Timecode Sync (logical) - When on, synchronizes camera-tracking frames to RefTimecode when timecode is detected.
- ⏺ Zoom Timecode Sync (logical) - When on, synchronizes zoom-device frames to RefTimecode when timecode is detected.
- ⏺ Ref Timecode (integer) - Reference timecode used for synchronized frame lookup.
- ⏺ Delay (double precision scalar) - Timing delay applied to camera-tracking frame synchronization.
- ⏺ Zoom Delay (double precision scalar) - Timing delay applied to zoom-device frame synchronization.
- ⏺ External Lens Data (logical) - When on, keeps lens data coming from the tracked frame instead of recalculating it from the calibration profile.
- ⏺ Override Lens Data (logical) - When on, uses LensData to override the computed lens-data output values.
- ⏺ Lens Data (vector) - Lens-data vector used when OverrideLensData is on.
- ⏺ Override Sensor Width (logical) - When on, uses SensorWidth to override the output sensor width.
- ⏺ Sensor Width (scalar) - Manual sensor width value used when OverrideSensorWidth is on.
- ⏺ Raw Override (logical) - When on, applies Zoom, Focus, and Aperture overrides to raw sensor values before lens-data conversion.
- ⏺ Override Zoom (logical) - When on, uses Zoom as an override value.
- ⏺ Zoom (scalar) - Manual zoom value used when OverrideZoom is on.
- ⏺ Override Focus (logical) - When on, uses Focus as an override value.
- ⏺ Focus (scalar) - Manual focus value used when OverrideFocus is on.
- ⏺ Override Aperture (logical) - When on, uses Aperture as an override value.
- ⏺ Aperture (scalar) - Manual aperture value used when OverrideAperture is on.
- ⏺ Fwd To Remotes (logical) - When on, forwards tracking frames from the primary machine to remote machines.
- ⏺ Fwd Port (integer) - Network port used for forwarded tracking packets.
- ⏺ Fwd Aux Targets (text) - Additional forwarding target host names or IP addresses separated with semicolons.
- ⏺ Fwd Format (integer, Tracking Send Format) - Packet format used when forwarding tracking data to remotes.
- ⏺ Fwd Master TC (logical) - When on, forwarded packets use Master Timecode; when off, they use the next input-frame timecode.
- ⏺ Data Stream (data stream reference) - Optional data-stream source used for playback and recording of tracking frames.
- ⏺ Data Channel (text) - Data-stream channel name used for camera-tracking recording and playback.
Output pins:
- ⏺ Camera ID (integer) - Camera identifier from the current tracking frame.
- ⏺ Cam Transform (transformation) - Final camera transformation after calibration and zoom-device composition.
- ⏺ Zoom Factor (scalar) - Computed camera zoom factor.
- ⏺ Aspect (scalar) - Lens aspect ratio from the active lens data.
- ⏺ Focus Distance (scalar) - Computed focus distance from the active lens data.
- ⏺ Aperture (scalar) - Active aperture value after overrides.
- ⏺ Lens Data (vector) - Active lens-data vector after processing and overrides.
- ⏺ Device State (integer) - Current state code of the main camera-tracking device.
- ⏺ Zoom Device State (integer) - Current state code of the zoom device.
- ⏺ Pos Available (logical) - On when valid position data is available from the main tracker.
- ⏺ Zoom Available (logical) - On when valid zoom and lens sensor data is available.
- ⏺ Stability (scalar) - Tracking stability value from the current frame.
- ⏺ Native Transf (transformation) - Raw transformation before tracking-space adjustment.
- ⏺ Sensor Width (scalar) - Active sensor width after lens processing and overrides.
- ⏺ Eye Point Offset (scalar) - Eye-point offset from the active lens description.
- ⏺ Zoom Sensor (scalar) - Current raw zoom-sensor reading.
- ⏺ Focus Sensor (scalar) - Current raw focus-sensor reading.
- ⏺ Iris Sensor (scalar) - Current raw iris-sensor reading.
- ⏺ Custom Sensors (vector) - Additional custom sensor values from the tracking frame.
- ⏺ Raw Packet (vector) - Raw main-tracker packet bytes, where each vector element represents one byte value from 0 to 255.
- ⏺ Zoom Raw Packet (vector) - Raw zoom-device packet bytes, where each vector element represents one byte value from 0 to 255.
- ⏺ TC Detected (logical) - On when timecode is detected on main tracking input.
- ⏺ Timecode (integer) - Timecode of the current output tracking frame.
- ⏺ Frame Index (integer) - Frame index of the current output tracking frame.
- ⏺ Timestamp (double precision scalar) - Timestamp of the current output tracking frame.
- ⏺ Time Delta (double precision scalar) - Difference between input timing and synchronized output timing.
- ⏺ Sync Delta (double precision scalar) - Current synchronization offset used by timecode syncing.
- ⏺ Buffer Level (integer) - Number of buffered frames available in the main sync reader.

HTTP Request

Category: Controlling / Network
Access: Broadcast & Film Edition required.
Function: Sends HTTP GET or POST requests and outputs the returned text, image, and request state.
Input pins:
- ⏺ URL (text) - Target URL to request.
- ⏺ Headers (text) - Request headers as text lines.
- ⏺ Post (logical) - When on, sends a POST request; when off, sends a GET request.
- ⏺ Post Data (text) - Request body text used for POST requests.
- ⏺ Resolve Timeout (scalar) - DNS resolve timeout in seconds.
- ⏺ Connect Timeout (scalar) - Connection timeout in seconds.
- ⏺ Send Timeout (scalar) - Request-send timeout in seconds.
- ⏺ Receive Timeout (scalar) - Response-receive timeout in seconds.
- ⏺ Request (trigger) - Starts a request once.
- ⏺ Abort (trigger) - Aborts the currently running request.
- ⏺ Auto Request (logical) - When on, repeats requests automatically at AutoInterval.
- ⏺ Auto Interval (scalar) - Interval in seconds between automatic requests.
Output pins:
- ⏺ Text (text) - Response body text from the last finished request.
- ⏺ Image (video) - Response image when the returned content type is an image.
- ⏺ Type (text) - Content type of the last finished response.
- ⏺ Requesting (logical) - On while a request is in progress.
- ⏺ Finished (trigger) - Pulses when a request finishes, regardless of success.
- ⏺ Succeeded (logical) - On when the last finished request succeeded.

Serial Client

Category: Controlling / Network
Access: Broadcast & Film Edition required.
Function: Opens a serial port connection and exchanges text or byte messages.
Input pins:
- ⏺ Open (logical) - Opens or closes the serial port connection.
- ⏺ Port (integer) - Serial port number to open.
- ⏺ Baud Rate (integer, Serial Baud Rate) - Baud rate used by the serial connection.
- ⏺ Parity (integer, Serial Parity) - Parity mode used by the serial connection.
- ⏺ Stop Bits (integer, Serial Stop Bits) - Stop-bit setting used by the serial connection.
- ⏺ Binary Mode (logical) - When on, sends and receives byte vectors; when off, sends and receives UTF-8 text.
- ⏺ Terminator (text) - Text terminator sequence used to split incoming and outgoing text messages.
- ⏺ Terminator Bytes (vector) - Byte terminator sequence used to split incoming and outgoing binary messages.
- ⏺ Data (text) - Text message payload to send when BinaryMode is off.
- ⏺ Data Bytes (vector) - Byte payload to send when BinaryMode is on, where each vector element represents one byte value from 0 to 255.
- ⏺ Auto Send (logical) - When on, sends the current payload automatically after data changes or reconnect.
- ⏺ Send (trigger) - Sends the current payload once.
Output pins:
- ⏺ Received (text) - Last received text message when BinaryMode is off.
- ⏺ Received Bytes (vector) - Last received byte payload when BinaryMode is on, where each vector element represents one byte value from 0 to 255.
- ⏺ Receive (trigger) - Pulses when a new message payload is received.

TCP Client

Category: Controlling / Network
Access: Broadcast & Film Edition required.
Function: Connects to a TCP server and exchanges text or byte messages.
Input pins:
- ⏺ Connect (logical) - Starts or stops the TCP client connection.
- ⏺ Hostname (text) - Target server hostname or IP address.
- ⏺ Port (integer) - Target TCP server port.
- ⏺ Binary Mode (logical) - When on, sends and receives byte vectors; when off, sends and receives UTF-8 text.
- ⏺ Terminator (text) - Text terminator sequence used to split incoming and outgoing text messages.
- ⏺ Terminator Bytes (vector) - Byte terminator sequence used to split incoming and outgoing binary messages.
- ⏺ Data (text) - Text message payload to send when BinaryMode is off.
- ⏺ Data Bytes (vector) - Byte payload to send when BinaryMode is on, where each vector element represents one byte value from 0 to 255.
- ⏺ Auto Send (logical) - When on, sends the current payload automatically after data changes or reconnect.
- ⏺ Send (trigger) - Sends the current payload once.
Output pins:
- ⏺ Received (text) - Last received text message when BinaryMode is off.
- ⏺ Received Bytes (vector) - Last received byte payload when BinaryMode is on, where each vector element represents one byte value from 0 to 255.
- ⏺ Receive (trigger) - Pulses when a new message payload is received.
- ⏺ Connected (logical) - On while the TCP client is connected to the server.

TCP Server

Category: Controlling / Network
Access: Broadcast & Film Edition required.
Function: Listens for TCP clients and exchanges text or byte messages with all connected clients.
Input pins:
- ⏺ Listen (logical) - Starts or stops TCP listening.
- ⏺ Adapter (text) - Network adapter address to bind the listening socket to.
- ⏺ Port (integer) - TCP port to listen on.
- ⏺ Binary Mode (logical) - When on, sends and receives byte vectors; when off, sends and receives UTF-8 text.
- ⏺ Terminator (text) - Text terminator sequence used to split incoming and outgoing text messages.
- ⏺ Terminator Bytes (vector) - Byte terminator sequence used to split incoming and outgoing binary messages.
- ⏺ Data (text) - Text message payload to broadcast when BinaryMode is off.
- ⏺ Data Bytes (vector) - Byte payload to broadcast when BinaryMode is on, where each vector element represents one byte value from 0 to 255.
- ⏺ Auto Send (logical) - When on, sends the current payload automatically after data changes.
- ⏺ Send (trigger) - Broadcasts the current payload once to all connected clients.
Output pins:
- ⏺ Received (text) - Last received text message when BinaryMode is off.
- ⏺ Received Bytes (vector) - Last received byte payload when BinaryMode is on, where each vector element represents one byte value from 0 to 255.
- ⏺ Receive (trigger) - Pulses when a new message payload is received from any client.
- ⏺ Listening (logical) - On while the TCP server is running and listening.
- ⏺ Connections (integer) - Current number of connected TCP clients.

UDP Receiver

Category: Controlling / Network
Access: Broadcast & Film Edition required.
Function: Listens for UDP packets and outputs incoming text or byte payloads, with optional synchronized packet reading.
Input pins:
- ⏺ Listen (logical) - Starts or stops UDP listening.
- ⏺ Adapter (text) - Network adapter address to bind the receiver socket to.
- ⏺ Port (integer) - UDP port to listen on.
- ⏺ Multicast Group (text) - Optional multicast group address to join.
- ⏺ Binary Mode (logical) - When on, outputs incoming payloads as byte vectors; when off, outputs UTF-8 text.
- ⏺ Sync Mode (logical) - When on, reads packets through synchronized frame buffering; when off, reads packets directly.
- ⏺ Sync Delay (double precision scalar) - Timing offset used when synchronized packet reading is on.
- ⏺ Fwd To Remotes (logical) - When on on the primary machine, forwards received packets to remote machines.
Output pins:
- ⏺ Received (text) - Last received text payload when BinaryMode is off.
- ⏺ Received Bytes (vector) - Last received byte payload when BinaryMode is on, where each vector element represents one byte value from 0 to 255.
- ⏺ Receive (trigger) - Pulses when a new UDP payload is received.
- ⏺ Source IP (text) - Source IP address of the last received UDP payload.
- ⏺ Source Port (integer) - Source port of the last received UDP payload.
- ⏺ Listening (logical) - On while UDP listening is active.
- ⏺ Reply With (udp reply reference) - Reply reference output for UDPSender. When connected to ReplyFor, UDPSender sends replies through the same socket opened by this UDPReceiver.

UDP Sender

Category: Controlling / Network
Access: Broadcast & Film Edition required.
Function: Sends UDP text or byte payloads to a target host or as replies to a connected UDP receiver.
Input pins:
- ⏺ Open (logical) - Opens or closes the UDP sender.
- ⏺ Hostname (text) - Target hostname or IP address for outgoing packets.
- ⏺ Port (integer) - Target UDP port for outgoing packets.
- ⏺ Binary Mode (logical) - When on, sends DataBytes; when off, sends Data as UTF-8 text.
- ⏺ Data (text) - Text payload to send when BinaryMode is off.
- ⏺ Data Bytes (vector) - Byte payload to send when BinaryMode is on, where each vector element represents one byte value from 0 to 255.
- ⏺ Auto Send (logical) - When on, sends the current payload automatically after data changes.
- ⏺ Send (trigger) - Sends the current payload once.
- ⏺ Reply For (udp reply reference) - Optional UDP-reply reference from UDPReceiver. When connected, replies are sent to the latest source through the same socket opened by that UDPReceiver.
Output pins:

URL Compose

Category: Controlling / Network
Access: Broadcast & Film Edition required.
Function: Builds a URL and header text from protocol, host, path, and parameter inputs.
Input pins:
- ⏺ Secure (logical) - When on, composes an HTTPS URL; when off, composes an HTTP URL.
- ⏺ Hostname (text) - Host name used in the composed URL.
- ⏺ Port (integer) - Explicit port for the composed URL; 0 uses the protocol default.
- ⏺ Path (text) - Path component of the composed URL.
- ⏺ Params (collection) - Query parameters as a key-value collection.
- ⏺ Headers (collection) - Header fields as a key-value collection.
- ⏺ Escape (logical) - When on, escapes URL path and parameter values.
Output pins:
- ⏺ Out (text) - Composed URL text.
- ⏺ Headers (text) - Composed HTTP header lines as text.
- ⏺ Error (logical) - On when URL composition fails due to invalid input or conversion error.

URL Decompose

Category: Controlling / Network
Access: Broadcast & Film Edition required.
Function: Parses a URL into protocol, host, path, and query-parameter outputs.
Input pins:
- ⏺ URL (text) - URL text to parse.
- ⏺ Unescape (logical) - When on, unescapes parsed path and query parameter text.
Output pins:
- ⏺ Secure (logical) - On for HTTPS URLs; off for HTTP URLs.
- ⏺ Hostname (text) - Parsed host name.
- ⏺ Port (integer) - Parsed port number.
- ⏺ Path (text) - Parsed URL path.
- ⏺ Params (collection) - Parsed query parameters as a key-value collection.
- ⏺ Error (logical) - On when URL parsing fails.

Websocket Client

Category: Controlling / Network
Access: Broadcast & Film Edition required.
Function: Connects to a WebSocket endpoint and exchanges incoming and outgoing messages.
Input pins:
- ⏺ Connect (logical) - Starts or stops the WebSocket connection.
- ⏺ URL (text) - WebSocket URL to connect to.
- ⏺ Socket IO Mode (logical) - When on, handles Socket.IO framing for incoming and outgoing text messages.
- ⏺ Binary Mode (logical) - When on, outputs incoming payloads as byte vectors; when off, outputs text.
- ⏺ Data (text) - Text payload to send when BinaryMode is off.
- ⏺ Data Bytes (vector) - Byte payload to send when BinaryMode is on, where each vector element represents one byte value from 0 to 255.
- ⏺ Auto Send (logical) - When on, sends the current payload automatically after data changes or reconnect.
- ⏺ Send (trigger) - Sends the current payload once.
Output pins:
- ⏺ Received (text) - Last received text payload when BinaryMode is off.
- ⏺ Received Bytes (vector) - Last received byte payload when BinaryMode is on, where each vector element represents one byte value from 0 to 255.
- ⏺ Receive (trigger) - Pulses when a new message payload is received.
- ⏺ Connected (logical) - On while the WebSocket connection is established.

Controlling / Database

This section describes the built-in Flow Graph modules that read, write, and transform structured data, files, and collection payloads for storage workflows.

Binary Exporter

Category: Controlling / Database
Access: All editions.
Function: Writes byte data to a binary file.
Input pins:
- ⏺ Bytes (vector) - Byte data to write, where each vector element represents one byte value from 0 to 255.
- ⏺ Output Folder (text) - Output folder used when ExactPath is empty.
- ⏺ Output File (text) - Base file name used when ExactPath is empty.
- ⏺ Auto Numbering (logical) - When on, appends a unique number to avoid overwriting an existing file.
- ⏺ Exact Path (text) - Full output path override. When set, OutputFolder and OutputFile are ignored.
- ⏺ Output Suffix (text) - Optional suffix inserted into the output file name.
- ⏺ Keep Extension (logical) - When on, keeps the extension from OutputFile if specified. Otherwise automatically appends an appropriate extension.
- ⏺ Export (trigger) - Starts writing the file once.
Output pins:
- ⏺ Exporting (logical) - On while export is running.
- ⏺ Output Path (text) - Resolved output path of the last export attempt.
- ⏺ Finished (trigger) - Pulses when export finishes.
- ⏺ Succeeded (logical) - On when the last export finished successfully.

Binary File

Category: Controlling / Database
Access: All editions.
Function: Reads byte data from a binary file.
Input pins:
- ⏺ Binary File (text) - Path of the binary file to read.
- ⏺ Open (logical) - When on, keeps the file open and updates output from it.
Output pins:
- ⏺ Out (vector) - File content as byte data, where each vector element represents one byte value from 0 to 255.

CBOR To Collection

Category: Controlling / Database
Access: All editions.
Function: Converts CBOR byte data to a collection.
Input pins:
- ⏺ Bytes (vector) - CBOR-encoded byte data to parse.
Output pins:
- ⏺ Out (collection) - Converted collection data.
- ⏺ Converting (logical) - On while conversion is in progress.
- ⏺ Finished (trigger) - Pulses when conversion finishes.
- ⏺ Succeeded (logical) - On when the last conversion succeeded.

Collection Array Count

Category: Controlling / Database
Access: All editions.
Function: Returns the item count of an array value in a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to query.
- ⏺ Key (text) - Key path of the array value to count.
Output pins:
- ⏺ Count (integer) - Number of items in the selected array value.

Collection Color

Category: Controlling / Database
Access: All editions.
Function: Reads a color value from a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to read from.
- ⏺ Key (text) - Key path of the value to read.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
- ⏺ Default (color) - Fallback value used when the selected item is missing or cannot be read as color.
Output pins:
- ⏺ Out (color) - Read color value.
- ⏺ Exists (logical) - On when the selected item exists.

Collection Double

Category: Controlling / Database
Access: All editions.
Function: Reads a double value from a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to read from.
- ⏺ Key (text) - Key path of the value to read.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
- ⏺ Default (double precision scalar) - Fallback value used when the selected item is missing or cannot be read as double.
Output pins:
- ⏺ Out (double precision scalar) - Read value converted to double.
- ⏺ Exists (logical) - On when the selected item exists.

Collection Integer

Category: Controlling / Database
Access: All editions.
Function: Reads an integer value from a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to read from.
- ⏺ Key (text) - Key path of the value to read.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
- ⏺ Default (integer) - Fallback value used when the selected item is missing or cannot be read as integer.
Output pins:
- ⏺ Out (integer) - Read integer value.
- ⏺ Exists (logical) - On when the selected item exists.

Collection Logical

Category: Controlling / Database
Access: All editions.
Function: Reads a logical value from a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to read from.
- ⏺ Key (text) - Key path of the value to read.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
- ⏺ Default (logical) - Fallback value used when the selected item is missing or cannot be read as logical.
Output pins:
- ⏺ Out (logical) - Read logical value.
- ⏺ Exists (logical) - On when the selected item exists.

Collection Merge

Category: Controlling / Database
Access: All editions.
Function: Merges two collections into one output collection.
Input pins:
- ⏺ A (collection) - First collection input.
- ⏺ B (collection) - Second collection input merged over A.
Output pins:
- ⏺ Out (collection) - Merged collection result.

Collection Null

Category: Controlling / Database
Access: All editions.
Function: Checks whether the selected collection item is null.
Input pins:
- ⏺ Collection (collection) - Source collection to read from.
- ⏺ Key (text) - Key path of the value to read.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
Output pins:
- ⏺ Out (logical) - On when the selected item is null.
- ⏺ Exists (logical) - On when the selected item exists.

Collection Scalar

Category: Controlling / Database
Access: All editions.
Function: Reads a scalar value from a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to read from.
- ⏺ Key (text) - Key path of the value to read.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
- ⏺ Default (scalar) - Fallback value used when the selected item is missing or cannot be read as scalar.
Output pins:
- ⏺ Out (scalar) - Read scalar value.
- ⏺ Exists (logical) - On when the selected item exists.

Collection Text

Category: Controlling / Database
Access: All editions.
Function: Reads a text value from a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to read from.
- ⏺ Key (text) - Key path of the value to read.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
- ⏺ Default (text) - Fallback value used when the selected item is missing or cannot be read as text.
Output pins:
- ⏺ Out (text) - Read text value.
- ⏺ Exists (logical) - On when the selected item exists.

Collection To CBOR

Category: Controlling / Database
Access: All editions.
Function: Converts a collection to CBOR byte data.
Input pins:
- ⏺ Collection (collection) - Source collection to serialize.
- ⏺ Async Processing (logical) - When on, performs conversion asynchronously.
Output pins:
- ⏺ Out (vector) - Serialized CBOR byte data.
- ⏺ Converting (logical) - On while conversion is in progress.
- ⏺ Finished (trigger) - Pulses when conversion finishes.

Collection To JSON

Category: Controlling / Database
Access: All editions.
Function: Converts a collection to JSON text.
Input pins:
- ⏺ Collection (collection) - Source collection to serialize.
- ⏺ Condensed (logical) - When on, writes condensed JSON without extra whitespace.
- ⏺ Quote Keys (logical) - When on, always quotes object keys in the generated JSON.
- ⏺ Async Processing (logical) - When on, performs conversion asynchronously.
Output pins:
- ⏺ Out (text) - Serialized JSON text.
- ⏺ Converting (logical) - On while conversion is in progress.
- ⏺ Finished (trigger) - Pulses when conversion finishes.

Collection To XML

Category: Controlling / Database
Access: All editions.
Function: Converts a collection to XML text.
Input pins:
- ⏺ Collection (collection) - Source collection to serialize.
- ⏺ Use Attributes (logical) - When on, writes eligible values as XML attributes instead of child elements.
- ⏺ Async Processing (logical) - When on, performs conversion asynchronously.
Output pins:
- ⏺ Out (text) - Serialized XML text.
- ⏺ Converting (logical) - On while conversion is in progress.
- ⏺ Finished (trigger) - Pulses when conversion finishes.

Collection Transformation

Category: Controlling / Database
Access: All editions.
Function: Reads a transformation value from a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to read from.
- ⏺ Key (text) - Key path of the value to read.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
- ⏺ Default (transformation) - Fallback value used when the selected item is missing or cannot be read as transformation.
Output pins:
- ⏺ Out (transformation) - Read transformation value.
- ⏺ Exists (logical) - On when the selected item exists.

Collection Vector

Category: Controlling / Database
Access: All editions.
Function: Reads a vector value from a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to read from.
- ⏺ Key (text) - Key path of the value to read.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
- ⏺ Default (vector) - Fallback value used when the selected item is missing or cannot be read as vector.
Output pins:
- ⏺ Out (vector) - Read vector value.
- ⏺ Exists (logical) - On when the selected item exists.

Delete Files

Category: Controlling / Database
Access: All editions.
Function: Deletes files listed in the input text.
Input pins:
- ⏺ Files (text) - File paths to delete.
- ⏺ Delete (trigger) - Starts deleting the listed files once.
Output pins:

Delete Folders

Category: Controlling / Database
Access: All editions.
Function: Deletes folders listed in the input text.
Input pins:
- ⏺ Folders (text) - Folder paths to delete.
- ⏺ Delete (trigger) - Starts deleting the listed folders once.
Output pins:

Enumerate Data

Category: Controlling / Database
Access: All editions.
Function: Enumerates items and outputs one item at a time.
Input pins:
- ⏺ Restart (trigger) - Restarts enumeration from the first item.
- ⏺ Next Item (trigger) - Advances to the next matching item.
- ⏺ Looping (logical) - When on, wraps to the first item after the last item.
- ⏺ Restart When Inactive (logical) - When on, restarts from the first item after inactivity.
- ⏺ Num Items (integer) - Total number of items available for enumeration.
- ⏺ Item Condition (logical) - When on, allows the current item to be emitted.
- ⏺ Item Data (text) - Data value associated with the current item slot.
Output pins:
- ⏺ Item Index (integer) - Index of the currently emitted item.
- ⏺ Item Data (text) - Data value of the currently emitted item.

File Downloader

Category: Controlling / Database
Access: Broadcast & Film Edition required.
Function: Downloads a remote file and saves it to disk.
Input pins:
- ⏺ URL (text) - Source URL to download. Supports only http and https URLs.
- ⏺ Headers (text) - Optional request headers sent with the download request.
- ⏺ Target Folder (text) - Target folder used when ExactPath is empty.
- ⏺ Target File (text) - Target file name used when ExactPath is empty.
- ⏺ Auto Numbering (logical) - When on, appends a unique number to avoid overwriting an existing file.
- ⏺ Exact Path (text) - Full output path override. When set, OutputFolder and OutputFile are ignored.
- ⏺ Connect Timeout (scalar) - Connection timeout in seconds.
- ⏺ Read Timeout (scalar) - Read timeout in seconds.
- ⏺ Download (trigger) - Starts downloading once.
- ⏺ Abort (trigger) - Aborts the current download.
Output pins:
- ⏺ Downloading (logical) - On while download is in progress.
- ⏺ Target Path (text) - Resolved target path of the current or last download.
- ⏺ Total Size (double precision scalar) - Total file size in bytes when known.
- ⏺ Downloaded Size (double precision scalar) - Downloaded byte count so far.
- ⏺ Speed (double precision scalar) - Current download speed in bytes per second.
- ⏺ Speed Text (text) - Current download speed as formatted text.
- ⏺ Remaining Time (double precision scalar) - Estimated remaining download time in seconds.
- ⏺ Remaining Time Text (text) - Estimated remaining download time as formatted text.
- ⏺ Finished (trigger) - Pulses when download finishes.
- ⏺ Succeeded (logical) - On when the last download finished successfully.

Find Files

Category: Controlling / Database
Access: All editions.
Function: Finds files and folders and outputs the results as text.
Input pins:
- ⏺ Start Line Index (integer) - First line index to output from the source text.
- ⏺ Line Count (integer) - Maximum number of lines to include in output.
- ⏺ Folder (text) - Root folder to search in.
- ⏺ File Mask (text) - Name pattern used to match results.
- ⏺ Find Folders (logical) - When on, includes folders in the result list.
- ⏺ Find Files (logical) - When on, includes files in the result list.
- ⏺ Find Hidden (logical) - When on, includes hidden items in the search.
- ⏺ Full Paths (logical) - When on, outputs full item paths; when off, outputs item names only.
- ⏺ Absolute Paths (logical) - When on, outputs absolute paths; when off, outputs paths relative to Folder.
- ⏺ Refresh (trigger) - Runs the search again once.
Output pins:
- ⏺ Out (text) - Selected text block.
- ⏺ Total Line Count (integer) - Total line count in the full source text.

JSON Exporter

Category: Controlling / Database
Access: All editions.
Function: Writes a collection to a JSON file.
Input pins:
- ⏺ Collection (collection) - Collection content to export.
- ⏺ Output Folder (text) - Output folder used when ExactPath is empty.
- ⏺ Output File (text) - Base file name used when ExactPath is empty.
- ⏺ Auto Numbering (logical) - When on, appends a unique number to avoid overwriting an existing file.
- ⏺ Exact Path (text) - Full output path override. When set, OutputFolder and OutputFile are ignored.
- ⏺ Output Suffix (text) - Optional suffix inserted into the output file name.
- ⏺ Keep Extension (logical) - When on, keeps the extension from OutputFile if specified. Otherwise automatically appends an appropriate extension.
- ⏺ Condensed (logical) - When on, writes condensed JSON without extra whitespace.
- ⏺ Quote Keys (logical) - When on, always quotes object keys in the generated JSON.
- ⏺ Export (trigger) - Starts writing the file once.
Output pins:
- ⏺ Exporting (logical) - On while export is running.
- ⏺ Output Path (text) - Resolved output path of the last export attempt.
- ⏺ Finished (trigger) - Pulses when export finishes.
- ⏺ Succeeded (logical) - On when the last export finished successfully.

JSON File

Category: Controlling / Database
Access: All editions.
Function: Reads a JSON file and outputs it as a collection.
Input pins:
- ⏺ JSON File (text) - Path of the JSON file to read.
- ⏺ Open (logical) - When on, keeps the file open and updates output from it.
Output pins:
- ⏺ Out (collection) - Parsed collection value from the file.
- ⏺ Loading (logical) - On while loading or parsing is in progress.
- ⏺ Finished (trigger) - Pulses when loading finishes.
- ⏺ Succeeded (logical) - On when the last load finished successfully.

JSON To Collection

Category: Controlling / Database
Access: All editions.
Function: Converts JSON text to a collection.
Input pins:
- ⏺ Text (text) - JSON text to parse.
Output pins:
- ⏺ Out (collection) - Parsed collection value.
- ⏺ Converting (logical) - On while parsing is in progress.
- ⏺ Finished (trigger) - Pulses when parsing finishes.
- ⏺ Succeeded (logical) - On when the last parse succeeded.

Lens Data Converter

Category: Controlling / Database
Access: All editions.
Function: Converts lens data between supported lens-description formats.
Input pins:
- ⏺ Lens Data (vector) - Input lens description data to convert.
- ⏺ Target Type (integer, Camera Lens Desc Type) - Target lens-description format.
- ⏺ Invert (logical) - When on, converts in the reverse direction where supported.
- ⏺ Allow K 3 (logical) - When on, allows using the K3 parameter in conversions that support it.
Output pins:
- ⏺ Out (vector) - Converted lens description data.

LUT Exporter

Category: Controlling / Database
Access: All editions.
Function: Exports LUT data to a LUT file.
Input pins:
- ⏺ Color Map (video) - Source color-map image sampled into LUT data.
- ⏺ Output Folder (text) - Output folder used when ExactPath is empty.
- ⏺ Output File (text) - Base file name used when ExactPath is empty.
- ⏺ Auto Numbering (logical) - When on, appends a unique number to avoid overwriting an existing file.
- ⏺ Exact Path (text) - Full output path override. When set, OutputFolder and OutputFile are ignored.
- ⏺ Output Suffix (text) - Optional suffix inserted into the output file name.
- ⏺ LUT Size (integer) - LUT resolution written to the file.
- ⏺ Domain Min (vector) - Minimum input domain written into the exported LUT.
- ⏺ Domain Max (vector) - Maximum input domain written into the exported LUT.
- ⏺ Data (vector) - Captured LUT sample data used for export.
- ⏺ Store Data (trigger) - Captures LUT sample data from ColorMap into Data.
- ⏺ Export (trigger) - Starts writing the LUT file once.
Output pins:
- ⏺ Exporting (logical) - On while export is running.
- ⏺ Output Path (text) - Resolved output path of the last export attempt.
- ⏺ Finished (trigger) - Pulses when export finishes.
- ⏺ Succeeded (logical) - On when the last export finished successfully.

Message Queue

Category: Controlling / Database
Access: All editions.
Function: Queues incoming messages and outputs the next message in order.
Input pins:
- ⏺ Message (text) - Incoming text to enqueue.
- ⏺ Separators (text) - Separator characters used to split incoming text into multiple queued messages.
- ⏺ Multi Separ (logical) - When on, treats repeated separators as one separator block.
- ⏺ Line Separ (logical) - When on, handles line separators as queue item boundaries.
- ⏺ Max Queue Size (integer) - Maximum number of queued messages to keep.
Output pins:
- ⏺ Out (text) - Next queued message.

Path Unique

Category: Controlling / Database
Access: All editions.
Function: Generates a unique output path.
Input pins:
- ⏺ Folder (text) - Folder where the unique path is generated.
- ⏺ Extension (text) - File extension to use for the generated path.
- ⏺ Generate (trigger) - Generates a new unique path once.
Output pins:
- ⏺ Out (text) - Generated unique path.

Set Collection Color

Category: Controlling / Database
Access: All editions.
Function: Writes a color value into a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to modify.
- ⏺ Key (text) - Key path of the target item to set.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
- ⏺ Value (color) - Value to write at the selected key and index.
Output pins:
- ⏺ Out (collection) - Collection after writing the requested item.

Set Collection Double

Category: Controlling / Database
Access: All editions.
Function: Writes a double value into a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to modify.
- ⏺ Key (text) - Key path of the target item to set.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
- ⏺ Value (double precision scalar) - Value to write at the selected key and index.
Output pins:
- ⏺ Out (collection) - Collection after writing the requested item.

Set Collection Integer

Category: Controlling / Database
Access: All editions.
Function: Writes an integer value into a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to modify.
- ⏺ Key (text) - Key path of the target item to set.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
- ⏺ Value (integer) - Value to write at the selected key and index.
Output pins:
- ⏺ Out (collection) - Collection after writing the requested item.

Set Collection Logical

Category: Controlling / Database
Access: All editions.
Function: Writes a logical value into a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to modify.
- ⏺ Key (text) - Key path of the target item to set.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
- ⏺ Value (logical) - Value to write at the selected key and index.
Output pins:
- ⏺ Out (collection) - Collection after writing the requested item.

Set Collection Scalar

Category: Controlling / Database
Access: All editions.
Function: Writes a scalar value into a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to modify.
- ⏺ Key (text) - Key path of the target item to set.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
- ⏺ Value (scalar) - Value to write at the selected key and index.
Output pins:
- ⏺ Out (collection) - Collection after writing the requested item.

Set Collection Text

Category: Controlling / Database
Access: All editions.
Function: Writes a text value into a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to modify.
- ⏺ Key (text) - Key path of the target item to set.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
- ⏺ Value (text) - Value to write at the selected key and index.
Output pins:
- ⏺ Out (collection) - Collection after writing the requested item.

Set Collection Transformation

Category: Controlling / Database
Access: All editions.
Function: Writes a transformation value into a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to modify.
- ⏺ Key (text) - Key path of the target item to set.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
- ⏺ Value (transformation) - Value to write at the selected key and index.
Output pins:
- ⏺ Out (collection) - Collection after writing the requested item.

Set Collection Vector

Category: Controlling / Database
Access: All editions.
Function: Writes a vector value into a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to modify.
- ⏺ Key (text) - Key path of the target item to set.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
- ⏺ Value (vector) - Value to write at the selected key and index.
Output pins:
- ⏺ Out (collection) - Collection after writing the requested item.

Set Subcollection

Category: Controlling / Database
Access: All editions.
Function: Writes a subcollection into a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to modify.
- ⏺ Key (text) - Key path of the target item to set.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
- ⏺ Value (collection) - Subcollection value to write at the selected key and index.
Output pins:
- ⏺ Out (collection) - Collection after writing the requested item.

SQL Database

Category: Controlling / Database
Access: Broadcast & Film Edition required.
Function: Opens and manages an SQL database connection.
Input pins:
- ⏺ Connect (logical) - When on, opens and keeps the database connection active.
- ⏺ Server Type (integer, Server Type) - SQL server type to connect to.
- ⏺ Server Name (text) - Server host name or address.
- ⏺ Server Port (integer) - Server port number.
- ⏺ Database (text) - Database name to connect to.
Output pins:
- ⏺ Connected (logical) - On while the database connection is active.
- ⏺ Queries (sql query reference) - Query reference output used by SQLQuery modules.

SQL Query

Category: Controlling / Database
Access: Broadcast & Film Edition required.
Function: Runs an SQL command and outputs the result as a collection.
Input pins:
- ⏺ SQL Command (text) - SQL command text to execute.
- ⏺ Key Field (text) - Field name used as key when building output collection rows.
- ⏺ Null Text (text) - Text written for null values in text-formatted results.
- ⏺ Date Format (text) - Date and time format used when converting database values to text.
- ⏺ Query (trigger) - Runs the SQL command once.
- ⏺ Auto Query (logical) - When on, repeats query execution automatically at AutoInterval.
- ⏺ Auto Interval (scalar) - Interval in seconds between automatic query runs.
- ⏺ Database (sql query reference) - Database reference input from SQLDatabase.
Output pins:
- ⏺ Out (collection) - Query result converted to collection data.

Subcollection

Category: Controlling / Database
Access: All editions.
Function: Reads a subcollection from a collection.
Input pins:
- ⏺ Collection (collection) - Source collection to read from.
- ⏺ Key (text) - Key path of the value to read.
- ⏺ Index (integer) - Optional array index inside the selected key path. -1 means the array itself.
Output pins:
- ⏺ Out (collection) - Read subcollection value.
- ⏺ Exists (logical) - On when the selected item exists.

Text Block

Category: Controlling / Database
Access: All editions.
Function: Outputs a selected line range from the input text.
Input pins:
- ⏺ Start Line Index (integer) - First line index to output from the source text.
- ⏺ Line Count (integer) - Maximum number of lines to include in output.
- ⏺ Text (text) - Source text to slice into a block.
- ⏺ Localizable (logical) - When on, treats the text as localizable content.
Output pins:
- ⏺ Out (text) - Selected text block.
- ⏺ Total Line Count (integer) - Total line count in the full source text.

Text Exporter

Category: Controlling / Database
Access: All editions.
Function: Writes text to a file.
Input pins:
- ⏺ Text (text) - Text content to export.
- ⏺ Output Folder (text) - Output folder used when ExactPath is empty.
- ⏺ Output File (text) - Base file name used when ExactPath is empty.
- ⏺ Auto Numbering (logical) - When on, appends a unique number to avoid overwriting an existing file.
- ⏺ Exact Path (text) - Full output path override. When set, OutputFolder and OutputFile are ignored.
- ⏺ Output Suffix (text) - Optional suffix inserted into the output file name.
- ⏺ Keep Extension (logical) - When on, keeps the extension from OutputFile if specified. Otherwise automatically appends an appropriate extension.
- ⏺ Encoding (integer, Text Exporter Encoding) - Text encoding used for writing the file.
- ⏺ Export (trigger) - Starts writing the file once.
Output pins:
- ⏺ Exporting (logical) - On while export is running.
- ⏺ Output Path (text) - Resolved output path of the last export attempt.
- ⏺ Finished (trigger) - Pulses when export finishes.
- ⏺ Succeeded (logical) - On when the last export finished successfully.

Text File

Category: Controlling / Database
Access: All editions.
Function: Reads text from a file and outputs a selected line range.
Input pins:
- ⏺ Start Line Index (integer) - First line index to output from the source text.
- ⏺ Line Count (integer) - Maximum number of lines to include in output.
- ⏺ Text File (text) - Path of the text file to read.
- ⏺ Open (logical) - When on, keeps the file open and updates output from it.
Output pins:
- ⏺ Out (text) - Selected text block.
- ⏺ Total Line Count (integer) - Total line count in the full source text.

XML Exporter

Category: Controlling / Database
Access: All editions.
Function: Writes a collection to an XML file.
Input pins:
- ⏺ Collection (collection) - Collection content to export.
- ⏺ Output Folder (text) - Output folder used when ExactPath is empty.
- ⏺ Output File (text) - Base file name used when ExactPath is empty.
- ⏺ Auto Numbering (logical) - When on, appends a unique number to avoid overwriting an existing file.
- ⏺ Exact Path (text) - Full output path override. When set, OutputFolder and OutputFile are ignored.
- ⏺ Output Suffix (text) - Optional suffix inserted into the output file name.
- ⏺ Keep Extension (logical) - When on, keeps the extension from OutputFile if specified. Otherwise automatically appends an appropriate extension.
- ⏺ Use Attributes (logical) - When on, writes eligible values as XML attributes instead of child elements.
- ⏺ Export (trigger) - Starts writing the file once.
Output pins:
- ⏺ Exporting (logical) - On while export is running.
- ⏺ Output Path (text) - Resolved output path of the last export attempt.
- ⏺ Finished (trigger) - Pulses when export finishes.
- ⏺ Succeeded (logical) - On when the last export finished successfully.

XML File

Category: Controlling / Database
Access: All editions.
Function: Reads an XML file and outputs it as a collection.
Input pins:
- ⏺ XML File (text) - Path of the XML file to read.
- ⏺ Open (logical) - When on, keeps the file open and updates output from it.
- ⏺ Use Key Attr (logical) - When on, uses key attributes while parsing XML into collection entries.
Output pins:
- ⏺ Out (collection) - Parsed collection value from the file.
- ⏺ Loading (logical) - On while loading or parsing is in progress.
- ⏺ Finished (trigger) - Pulses when loading finishes.
- ⏺ Succeeded (logical) - On when the last load finished successfully.

XML To Collection

Category: Controlling / Database
Access: All editions.
Function: Converts XML text to a collection.
Input pins:
- ⏺ Text (text) - XML text to parse.
- ⏺ Use Key Attr (logical) - When on, uses key attributes while parsing XML into collection entries.
Output pins:
- ⏺ Out (collection) - Parsed collection value.
- ⏺ Converting (logical) - On while parsing is in progress.
- ⏺ Finished (trigger) - Pulses when parsing finishes.
- ⏺ Succeeded (logical) - On when the last parse succeeded.

search