Expand description
IPC between the screen and the service.
The screen sends a Request as {"method": "...", "params": {...}} and
always receives an envelope: {"ok": true, "data": Response} or
{"ok": false, "error": IpcError}. The service never throws across this
seam. Long jobs report progress through the event sink supplied with the call.
Errors carry a code and parameters, not prose: the screen turns them into
a sentence in the current language and keeps detail (the raw text) for
the details view and the log.
Re-exports§
pub use crate::settings_edit::CalibrationSettingsEditParams;
Structs§
- AppSettings
- Application-local settings, independent of an open project.
- AppSettings
Params - Complete application-local settings replacement.
- Apply
Camilla Params - Optional device choices for a CamillaDSP application export.
- Apply
Result - Completed application job result.
- Apply
Settings - Settings for applying designs to external processors.
- Apply
Status - Current state of both application targets.
- Bootstrap
Info - What the screen needs before it draws anything.
- Calibrate
Params - Optional settings for a calibration run.
- Calibration
Settings Params - Complete calibration settings replacement.
- Calibration
Summary - The screen-facing summary of one calibration design.
- Camilla
Apply - CamillaDSP application settings.
- Camilla
Apply Status - Reachability and running design reported by CamillaDSP.
- Camilla
Devices - Capture and playback backends for a CamillaDSP export.
- Camilla
Status - CamillaDSP status mirrored from the platform-neutral application client.
- Channel
Result Line - Values behind one channel’s metrics and filters lines.
- Channel
Score - Before-and-after scorecard metrics for one speaker role.
- Config
Band - One configured output band.
- Config
Group - One upstream speaker group in upstream order.
- Config
Index Params - One speaker index.
- Config
Mutation Result - Configuration after a destructive edit and its optional inverse token.
- Config
Preset Params - A preset change which may need measurement-clearing confirmation.
- Config
Result - Screen-facing editable speaker configuration.
- Config
SetSpeaker Params - Optional edits to one speaker or one of its bands.
- Config
Speaker - One configured speaker.
- Config
SubCount Params - A sub-count change which may need measurement-clearing confirmation.
- Config
Summary - Values derived from the complete speaker configuration.
- Curve
Axes - Display limits; both endpoints are data values, not logarithms.
- Curve
Reference - The stored measurement that sets zero dB for every displayed curve.
- Dialog
Open File Params - Typed open-file dialog parameters.
- Dialog
Pick Folder Params - Optional starting folder for a folder picker.
- Dialog
Save File Params - Typed save-file dialog parameters.
- Dialog
Suggested Params - Optional suggested name for a save dialog.
- DspFields
- The manually editable DSP profile fields.
- DspPreset
- One DSP preset in the built-in table.
- DspResult
- Editable DSP state and derived resolution values.
- DspSet
Params - A preset selection or a complete manual edit.
- EqApo
Apply - Equalizer APO application settings.
- EqApo
Apply Status - Installed and applied state of Equalizer APO.
- EqApo
Install - Equalizer APO installation values supplied by the operating-system adapter.
- Export
Folder Result - Current export base folder and whether it came from project storage.
- Export
Folder SetParams - Export base-folder update.
- Export
Params - The export bundle and destination folder.
- Export
Result - Files written by a completed export job.
- Host
LogLine - One JSON Lines entry from the managed host log.
- Host
Managed - Targets persisted by the host service.
- Host
Status - Status returned by the managed host service.
- IpcError
- A coded IPC failure with template parameters and diagnostic detail.
- JobCancel
Params - The job to cancel.
- JobId
- A service-assigned long-running job identifier.
- JobProgress
- Progress within one named job stage.
- JobSnapshot
- The latest observable state of a job.
- JobStarted
- The immediate response after a job starts.
- Late
Energy - Late 20–150 Hz energy for one main role at one measured position.
- Layout
Arrangement - One supported measurement arrangement.
- Layout
Mutation Result - Arrangement after editing and its optional inverse token.
- Layout
Point - One measurement microphone point in centimetres.
- Layout
Result - Editable arrangement and measurement options.
- Layout
SetParams - Optional arrangement and timing edits.
- Layout
Timing - Measurement timing-reference settings stored under
extra.devices. - Level
Monitor Start Params - Optional role to associate with a level-monitor start.
- Level
Play Params - Role and output level for one 2.5-second level-check burst.
- Levels
Result - Stored level-check readings, keyed by measurement role (upstream
extra['levels']). - Local
ApiSettings - Opt-in loopback API settings.
- Local
ApiStatus - App-facing state of the opt-in local API server.
- Managed
Camilla - One CamillaDSP process kept running by the host service.
- Managed
EqApo - One Equalizer APO include kept intact by the host service.
- Managed
Process - Current CamillaDSP supervision state.
- Mdat
Assignment - An mdat measurement assigned to a speaker role.
- Mdat
Import Params - An mdat file, its assignments, and destination position.
- Mdat
Scan Measurement - One scanned measurement with an unambiguous row identifier.
- Mdat
Scan Params - The REW mdat file to scan.
- Mdat
Scan Result - Measurements, suggested assignments, and problem codes found in an mdat file.
- Measure
Config Result - The active measurement settings.
- Measure
Configure Params - Measurement method and device settings.
- Measure
Device - An enumerated native audio endpoint.
- Measure
Methods Result - Measurement methods available on this host.
- Measure
Position Params - The measurement position to record.
- Measurement
Curve - A smoothed measurement curve shifted by the result’s shared reference.
- Measurement
Curves Params - Optional measurement selection; an absent selection includes every recorded pair.
- Measurement
Curves Result - Measurement graph data.
- Measurement
Records Result - Recording status for the complete measurement arrangement.
- Metrics
Summary - The upstream
Metricsfields for one response. - MicCalibration
File - A validated microphone calibration file selected for the open project.
- MicCalibration
SetParams - A microphone calibration file selected by full path.
- MicCalibration
Status - Selected microphone calibration and recorded-measurement attachment counts.
- Migration
Warning - A project migration warning code and affected entry.
- Mimo
Channel Score - Scorecard metrics after MIMO for one main role.
- Mimo
Late Energy - Late 20–150 Hz energy after MIMO for one main role and measured position.
- Mimo
Params - Optional settings for a MIMO run.
- Mimo
Summary - The screen-facing summary of one MIMO run.
- Mode
Spec Params - Mode whose numeric specification should be returned.
- Mode
Spec Result - Presentation-neutral values underlying the upstream mode specification line.
- Notice
- A presentation-neutral note or warning code with template parameters.
- Open
Folder Params - Folder to reveal in the operating-system file manager.
- Path
Params - A filesystem path used by a project editor.
- Path
Result - A path written by an editor.
- Pending
Update - A downloaded release waiting for its first start:
update.jsonin the app’s config folder, written by the app or the host shell and read by the app on its next start. Not sent over IPC. - Platform
- The operating-system platform running the service.
- Position
Clear Params - The measurement position to clear.
- Position
Estimate Result - Position-duration estimate from upstream step 4 semantics.
- Position
Record - Recording status and upstream source values for one arranged position.
- Project
Info - Screen-facing information about the open project.
- Project
NewParams - Inputs for creating a project.
- Project
Path Params - A project file path.
- Project
Save Params - Inputs for saving the open project.
- Result
Curve - One named series on a result graph.
- Result
Curves Params - Selection for one ready-to-draw result graph.
- Result
Curves Result - A result graph whose calculations are entirely owned by the service.
- Result
Lines Result - Numeric calibration summary lines; no localized sentences cross IPC.
- Results
Summary - The latest calibration and MIMO results.
- RewDevice
Info - RewDriver
SetParams - A requested REW audio driver.
- RewInfo
Result - Facts from REW, distinct from project-stored measurement preferences.
- RewStatus
Result - Whether REW is running, reachable, and licensed as Pro.
- RewSweep
Info - Sample
Load Params - Inputs for loading embedded or synthetic sample measurements.
- SubLayout
Line - A typed BA layout summary.
- SubResult
Lines - BA metrics and table, independent of the selected main channel.
- SubResult
Row - One sub’s output alignment and fixed filters.
- Target
Points Params - Target control points.
- Target
Preset Params - One built-in target preset selection.
- Target
Result - Target curve, selected preset, and built-in preset table.
- Undo
Params - A service-issued undo token.
- Undo
Result - An undo token and the project state it restores.
- Update
Notice - Shown once when the app starts a newer version than it ran last time.
- Update
Open Release Params - The release whose page
Request::UpdateOpenReleaseopens. - Update
Status - Application update state for the screen.
- Upstream
Base - The upstream SECS 2 release a build is ported from (
UPSTREAM.toml). - Verdict
Summary - Values shown by the upstream
step_calibration.pyverdict card. - XoRecommendation
- Crossover candidates and the best value for each group.
Enums§
- AppIcon
- The logo on the rail and the window (docs/DEVIATIONS.md U12). The
installed program’s own icon is always
Expert. - AppSkin
- The skin set the screen draws with (docs/skins, ADR 0010).
- AppTheme
- Application theme preference.
- Apply
Level - How far SECS 2R controls one application target.
- Apply
Outcome - Result of applying an exported design.
- Camilla
Capture Device - CamillaDSP capture backend. Channel counts come from the export plan.
- Camilla
Playback Device - CamillaDSP playback backend. Channel counts come from the export plan.
- Camilla
Wasapi Format - Sample formats accepted by CamillaDSP’s Wasapi backend.
- Curve
Reference Band - Frequency band used to set zero dB on the measurement graph.
- Design
Match - How the running CamillaDSP configuration compares with the current result.
- Envelope
- The reply to every call:
{"ok": true, "data": ...}or{"ok": false, "error": ...}. - EqApo
Variant - Equalizer APO edition detected from its installed path.
- Error
Code - Why a call failed. The screen maps each code to a written message with the cause and the next action.
- Export
Block - Why a filter export cannot carry the current result (upstream
calibration.filter_export_block). - Export
Kind - The supported export bundle.
- Host
Request - A request sent over the local managed-host pipe.
- Host
Response - One response returned over the local managed-host pipe.
- Include
State - State of SECS 2R’s managed lines in Equalizer APO’s
config.txt. - JobEvent
- A pushed lifecycle event for a long-running job.
- JobKind
- The operation performed by a long-running job.
- JobResult
- The successful result produced by a job.
- JobStatus
- The current lifecycle state of a job.
- Managed
Process State - Why a managed CamillaDSP process is not simply running.
- Mdat
Scope - What the REW mdat export (
ExportKind::BeforeAfterMdat) carries (docs/DEVIATIONS.md F19). The file name says which:원 측정for the measurements,보정 결과for the computed responses. - Mimo
Export Decision - Whether the MIMO result goes into an export, and if not, why.
- Open
File Kind - The kind of file a host open dialog accepts.
- Output
Rate Choice - Output sample-rate selection stored with a DSP profile.
- Request
- A call from the screen.
- Response
- The successful result of a
Request, tagged with the same method name. - Result
Tab - The calibration graph to display.
- Save
File Kind - The kind of file a host save dialog accepts.
- Service
State - Windows service state visible to the app before a pipe call.
- Update
Install - When a downloaded release is installed.
- Update
Phase - Where the application update stands.
- Update
Policy - When SECS 2R looks for and installs new releases (ADR 0020).
Functions§
- export_
block - Whether an export format can carry the current result. Stale cached
calibration blocks mdat; filter formats retain
filter_export_block. - filter_
export_ block - Upstream
filter_export_block: whetherkindcan carry a result with subs (has_subs) and MIMO support paths (has_mimo). CamillaDSP, the mdat exports, Equalizer APO and convolution carry everything; filter text carries RC only (subs are checked first, as upstream). Upstream stops MIMO at Equalizer APO as well; its writer already routes the support paths, andsecs-filters/tests/eqapo_playback.rsplays them through the engine (DEVIATIONS F12). The screen mirrors this rule (screens/export/types.ts).