Skip to main content

Module names

Module names 

Source
Expand description

Named Rodecaster entities: the typed vocabulary the public API speaks.

§Why names, not indices

On the wire every entity is purely positional: a source is “the Nth INPUTSOURCE node”, a mix cell is “source-major cell N”, a fader is “the Nth FADER node”. Those ordinals are an implementation detail of the JUCE tree, not a stable contract: they shift with firmware and differ across device models. This module pins each ordinal to a named entity (Source, MixOutput, Fader) so consumers address “Combo 1” or “Virtual 2”, never a bare 7.

The name <-> ordinal mapping is irreducible reverse-engineering knowledge: the nodes carry no labels, so it cannot be recovered from a fullSync. It lives here as data.

§Per-model split

Source (19) and MixOutput (13) are model-independent: the RODECaster Pro family shares one source/output vocabulary (one shared device picker). Only Fader differs: the Pro II exposes 6 physical + 3 virtual strips, the Duo 4 physical + 5 virtual. So the fader name <-> index map is parameterized by DeviceModel, which crate::Layout detects from the fullSync’s SYSTEM node.

§Module layout

macros defines the one wire_param_enum! macro; core holds the model-independent vocabulary (DeviceModel, MixOutput, Source, Fader); and each node-scoped property family lives in its own file (channel, input_source, master, …). Every type is re-exported here so the public path stays crate::names::X.

Structs§

ParseFaderError
Error returned when parsing an invalid fader name.
ParseMixOutputError
Error returned when parsing an invalid mix output name.
ParseSourceError
Error returned when parsing an invalid input source name.

Enums§

AppParam
A companion-app-mode parameter: one of the flat properties the device carries on the singleton APP node. Reflects the device’s view of the RODE Connect app’s current mode (compression on, monitor mix selection, output device chosen, recording state). Semantics of each value are firmware-internal; the crate types the property name only.
AudioParam
A device-wide audio-engine parameter: one of the flat properties the device carries on the singleton AUDIO node. Covers the audio engine (buffer, sample rate, channel counts, latencies), the active StreamerX mix-preset selector, and the two rcSync channel controls. Un-typed properties arrive as AudioParam::Other for forward-compat.
BuildParam
A device-wide firmware-build metadata parameter: one of the flat properties the device carries on the singleton BUILD node. Read-back only (the fields are set by the firmware image itself; writes are ignored). Includes the CallMe version, and GUI + mixer module version strings and git shas: useful for capture-fidelity tooling that needs to record the exact firmware build state.
ChannelParam
A per-channel-strip parameter: one of the flat properties the device carries on a CHANNEL node (the EQ, dynamics, HPF, aphex, pan and tone controls for one fader).
CurrentShowParam
A currently-loaded-show parameter: one of the flat properties the device carries on the singleton CURRENTSHOW node. Reflects which ShowParam-addressed show is currently active on the device.
DeviceModel
Which RODECaster a fullSync came from. Detected from the SYSTEM node; selects the per-model Fader layout.
DuckerParam
A ducker parameter: the flat property the device carries on the single DUCKER node. There is exactly one ducker, so this family takes no addressing key. Auto-ducking lowers other faders when a mic-flagged source is active; duckerDepth is how far (in dB) it pulls them down.
EffectsParam
A per-slot effects parameter: one of the flat properties the device carries on a root EFFECTS_PARAMETERS node. The device exposes a contiguous run of these (one per channel-strip effects slot), so address a slot by its index. Covers the six processors the Rodecaster effects engine exposes (reverb, echo/delay, pitch shift, distortion, robot, voice disguise), each with its *On enable plus its tone controls. effectsIdx echoes the slot index; channelInputSource (present only when the slot is bound) is the source the slot processes.
Fader
A fader strip: a physical or virtual channel the user mixes. The strip <-> wire-index map is model-dependent, so Fader::to_index and Fader::from_index both take a DeviceModel:
FxPresetParam
A per-effect-preset parameter: the flat properties on each FXPRESET node. Contents is the preset’s serialized data (typically a pipe-separated or JSON-ish blob); Idx is the preset slot ordinal.
GuiParam
A front-panel UI parameter: one of the flat properties the device carries on the single root GUI node. This is touchscreen / display state, not audio routing: screen + button brightness, the selected pad bank, the metering mode, and which EQ band the touchscreen EQ view is focused on.
HeadphoneParam
A per-headphone parameter: one of the flat properties the device carries on a HEADPHONE node. The device has one node per physical headphone jack (4 on the Pro II), so address a headphone by its index. headphoneColour is the jack’s LED ring colour (ARGB hex string); headphoneType selects the connected gear profile.
InputSourceParam
A per-input-source parameter: one of the flat properties the device carries on an INPUTSOURCE node (preamp gain, power/48V, mic type, phase, colour, wireless serial, SIP/RCV routing).
MasterParam
A master-bus parameter: one of the flat properties the device carries on the single MASTERCHANNEL node. There is exactly one master bus, so this family takes no addressing key (unlike crate::ChannelParam, which is per-fader). Covers the master Compellor (RODE’s compressor/leveller) and the master delay.
MeterParam
A per-meter parameter: one of the flat properties the device carries on each METER node (typically one per fader strip, though the exact count depends on firmware layout). Provides live L/R meter levels and peaks plus a stereo-pair flag. FaderLevel is a passthrough of the strip’s fader position (the same value that appears on the strip’s FADER node under PHYSICALINTERFACE).
MixMinusesParam
A mix-minus parameter: the one flat property on both MIXMINUSES and RCSYNCMIXMINUES nodes. Mix-minus routing produces a per-output send with the local channel subtracted (so a caller doesn’t hear their own voice returning via CallMe / SIP / rcSync mixes).
MixOutput
A mix output bus: where audio is routed to. Model-independent (13 buses). The protocol mix index equals enum order (Headphone1 = 0 .. CallMe3 = 12); it is the second dimension of the source-major mix matrix.
NetworkParam
A device-wide networking parameter: one of the flat properties the device carries on the singleton NETWORK node. Covers Bluetooth (visibility, scan trigger, pairing, connection state, ten scan result slots, five paired-device memory slots), cellular data (APN, IP config, USB modem presence), wired IP (gateway, DNS, static-IP toggle), WiFi (SSID, PSK, IP config, ten scan result slots, DHCP), and the wired-Ethernet connected flag. Un-typed properties fall back to NetworkParam::Other for forward-compat.
OutputParam
An output-bus parameter: one of the flat properties the device carries on the single OUTPUT node. There is exactly one, so this family takes no addressing key. Covers the monitor (speaker) output, the Bluetooth output, the multi-output mode, and the recording-bus flags the firmware co-locates on this node.
PadParam
A sound-pad parameter: one of the flat properties the device carries on one PAD node (nested under the single root SOUNDPADS node, one per pad). Pads are addressed by index; padIdx echoes that index. Covers the loaded sample + playback envelope, per-pad mixer routing (the padMixerBackChannel* sends), the trigger / MIDI mapping (padTrigger*), the SIP / phone-book binding (padSIP*), gain, colour and the effects input.
PadRecorderParam
A per-pad-recorder parameter: the flat properties on each PADRECORDER node. Read-back: Idx (which pad this recorder targets), State (current recording state), Seconds (elapsed recording duration), MemoryFull (out-of-space flag). Command channels: StateRequest (write to change recording state), Clear (write to erase the pad’s current recording).
PlayerParam
A player parameter: one of the flat properties the device carries on the single PLAYER node. There is exactly one long-form player, so this family takes no addressing key. Covers transport (state, speed, position/progress), the loaded file (path, size), the jump-to-sample command, and the in/out + fade envelope (playerEnv*).
RadioParam
A wireless-radio-pairing parameter: the three flat properties on the RADIO node. Pair and Unpair are command channels; Paired reports whether a transmitter is currently paired. These are device-side entrypoints for the RODE Wireless GO integration.
RadioRxParam
A per-receiver wireless-radio parameter: the one flat property on each RADIORX node. RadioId identifies which receiver this is.
RadioTxParam
A per-transmitter wireless-radio parameter: the flat properties on each RADIOTX node. Read-back state: battery level, charging state, connection status + connection id, device serial + type, RSSI, signal quality. Writable settings: gain assist, pad, remote mute, record.
RcSyncMixParam
A per-rcSync-mix parameter: the flat properties on each RCSYNCMIX node. Six wire names are shared with the regular MIX cell family (mixDisabled, mixLevelWithAnchor, mixLink, mixLinkRequest, mixMute, mixUnlinkRequest); mixRcSyncLevelRequest is rcSync-specific. The two node types are distinguished by path shape at decode time.
RecorderParam
A recorder parameter: one of the flat properties the device carries on the single RECORDER node. There is exactly one recorder, so this family takes no addressing key. The record* properties are read-back state (current transport, elapsed ms, byte rate); the request* properties are the write channel (set requestRecordState to start/stop recording, set requestDropMarker to drop a chapter marker).
RecordingParam
A per-recording parameter: one of the two flat properties the device carries on each RECORDING child node under the RECORDINGS container. Content arrives as a pipe-separated field string (name|hash|path|timestampMs|durationSec|flags...); the crate types the property name and leaves field parsing to the caller.
RecordingsParam
A recordings-container parameter: one of the flat properties the device carries on the singleton RECORDINGS node (the parent of individual RECORDING child nodes). Read-back state summarizes the collection (total count + total duration seconds). RequestDeleteUid is the write channel that removes a recording by its RecordingParam::Uid.
ShowControlParam
A show-lifecycle-command parameter: one of the flat properties the device carries on the singleton SHOWCONTROL node. This is the write channel for creating, deleting, exporting, and importing shows (showControlDelete, showControlExport, showControlImport, showControlNewFromDefault*), plus the read-back showControlProgress and showControlLastError for observing an in-progress action.
ShowParam
A per-show parameter: one of the flat properties the device carries on each SHOW child under the singleton SHOWS container. Uid is a stable integer; Uuid is a canonical string identifier; SnapshotIndex selects which snapshot of the show is active; LastModification is a wall-clock timestamp string.
SipAdvancedParam
A SIP advanced-settings parameter: one of the twenty-five flat properties the device carries on the singleton SIPADVANCED node. Every property in this family is empirically writable + persistent on Duo fw 1.7.3 (measured 2026-07-01). Groups: codec / feature flags (ForceCodecChoice, EnableVideoStream, EnableRFCDuplication, IncomingNameFilter, UsbNumberPad, NonHTTPSInterface, AutoReconnect); audio routing + DTMF (IncomingAudioRouting, DtmfMode); receive jitter buffer bounds; the sipAccount* config (username / password / domain / proxy / transport / auth), a NAT traversal block (sipNATTraversal*), the unit name, and the device’s rodeCallQuality read-back.
SipCallSlotsParam
A per-slot SIP call parameter: one of the twelve flat properties the device carries on each SIPCALLSLOTS node (three consecutive slots at root). Statistics (Quality, Jitter, Bitrate, PacketLoss) are device-managed. Disconnect is a Binary command channel (same request-pulse pattern as mixLinkRequest); Extend is a bool command. Identity/state fields (SlotId, State, UUID, Address, IsHost, Mode) reflect the call’s current status.
SipCallingParam
A SIP calling-level parameter: one of the fourteen flat properties the device carries on the singleton SIPCALLING node. Combines settings (HostingEnabled / HostingToggleEnabled / LicenceMode / LicenceCheck), device-managed read-back (RodeCode: the invite code; rotates on hosting toggle), incoming/outgoing call setup channels (JSON-ish strings), the pending-slot selector, subscription remaining-time meters, and the post-call rating write channel.
SipRegistrationParam
A per-registration SIP parameter: one of the three flat properties the device carries on each SIPREGISTRATION child under SIPCALLING. Index selects which registration slot; Details is the account registration payload; IsRegistered is the device-side registered flag (read-back: echoes whenever the SIP subsystem re-checks registration, including as a side effect of writes to SIPADVANCED account fields).
Source
An audio source: where audio comes from. Model-independent (19 sources, one shared device picker across the Pro family). The protocol source index equals enum order (Combo1 = 0 .. CallMe3 = 18); it is the first dimension (source-major) of the mix matrix.
StorageVolumeParam
A storage-volume parameter: one of the flat properties the device carries on each STORAGEVOLUME node. Read-back state describes the volume’s capacity, free bytes, mount + format status, and the pipe- separated storageVolumeState progress string that the device updates live during recording (total|used|f|f|f). Command channel props (Eject, Erase, Transfer) request device-side actions.
StreamerXMixPresetParam
A per-preset StreamerX mix preset parameter: the flat properties on each STREAMERXMIXPRESET node. Created reports whether the preset has been initialized; Name is the user-facing preset name.
StreamerXStreamMixParam
A per-stream StreamerX mix parameter: the one flat property on each STREAMERXSTREAMMIX node. Firmware wire name has a duplicated mix prefix (streammixmixLevel); preserved verbatim.
SystemParam
A device-wide system parameter: one of the flat properties the device carries on the single root SYSTEM node. This is global device state, not per-strip audio routing: identity (serial / firmware / board type), the firmware-update + download lifecycle, date/time + personalization settings, the global output disables, and USB / storage / sharing status.
TestParam
A device-diagnostic parameter: the two flat properties on the singleton TEST node. AllLedsWhite is a factory-test command (writing Int(1) engages the all-LEDs-white mode; verified on Duo fw 1.7.3, write persists across refresh); ToneGeneration selects an internal test-tone source for audio-path verification. Both wire types are Int; the crate types the property name only.
ThemeParam
A device-wide UI theme parameter: the one flat property the device carries on the singleton THEME node. Selects the current touchscreen theme (dark / light / etc: enum values are firmware-internal).
WifiScanResultParam
A per-WiFi-scan-result parameter: the one flat property on each WIFISCANRESULT node. The device populates these as WiFi scans complete. Value is a String encoded as SSID----ENCODING (the device appends the encryption type with a ---- separator).