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§
- Parse
Fader Error - Error returned when parsing an invalid fader name.
- Parse
MixOutput Error - Error returned when parsing an invalid mix output name.
- Parse
Source Error - 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
APPnode. 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. - Audio
Param - A device-wide audio-engine parameter: one of the flat properties the
device carries on the singleton
AUDIOnode. 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 asAudioParam::Otherfor forward-compat. - Build
Param - A device-wide firmware-build metadata parameter: one of the flat
properties the device carries on the singleton
BUILDnode. 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. - Channel
Param - A per-channel-strip parameter: one of the flat properties the device
carries on a
CHANNELnode (the EQ, dynamics, HPF, aphex, pan and tone controls for one fader). - Current
Show Param - A currently-loaded-show parameter: one of the flat properties the
device carries on the singleton
CURRENTSHOWnode. Reflects whichShowParam-addressed show is currently active on the device. - Device
Model - Which RODECaster a fullSync came from. Detected from the
SYSTEMnode; selects the per-modelFaderlayout. - Ducker
Param - A ducker parameter: the flat property the device carries on the single
DUCKERnode. There is exactly one ducker, so this family takes no addressing key. Auto-ducking lowers other faders when a mic-flagged source is active;duckerDepthis how far (in dB) it pulls them down. - Effects
Param - A per-slot effects parameter: one of the flat properties the device
carries on a root
EFFECTS_PARAMETERSnode. 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*Onenable plus its tone controls.effectsIdxechoes 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_indexandFader::from_indexboth take aDeviceModel: - FxPreset
Param - A per-effect-preset parameter: the flat properties on each
FXPRESETnode.Contentsis the preset’s serialized data (typically a pipe-separated or JSON-ish blob);Idxis the preset slot ordinal. - GuiParam
- A front-panel UI parameter: one of the flat properties the device carries
on the single root
GUInode. 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. - Headphone
Param - A per-headphone parameter: one of the flat properties the device carries
on a
HEADPHONEnode. The device has one node per physical headphone jack (4 on the Pro II), so address a headphone by its index.headphoneColouris the jack’s LED ring colour (ARGB hex string);headphoneTypeselects the connected gear profile. - Input
Source Param - A per-input-source parameter: one of the flat properties the device
carries on an
INPUTSOURCEnode (preamp gain, power/48V, mic type, phase, colour, wireless serial, SIP/RCV routing). - Master
Param - A master-bus parameter: one of the flat properties the device carries on
the single
MASTERCHANNELnode. There is exactly one master bus, so this family takes no addressing key (unlikecrate::ChannelParam, which is per-fader). Covers the master Compellor (RODE’s compressor/leveller) and the master delay. - Meter
Param - A per-meter parameter: one of the flat properties the device carries
on each
METERnode (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.FaderLevelis a passthrough of the strip’s fader position (the same value that appears on the strip’sFADERnode underPHYSICALINTERFACE). - MixMinuses
Param - A mix-minus parameter: the one flat property on both
MIXMINUSESandRCSYNCMIXMINUESnodes. 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. - Network
Param - A device-wide networking parameter: one of the flat properties the
device carries on the singleton
NETWORKnode. 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 toNetworkParam::Otherfor forward-compat. - Output
Param - An output-bus parameter: one of the flat properties the device carries on
the single
OUTPUTnode. 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
PADnode (nested under the single rootSOUNDPADSnode, one per pad). Pads are addressed by index;padIdxechoes that index. Covers the loaded sample + playback envelope, per-pad mixer routing (thepadMixerBackChannel*sends), the trigger / MIDI mapping (padTrigger*), the SIP / phone-book binding (padSIP*), gain, colour and the effects input. - PadRecorder
Param - A per-pad-recorder parameter: the flat properties on each
PADRECORDERnode. 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). - Player
Param - A player parameter: one of the flat properties the device carries on the
single
PLAYERnode. 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*). - Radio
Param - A wireless-radio-pairing parameter: the three flat properties on the
RADIOnode.PairandUnpairare command channels;Pairedreports whether a transmitter is currently paired. These are device-side entrypoints for the RODE Wireless GO integration. - Radio
RxParam - A per-receiver wireless-radio parameter: the one flat property on
each
RADIORXnode.RadioIdidentifies which receiver this is. - Radio
TxParam - A per-transmitter wireless-radio parameter: the flat properties on
each
RADIOTXnode. 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. - RcSync
MixParam - A per-rcSync-mix parameter: the flat properties on each
RCSYNCMIXnode. Six wire names are shared with the regularMIXcell family (mixDisabled,mixLevelWithAnchor,mixLink,mixLinkRequest,mixMute,mixUnlinkRequest);mixRcSyncLevelRequestis rcSync-specific. The two node types are distinguished by path shape at decode time. - Recorder
Param - A recorder parameter: one of the flat properties the device carries on
the single
RECORDERnode. There is exactly one recorder, so this family takes no addressing key. Therecord*properties are read-back state (current transport, elapsed ms, byte rate); therequest*properties are the write channel (setrequestRecordStateto start/stop recording, setrequestDropMarkerto drop a chapter marker). - Recording
Param - A per-recording parameter: one of the two flat properties the device
carries on each
RECORDINGchild node under theRECORDINGScontainer.Contentarrives 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. - Recordings
Param - A recordings-container parameter: one of the flat properties the device
carries on the singleton
RECORDINGSnode (the parent of individualRECORDINGchild nodes). Read-back state summarizes the collection (total count + total duration seconds).RequestDeleteUidis the write channel that removes a recording by itsRecordingParam::Uid. - Show
Control Param - A show-lifecycle-command parameter: one of the flat properties the
device carries on the singleton
SHOWCONTROLnode. This is the write channel for creating, deleting, exporting, and importing shows (showControlDelete,showControlExport,showControlImport,showControlNewFromDefault*), plus the read-backshowControlProgressandshowControlLastErrorfor observing an in-progress action. - Show
Param - A per-show parameter: one of the flat properties the device carries on
each
SHOWchild under the singletonSHOWScontainer.Uidis a stable integer;Uuidis a canonical string identifier;SnapshotIndexselects which snapshot of the show is active;LastModificationis a wall-clock timestamp string. - SipAdvanced
Param - A SIP advanced-settings parameter: one of the twenty-five flat
properties the device carries on the singleton
SIPADVANCEDnode. 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. - SipCall
Slots Param - A per-slot SIP call parameter: one of the twelve flat properties the
device carries on each
SIPCALLSLOTSnode (three consecutive slots at root). Statistics (Quality,Jitter,Bitrate,PacketLoss) are device-managed.Disconnectis aBinarycommand channel (same request-pulse pattern asmixLinkRequest);Extendis a bool command. Identity/state fields (SlotId,State,UUID,Address,IsHost,Mode) reflect the call’s current status. - SipCalling
Param - A SIP calling-level parameter: one of the fourteen flat properties the
device carries on the singleton
SIPCALLINGnode. 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. - SipRegistration
Param - A per-registration SIP parameter: one of the three flat properties the
device carries on each
SIPREGISTRATIONchild underSIPCALLING.Indexselects which registration slot;Detailsis the account registration payload;IsRegisteredis 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. - Storage
Volume Param - A storage-volume parameter: one of the flat properties the device
carries on each
STORAGEVOLUMEnode. Read-back state describes the volume’s capacity, free bytes, mount + format status, and the pipe- separatedstorageVolumeStateprogress string that the device updates live during recording (total|used|f|f|f). Command channel props (Eject,Erase,Transfer) request device-side actions. - StreamerX
MixPreset Param - A per-preset StreamerX mix preset parameter: the flat properties on
each
STREAMERXMIXPRESETnode.Createdreports whether the preset has been initialized;Nameis the user-facing preset name. - StreamerX
Stream MixParam - A per-stream StreamerX mix parameter: the one flat property on each
STREAMERXSTREAMMIXnode. Firmware wire name has a duplicatedmixprefix (streammixmixLevel); preserved verbatim. - System
Param - A device-wide system parameter: one of the flat properties the device
carries on the single root
SYSTEMnode. 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. - Test
Param - A device-diagnostic parameter: the two flat properties on the
singleton
TESTnode.AllLedsWhiteis a factory-test command (writingInt(1)engages the all-LEDs-white mode; verified on Duo fw 1.7.3, write persists across refresh);ToneGenerationselects an internal test-tone source for audio-path verification. Both wire types areInt; the crate types the property name only. - Theme
Param - A device-wide UI theme parameter: the one flat property the device
carries on the singleton
THEMEnode. Selects the current touchscreen theme (dark / light / etc: enum values are firmware-internal). - Wifi
Scan Result Param - A per-WiFi-scan-result parameter: the one flat property on each
WIFISCANRESULTnode. The device populates these as WiFi scans complete. Value is a String encoded asSSID----ENCODING(the device appends the encryption type with a----separator).