System Modules

Introduction

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

• System - Modules that provide graph context, timing, module introspection, and engine utility functions.

System

This section describes the built-in Flow Graph modules that provide graph context, timing, module introspection, and engine utility functions.

Actual Out Size

• Category: System
• Access: All editions.
• Function: Outputs the resolved master frame size and a simple width-over-height aspect pair from the sizing input.
• Input pins:
  • ⏺  Out Size (vector) - Frame size used to derive pixel width and height for the outputs.
• Output pins:
  • ⏺  Out Size (vector) - Resolved width and height in pixels as a two-component vector.
  • ⏺  Aspect (vector) - Horizontal extent over vertical extent as (width divided by height, 1).

Array Index

• Category: System
• Access: All editions.
• Function: Reports this instance’s position in the array compound from 1 through N.
• Input pins:
• Output pins:
  • ⏺  Out (integer) - One-based index of this instance inside the array compound.

Array Size

• Category: System
• Access: All editions.
• Function: Reports how many instances the surrounding array compound includes (N).
• Input pins:
• Output pins:
  • ⏺  Out (integer) - The instance count N for this array compound.

Auto Base Date

• Category: System
• Access: All editions.
• Function: Writes the project base date and optional format text into document settings.
• Input pins:
  • ⏺  Base Date (text) - Base date text applied to project settings.
  • ⏺  Format (text) - Optional format pattern text paired with the base date.
• Output pins:

Auto Module Color

• Category: System
• Access: All editions.
• Function: Sets a module fill color, scoped by compound-relative Module path when provided.
• Input pins:
  • ⏺  Module (text) - Relative path from this compound to the compound that holds the target module; leave blank to target a module in this compound.
  • ⏺  Color (color) - Fill color applied to the targeted module.
• Output pins:

Auto Module Name

• Category: System
• Access: All editions.
• Function: Sets the module title in this compound.
• Input pins:
  • ⏺  Name (text) - Display name applied to the targeted module.
• Output pins:

Auto Module Subtitle

• Category: System
• Access: All editions.
• Function: Sets a module subtitle, scoped by compound-relative Module path when provided.
• Input pins:
  • ⏺  Module (text) - Relative path from this compound to the compound that holds the target module; leave blank to target a module in this compound.
  • ⏺  Subtitle (text) - Subtitle text applied to the targeted module.
• Output pins:

Auto Pin Name

• Category: System
• Access: All editions.
• Function: Renames a numbered input pin, scoped by compound-relative Module path when provided.
• Input pins:
  • ⏺  Module (text) - Relative path from this compound to the compound that holds the target module; leave blank to target a module in this compound.
  • ⏺  Pin Index (integer) - One-based index of the pin column to rename.
  • ⏺  Button Index (integer) - Optional index of an extra control slot on that pin when the UI exposes one.
  • ⏺  Name (text) - New label text applied to the chosen pin.
• Output pins:

Device Info

• Category: System
• Access: All editions.
• Function: Returns collections containing detailed information about the devices currently open in the system.
• Input pins:
• Output pins:
  • ⏺  Info (collection) - Structured details about active devices.
  • ⏺  Mapped (collection) - Parallel mapping information aligned with video output device usage.

Executing After Idle

• Category: System
• Access: All editions.
• Function: Carries whether this run was scheduled as after-idle catch-up relative to recent idle or long-gap execution.
• Input pins:
• Output pins:
  • ⏺  Out (logical) - Logical on when the last execution used the after-idle scheduling path.

Force Execution

• Category: System
• Access: All editions.
• Function: Runs at the chosen root priority and pulls every bundled feed input on each execution.
• Input pins:
  • ⏺  Priority (integer) - Root module priority applied for this module’s scheduling.
  • ⏺  Forced 1 (video) - Video feed branch pulled on every execution.
  • ⏺  Forced 2 (audio) - Audio feed branch pulled on every execution.
  • ⏺  Forced 3 (vector) - Vector feed branch pulled on every execution.
  • ⏺  Forced 4 (transformation) - Transformation feed branch pulled on every execution.
  • ⏺  Forced 5 (text) - Text feed branch pulled on every execution.
  • ⏺  Forced 6 (collection) - Collection feed branch pulled on every execution.
  • ⏺  Forced 7 (trigger) - Trigger feed branch pulled on every execution.
• Output pins:

Force Execution If

• Category: System
• Access: All editions.
• Function: Passes its Active input to the output and pulls the bundled feeds only while Active is on.
• Input pins:
  • ⏺  Active (logical) - When on, the output matches this value and each forced feed is evaluated; when off, the output is off and feeds are not pulled.
  • ⏺  Forced 1 (video) - Video feed branch pulled whenever the module runs while Active is on.
  • ⏺  Forced 2 (audio) - Audio feed branch pulled whenever the module runs while Active is on.
  • ⏺  Forced 3 (vector) - Vector feed branch pulled whenever the module runs while Active is on.
  • ⏺  Forced 4 (transformation) - Transformation feed branch pulled whenever the module runs while Active is on.
  • ⏺  Forced 5 (text) - Text feed branch pulled whenever the module runs while Active is on.
  • ⏺  Forced 6 (collection) - Collection feed branch pulled whenever the module runs while Active is on.
  • ⏺  Forced 7 (trigger) - Trigger feed branch pulled whenever the module runs while Active is on.
• Output pins:
  • ⏺  Active (logical) - Echo of the Active input for downstream gating.

Frame Counter

• Category: System
• Access: All editions.
• Function: Advances a counter each execution and resets to one when Restart triggers.
• Input pins:
  • ⏺  Restart (trigger) - When signaled, resets the counter to one on that run.
• Output pins:
  • ⏺  Count (integer) - Monotonically increasing run count unless Restart was signaled.

Log

• Category: System
• Access: All editions.
• Function: Builds log lines from severity and text, prints on demand or after a quiet period, signals each completed print, and lowers root priority when Printed is unwired.
• Input pins:
  • ⏺  Text (text) - Message body joined with the selected severity when a line is printed.
  • ⏺  Target (integer) - Log destination index supplied with each printed line when the logging hook runs.
  • ⏺  Level (integer, Log Level) - Severity level applied as a short prefix on each printed line.
  • ⏺  Priority (integer) - Root module priority used while Printed has no outgoing connection.
  • ⏺  Auto Print (logical) - When on, prints automatically after text stops changing for AutoPeriod seconds.
  • ⏺  Auto Period (scalar) - Seconds of stable text required before an automatic print.
  • ⏺  Print (trigger) - Manual trigger that prints once when signaled.
• Output pins:
  • ⏺  Printed (trigger) - Trigger that fires each time a line is formatted and submitted to the log path.

Machine Info

• Category: System
• Access: All editions.
• Function: Returns a collection containing information about all machines currently part of the multi-machine configuration.
• Input pins:
• Output pins:
  • ⏺  Info (collection) - Per-machine entries keyed by id with name and IP fields.

Render Statistics

• Category: System
• Access: All editions.
• Function: Passes video through while summarizing peak per-frame counters over an interval, live GPU memory usage, and sprite atlas dimensions when an atlas exists.
• Input pins:
  • ⏺  Video (video) - The source image
  • ⏺  Interval (scalar) - Seconds over which peak frame counters accumulate before resetting.
• Output pins:
  • ⏺  Out (video) - Passthrough of the input video.
  • ⏺  Primitives Rendered (integer) - Peak triangle and line primitives counted within the interval window.
  • ⏺  Draw Calls (integer) - Peak draw calls recorded within the interval window.
  • ⏺  Paint Calls (integer) - Peak 2D paint operations within the interval window.
  • ⏺  Modules Executed (integer) - Peak module executions recorded within the interval window.
  • ⏺  Scene Objects Updated (integer) - Peak scene-object updates within the interval window.
  • ⏺  Scene Objects Rendered (integer) - Peak scene objects drawn within the interval window.
  • ⏺  Sprites Rendered (integer) - Sprites drawn in the latest sampled frame inside the interval.
  • ⏺  Mem Dedicated Video (double precision scalar) - Dedicated video memory budget in megabytes.
  • ⏺  Mem Free Dedicated Video (double precision scalar) - Dedicated video memory still free in megabytes.
  • ⏺  Mem Render Target (double precision scalar) - Render-target memory usage in megabytes.
  • ⏺  Mem Texture (double precision scalar) - Texture memory usage in megabytes.
  • ⏺  Mem Mesh (double precision scalar) - Mesh memory usage in megabytes.
  • ⏺  Mem Shader (double precision scalar) - Shader memory usage in megabytes.
  • ⏺  Mem Total (double precision scalar) - Total GPU-side memory tracked in megabytes.
  • ⏺  Sprite Atlas Size (vector) - Width and height of the active sprite atlas, or zero when none.
  • ⏺  Sprite Atlas Items (integer) - Count of items stored in the active sprite atlas, or zero when none.

Restart Application

• Category: System
• Access: All editions.
• Function: Signals a full application restart using captured reopen and optional compound-path choices when Restart fires.
• Input pins:
  • ⏺  Reopen This Compound (logical) - When captured on, requests launching the same compound after restart.
  • ⏺  Open Compound File (text) - Optional compound path captured for the next launch when reopening.
  • ⏺  Restart (trigger) - When signaled, hands the captured options to the application restart handler.
• Output pins:

Run Compound

• Category: System
• Access: All editions.
• Function: Loads another compound file when Run triggers, optionally closing existing compounds first.
• Input pins:
  • ⏺  Compound File (text) - Compound path captured for the run request.
  • ⏺  Close All (logical) - When captured on, closes other compounds before opening the requested one.
  • ⏺  Run (trigger) - When signaled, applies the captured open and close behavior.
• Output pins:

Run Process

• Category: System
• Access: All editions.
• Function: Starts an external executable with optional console piping, streams or batches captured stdout and stderr, reports exit status, and exposes manual kill control.
• Input pins:
  • ⏺  Executable File (text) - Executable or batch file launched when Run fires.
  • ⏺  Command Line (text) - Additional arguments appended after the executable path.
  • ⏺  Current Directory (text) - Working directory used for the child process when provided.
  • ⏺  Hide Window (logical) - When on, creates the process without a visible console window.
  • ⏺  Use Std Input (logical) - When on, connects a pipe so StdInput can be written to the child.
  • ⏺  Use Std Output (logical) - When on, captures stdout and stderr through pipes into the outputs.
  • ⏺  Continuous Out (logical) - When on, streams stdout and stderr text as it arrives instead of buffering until exit.
  • ⏺  Incremental Out (logical) - When ContinuousOut is on and this is on, clears accumulated text after each streamed update.
  • ⏺  Run (trigger) - Starts the executable when signaled while idle.
  • ⏺  Kill (trigger) - Terminates the running child process when signaled.
  • ⏺  Std Input (text) - Payload written to standard input when SendStdInput fires (requires UseStdInput).
  • ⏺  Send Std Input (trigger) - Flushes StdInput down the stdin pipe during a running process.
• Output pins:
  • ⏺  Running (logical) - Logical on while the child process handle is active.
  • ⏺  Exited (trigger) - Trigger that fires once when the process exits.
  • ⏺  Exit Code (integer) - Process exit code after exit, or an error sentinel when launch fails.
  • ⏺  Std Output (text) - Captured standard output text, streamed or consolidated by mode.
  • ⏺  Std Error (text) - Captured standard error text, streamed or consolidated by mode.

Set Color Pin

• Category: System
• Access: All editions.
• Function: Sets the constant value of the specified target color pin.
• 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 apply updates to the target pin.
  • ⏺  Module (text) - Identifying label used to locate the target module.
  • ⏺  Pin (text) - Identifying label used to locate the target pin on that module.
  • ⏺  Partial Match (logical) - When on, matches module and pin labels by substring instead of exact equality.
  • ⏺  Set (trigger) - When signaled, pushes the authored value using the undo and document-change rules configured here.
  • ⏺  Auto Set (logical) - When on, reapplies whenever the value changes or when toggled from off to on (with an initial apply on first run).
  • ⏺  Doc Changed (logical) - When on together with undo-aware applies, escalates certain updates to document-change handling.
  • ⏺  Allow Undo (logical) - When on, participates in grouped undo steps; when off, forces a standalone apply tier.
  • ⏺  Force (logical) - When on, listens for value changes even if AutoSet is off, matching the AutoSet change path.
  • ⏺  Value (color) - Color value pushed to the matched target pin.
• Output pins:

Set Double Pin

• Category: System
• Access: All editions.
• Function: Sets the constant value of the specified target double pin.
• 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 apply updates to the target pin.
  • ⏺  Module (text) - Identifying label used to locate the target module.
  • ⏺  Pin (text) - Identifying label used to locate the target pin on that module.
  • ⏺  Partial Match (logical) - When on, matches module and pin labels by substring instead of exact equality.
  • ⏺  Set (trigger) - When signaled, pushes the authored value using the undo and document-change rules configured here.
  • ⏺  Auto Set (logical) - When on, reapplies whenever the value changes or when toggled from off to on (with an initial apply on first run).
  • ⏺  Doc Changed (logical) - When on together with undo-aware applies, escalates certain updates to document-change handling.
  • ⏺  Allow Undo (logical) - When on, participates in grouped undo steps; when off, forces a standalone apply tier.
  • ⏺  Force (logical) - When on, listens for value changes even if AutoSet is off, matching the AutoSet change path.
  • ⏺  Value (double precision scalar) - Numeric value pushed to the matched target pin.
• Output pins:

Set Integer Pin

• Category: System
• Access: All editions.
• Function: Sets the constant value of the specified target integer pin.
• 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 apply updates to the target pin.
  • ⏺  Module (text) - Identifying label used to locate the target module.
  • ⏺  Pin (text) - Identifying label used to locate the target pin on that module.
  • ⏺  Partial Match (logical) - When on, matches module and pin labels by substring instead of exact equality.
  • ⏺  Set (trigger) - When signaled, pushes the authored value using the undo and document-change rules configured here.
  • ⏺  Auto Set (logical) - When on, reapplies whenever the value changes or when toggled from off to on (with an initial apply on first run).
  • ⏺  Doc Changed (logical) - When on together with undo-aware applies, escalates certain updates to document-change handling.
  • ⏺  Allow Undo (logical) - When on, participates in grouped undo steps; when off, forces a standalone apply tier.
  • ⏺  Force (logical) - When on, listens for value changes even if AutoSet is off, matching the AutoSet change path.
  • ⏺  Value (integer) - Integer value pushed to the matched target pin.
• Output pins:

Set Logical Pin

• Category: System
• Access: All editions.
• Function: Sets the constant value of the specified target logical pin.
• 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 apply updates to the target pin.
  • ⏺  Module (text) - Identifying label used to locate the target module.
  • ⏺  Pin (text) - Identifying label used to locate the target pin on that module.
  • ⏺  Partial Match (logical) - When on, matches module and pin labels by substring instead of exact equality.
  • ⏺  Set (trigger) - When signaled, pushes the authored value using the undo and document-change rules configured here.
  • ⏺  Auto Set (logical) - When on, reapplies whenever the value changes or when toggled from off to on (with an initial apply on first run).
  • ⏺  Doc Changed (logical) - When on together with undo-aware applies, escalates certain updates to document-change handling.
  • ⏺  Allow Undo (logical) - When on, participates in grouped undo steps; when off, forces a standalone apply tier.
  • ⏺  Force (logical) - When on, listens for value changes even if AutoSet is off, matching the AutoSet change path.
  • ⏺  Value (logical) - Logical value pushed to the matched target pin.
• Output pins:

Set Scalar Pin

• Category: System
• Access: All editions.
• Function: Sets the constant value of the specified target scalar pin.
• 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 apply updates to the target pin.
  • ⏺  Module (text) - Identifying label used to locate the target module.
  • ⏺  Pin (text) - Identifying label used to locate the target pin on that module.
  • ⏺  Partial Match (logical) - When on, matches module and pin labels by substring instead of exact equality.
  • ⏺  Set (trigger) - When signaled, pushes the authored value using the undo and document-change rules configured here.
  • ⏺  Auto Set (logical) - When on, reapplies whenever the value changes or when toggled from off to on (with an initial apply on first run).
  • ⏺  Doc Changed (logical) - When on together with undo-aware applies, escalates certain updates to document-change handling.
  • ⏺  Allow Undo (logical) - When on, participates in grouped undo steps; when off, forces a standalone apply tier.
  • ⏺  Force (logical) - When on, listens for value changes even if AutoSet is off, matching the AutoSet change path.
  • ⏺  Value (scalar) - Scalar value pushed to the matched target pin.
• Output pins:

Set System Params

• Category: System
• Access: All editions.
• Function: Updates master frame size, pixel aspect, frame rate, and interlacing on Set or whenever auto-set catches a change.
• Input pins:
  • ⏺  Frame Size (vector) - Master frame width and height applied to the arrangement.
  • ⏺  Pixel Aspect (scalar) - Pixel aspect ratio; nonpositive values keep the current arrangement default.
  • ⏺  Frame Rate (double precision scalar) - Frames per second; nonpositive values keep rate and interlacing from the current arrangement.
  • ⏺  Interlaced (logical) - When on, doubles the effective frame rate contribution for interlaced timing.
  • ⏺  Set (trigger) - When signaled, writes the captured video parameters immediately.
  • ⏺  Auto Set (logical) - When on, applies whenever any controlling value differs from the active arrangement settings.
• Output pins:

Set Text Pin

• Category: System
• Access: All editions.
• Function: Sets the constant value of the specified target text pin.
• 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 apply updates to the target pin.
  • ⏺  Module (text) - Identifying label used to locate the target module.
  • ⏺  Pin (text) - Identifying label used to locate the target pin on that module.
  • ⏺  Partial Match (logical) - When on, matches module and pin labels by substring instead of exact equality.
  • ⏺  Set (trigger) - When signaled, pushes the authored value using the undo and document-change rules configured here.
  • ⏺  Auto Set (logical) - When on, reapplies whenever the value changes or when toggled from off to on (with an initial apply on first run).
  • ⏺  Doc Changed (logical) - When on together with undo-aware applies, escalates certain updates to document-change handling.
  • ⏺  Allow Undo (logical) - When on, participates in grouped undo steps; when off, forces a standalone apply tier.
  • ⏺  Force (logical) - When on, listens for value changes even if AutoSet is off, matching the AutoSet change path.
  • ⏺  Value (text) - Text pushed to the matched target pin.
• Output pins:

Set Transformation Pin

• Category: System
• Access: All editions.
• Function: Sets the constant value of the specified target transformation pin.
• 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 apply updates to the target pin.
  • ⏺  Module (text) - Identifying label used to locate the target module.
  • ⏺  Pin (text) - Identifying label used to locate the target pin on that module.
  • ⏺  Partial Match (logical) - When on, matches module and pin labels by substring instead of exact equality.
  • ⏺  Set (trigger) - When signaled, pushes the authored value using the undo and document-change rules configured here.
  • ⏺  Auto Set (logical) - When on, reapplies whenever the value changes or when toggled from off to on (with an initial apply on first run).
  • ⏺  Doc Changed (logical) - When on together with undo-aware applies, escalates certain updates to document-change handling.
  • ⏺  Allow Undo (logical) - When on, participates in grouped undo steps; when off, forces a standalone apply tier.
  • ⏺  Force (logical) - When on, listens for value changes even if AutoSet is off, matching the AutoSet change path.
  • ⏺  Value (transformation) - Transformation pushed to the matched target pin.
  • ⏺  Force PRS (logical) - When on (default), keeps written transformations aligned with explicit position, rotation, and uniform scale fields on the target.
• Output pins:

Set Trigger Pin

• Category: System
• Access: All editions.
• Function: Fires the matched trigger pin on another module when Set is signaled.
• 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 fire the matched trigger pin.
  • ⏺  Module (text) - Identifying label used to locate the target module.
  • ⏺  Pin (text) - Identifying label used to locate the target trigger pin.
  • ⏺  Partial Match (logical) - When on, matches module and pin labels by substring instead of exact equality.
  • ⏺  Set (trigger) - When signaled, fires the matched trigger pin if the engine selection allows it.
• Output pins:

Set Vector Pin

• Category: System
• Access: All editions.
• Function: Sets the constant value of the specified target vector pin.
• 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 apply updates to the target pin.
  • ⏺  Module (text) - Identifying label used to locate the target module.
  • ⏺  Pin (text) - Identifying label used to locate the target pin on that module.
  • ⏺  Partial Match (logical) - When on, matches module and pin labels by substring instead of exact equality.
  • ⏺  Set (trigger) - When signaled, pushes the authored value using the undo and document-change rules configured here.
  • ⏺  Auto Set (logical) - When on, reapplies whenever the value changes or when toggled from off to on (with an initial apply on first run).
  • ⏺  Doc Changed (logical) - When on together with undo-aware applies, escalates certain updates to document-change handling.
  • ⏺  Allow Undo (logical) - When on, participates in grouped undo steps; when off, forces a standalone apply tier.
  • ⏺  Force (logical) - When on, listens for value changes even if AutoSet is off, matching the AutoSet change path.
  • ⏺  Value (vector) - Vector value pushed to the matched target pin.
• Output pins:

System Params

• Category: System
• Access: All editions.
• Function: Exposes session engine selection, frame format, clocks, timecode, linear color pipeline mode, and optional custom arrangement data.
• Input pins:
• Output pins:
  • ⏺  Engine (integer) - Remote engine index for this instance.
  • ⏺  Primary (logical) - Logical on when this engine is the configured primary machine.
  • ⏺  Engine Name (text) - Human-readable engine label when connected.
  • ⏺  Frame Size (vector) - Master frame width and height in pixels.
  • ⏺  Frame Aspect (scalar) - Displayed aspect combining pixel aspect with frame dimensions.
  • ⏺  Pixel Aspect (scalar) - Pixel aspect ratio applied to the master frame.
  • ⏺  Frame Rate (double precision scalar) - Frames per second derived from the master frame period.
  • ⏺  Interlaced (logical) - Logical on when interlaced timing is active.
  • ⏺  Date Time (double precision scalar) - Hours since the global base date including fractional hours from the system clock.
  • ⏺  Time (double precision scalar) - Seconds since local midnight including fractional seconds.
  • ⏺  Up Time (double precision scalar) - Seconds since application start according to the internal timer.
  • ⏺  Timecode Base (integer) - Configured timecode base associated with the video system.
  • ⏺  Master Timecode (integer) - Current master timecode value maintained by the video system.
  • ⏺  Frame ID (integer) - Current frame identity from the video system state.
  • ⏺  Current Field (integer) - Current field index for interlaced sequences.
  • ⏺  Linear Pipeline (logical) - Logical on when the renderer runs a linear color pipeline.
  • ⏺  Custom Params (collection) - Optional custom arrangement parameters exposed by the session.