Skip to main content

rodecaster_protocol/names/
mod.rs

1//! Named Rodecaster entities: the typed vocabulary the public API speaks.
2//!
3//! ## Why names, not indices
4//!
5//! On the wire every entity is purely positional: a source is "the Nth
6//! `INPUTSOURCE` node", a mix cell is "source-major cell N", a fader is "the
7//! Nth `FADER` node". Those ordinals are an implementation detail of the JUCE
8//! tree, not a stable contract: they shift with firmware and differ across
9//! device models. This module pins each ordinal to a *named* entity
10//! ([`Source`], [`MixOutput`], [`Fader`]) so consumers address "Combo 1" or
11//! "Virtual 2", never a bare `7`.
12//!
13//! The name <-> ordinal mapping is irreducible reverse-engineering knowledge:
14//! the nodes carry no labels, so it cannot be recovered from a fullSync. It
15//! lives here as data.
16//!
17//! ## Per-model split
18//!
19//! [`Source`] (19) and [`MixOutput`] (13) are model-independent: the RODECaster
20//! Pro family shares one source/output vocabulary (one shared device picker).
21//! Only [`Fader`] differs: the Pro II exposes 6 physical + 3 virtual strips,
22//! the Duo 4 physical + 5 virtual. So the fader name <-> index map is
23//! parameterized by [`DeviceModel`], which [`crate::Layout`] detects from the
24//! fullSync's `SYSTEM` node.
25//!
26//! ## Module layout
27//!
28//! `macros` defines the one `wire_param_enum!` macro; `core` holds the
29//! model-independent vocabulary ([`DeviceModel`], [`MixOutput`], [`Source`],
30//! [`Fader`]); and each node-scoped property family lives in its own file
31//! (`channel`, `input_source`, `master`, ...). Every type is re-exported here so
32//! the public path stays `crate::names::X`.
33
34#[macro_use]
35mod macros;
36
37mod app;
38mod audio;
39mod build;
40mod channel;
41mod core;
42mod ducker;
43mod effects;
44mod fx_preset;
45mod gui;
46mod headphone;
47mod input_source;
48mod master;
49mod meter;
50mod mix_minuses;
51mod network;
52mod output;
53mod pad;
54mod pad_recorder;
55mod player;
56mod radio;
57mod rcsync;
58mod recorder;
59mod recording;
60mod show;
61mod sip;
62mod storage;
63mod streamerx;
64mod system;
65mod test;
66mod theme;
67mod wifi_scan_result;
68
69pub use app::AppParam;
70pub use audio::AudioParam;
71pub use build::BuildParam;
72pub use channel::ChannelParam;
73pub use core::{
74    DeviceModel, Fader, MixOutput, ParseFaderError, ParseMixOutputError, ParseSourceError, Source,
75};
76pub use ducker::DuckerParam;
77pub use effects::EffectsParam;
78pub use fx_preset::FxPresetParam;
79pub use gui::GuiParam;
80pub use headphone::HeadphoneParam;
81pub use input_source::InputSourceParam;
82pub use master::MasterParam;
83pub use meter::MeterParam;
84pub use mix_minuses::MixMinusesParam;
85pub use network::NetworkParam;
86pub use output::OutputParam;
87pub use pad::PadParam;
88pub use pad_recorder::PadRecorderParam;
89pub use player::PlayerParam;
90pub use radio::{RadioParam, RadioRxParam, RadioTxParam};
91pub use rcsync::RcSyncMixParam;
92pub use recorder::RecorderParam;
93pub use recording::{RecordingParam, RecordingsParam};
94pub use show::{CurrentShowParam, ShowControlParam, ShowParam};
95pub use sip::{SipAdvancedParam, SipCallSlotsParam, SipCallingParam, SipRegistrationParam};
96pub use storage::StorageVolumeParam;
97pub use streamerx::{StreamerXMixPresetParam, StreamerXStreamMixParam};
98pub use system::SystemParam;
99pub use test::TestParam;
100pub use theme::ThemeParam;
101pub use wifi_scan_result::WifiScanResultParam;