Loading...
TotalMix FX · Fireface UFX · Fireface UFX II · Fireface UFX III · Fireface UCX · +12 more
This module controls TotalMix FX through OSC and listens to TotalMix's return stream for authoritative state.
Configure a TotalMix OSC remote and this Companion connection with matching ports. The default same-computer setup is:
| Setting | Value |
|---|---|
| Host | 127.0.0.1 |
| TotalMix receive port | 7001 |
| Companion feedback port | 9001 |
| TotalMix version | 2.1 or newer (Global OSC) |
In TotalMix FX 2.1, select Global OSC under Compatibility (Mode) and open Details. Use these settings:
| TotalMix setting | Recommendation | Purpose |
|---|---|---|
| Send changes | Required | Sends GUI and mixer changes to Companion. |
| Send all data on start | Off | Companion requests its own initial state with /sendall; enabling both only duplicates traffic. |
| Send status | Recommended | Supplies device, connection, DSP, and heartbeat information. |
| Receive to hidden channels | Optional | Enable only if Companion should control channels hidden from Global OSC. Hidden channels are otherwise omitted from selectors. |
| Set all faders in group | Optional | Makes a received fader command operate on the complete TotalMix fader group. |
| Send faders in linear scale | Optional | The module accepts both linear 0–1 fader feedback and dB feedback. |
| Re-send received | Recommended | Immediately confirms commands that TotalMix received from Companion. |
| Re-send if different | Optional | Reduces unnecessary return traffic by limiting re-sends to changed values. |
| Bandwidth limitation | 500 kByte/s | A practical starting point, especially for the initial state of large interfaces. |
Note: TotalMix labels Re-send received with “use carefully” because an OSC client that blindly echoes incoming messages could create a loop. This module never forwards received OSC messages: feedback only updates its local state, while actions send commands. The option is therefore safe and recommended here for immediate command confirmation. Without it, actions still work and are confirmed by a later state refresh.
In the main OSC settings, enable Send Level Data only when meter feedbacks are required. Meter traffic can be substantial. Lock Remote to Submix and the legacy bank-size setting are not used by Global OSC.
For TotalMix FX 1.96 through 2.03, choose 1.96 or newer in Companion and the matching compatibility mode in TotalMix. OSC 1.96 also requires the same bank size in both applications.
Enable the TotalMix OSC remote. The Companion connection becomes green after the first heartbeat or state message is received.
The feedback port must be unique. If a Generic OSC connection already listens on
9001, disable its listener or use another TotalMix remote/port pair.
-100 left through 0 center to +100 right.0–1 values.For encoder rotation, create two Adjust fader level actions. A useful starting point is +1 dB clockwise and -1 dB counterclockwise.
The regular actions retain this row-first configuration. The supplied encoder presets additionally use an internal target expression so their actions and feedbacks can share one button-local selection.
Feedbacks read the local state cache. When a target feedback is used, the module registers that target with a rate-limited background synchronizer so the callback itself never blocks on an OSC request.
Enable Send Channel Names and Send Peak Level in the TotalMix OSC remote when using the corresponding feedbacks. Meter traffic can be substantial; only enable peak transmission when needed.
Fader values for specific routes and outputs are provided by API 2.1 Value feedbacks. Companion can bind these feedbacks to button-local variables, so each button carries its own target configuration and there is no fixed watch limit.
When a placed feedback uses a channel, route, output, processing parameter, or Room EQ parameter, the module also publishes that value automatically as a normal connection variable. Core Fader, Pan, Mute, PFL, Gain, hardware-option, processing, and Room EQ actions publish their target when first executed. Identical targets are deduplicated, and only values actually used by buttons are exposed; the module does not create variables for the complete mixer matrix.
Variable IDs use stable one-based row positions, for example input_1_name, output_1_fader_db, and route_input_1_to_output_3_fader_db. The description follows the current TotalMix channel names, but renaming a channel does not change the variable ID. Published targets remain synchronized and can be used by other buttons, triggers, and expressions.
Confirmed values come from TotalMix. A value can temporarily be optimistic immediately after an action, or stale if the return stream stops.
The connection exposes its OSC connection state, the continuously synchronized active snapshot, and, when available, continuously synchronized DURec state and time. Global OSC additionally provides the detected device, TotalMix device connection, and DSP status.
Presets are grouped directly by workflow: Stream Deck + encoders, Channel controls, Control Room, Snapshots and history, and DURec. Device-dependent presets are shown only when the current profile or Global OSC discovery reports the required feature.
The Stream Deck + templates include one editable Fader, a dedicated Main output fader, input gain, and pan/balance. Each exposes one feedback-driven local variable named target. Change only that variable to retarget the complete preset: encoder and press actions, channel name, value display, gauge, and active-state feedback all follow it automatically. Fader and Pan/Balance provide Row, Source, and Destination/Output fields; Main provides only Output; Gain provides only Hardware input.
Faders use ±1 dB steps and show their live dB value without a gauge. Input gain uses ±0.5 dB in Global OSC mode; its ring fills against the selected input's device-specific range and follows a separate Instrument range where the hardware provides one. Pan/balance uses ±5 steps; its ring fills from top center towards the current position and shows L or R at the endpoints. Pressing either Fader encoder toggles Mute, pressing a supported Gain encoder toggles AutoSet, and pressing Pan/Balance returns it to center. The Main preset follows the output named Main by TotalMix and falls back to the first hardware output until that name is available. A muted Fader displays MUTED in TotalMix cyan, and active AutoSet uses TotalMix orange. Dim remains available as a regular Control Room button.
The button presets cover Mute, PFL, an input Peak/Clip indicator, supported input hardware options, Loopback, Dim, Mono, Talkback, Speaker B, Snapshot 1–8 recall, Undo, Redo, and available DURec controls. The Peak/Clip preset turns red when either meter side reaches its editable -1 dBFS default threshold; TotalMix level transmission must be enabled. Layered labels are scaled to visually match regular Companion buttons. DURec uses short transport labels without a separate display-only status preset. REC adds TotalMix's live time and turns red while recording. PLAY changes to PAUSE, adds the live time, and highlights the button while playing.
Preset colors follow TotalMix's visual language: cyan for active Mute, orange for PFL and enabled channel options, blue-gray for active Control Room functions, and red for recording or potentially hazardous routing states such as Loopback. Presets are editable templates.