Module ipc 

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.

AppSettingsParams

Complete application-local settings replacement.

BootstrapInfo

What the screen needs before it draws anything.

CalibrateParams

Optional settings for a calibration run.

CalibrationSettingsParams

Complete calibration settings replacement.

CalibrationSummary

The screen-facing summary of one calibration design.

CamillaDevices

Capture and playback backends for a CamillaDSP export.

ChannelResultLine

Values behind one channel’s metrics and filters lines.

ChannelScore

Before-and-after scorecard metrics for one speaker role.

ConfigBand

One configured output band.

ConfigGroup

One upstream speaker group in upstream order.

ConfigIndexParams

One speaker index.

ConfigMutationResult

Configuration after a destructive edit and its optional inverse token.

ConfigPresetParams

A preset change which may need measurement-clearing confirmation.

ConfigResult

Screen-facing editable speaker configuration.

ConfigSetSpeakerParams

Optional edits to one speaker or one of its bands.

ConfigSpeaker

One configured speaker.

ConfigSubCountParams

A sub-count change which may need measurement-clearing confirmation.

ConfigSummary

Values derived from the complete speaker configuration.

CurveAxes

Display limits; both endpoints are data values, not logarithms.

DialogOpenFileParams

Typed open-file dialog parameters.

DialogPickFolderParams

Optional starting folder for a folder picker.

DialogSaveFileParams

Typed save-file dialog parameters.

DialogSuggestedParams

Optional suggested name for a save dialog.

DspFields

The five manually editable DSP profile fields.

DspPreset

One DSP preset in the built-in table.

DspResult

Editable DSP state and derived resolution values.

DspSetParams

A preset selection or a complete manual edit.

ExportFolderResult

Current export base folder and whether it came from project storage.

ExportFolderSetParams

Export base-folder update.

ExportParams

The export bundle and destination folder.

ExportResult

Files written by a completed export job.

IpcError

A coded IPC failure with template parameters and diagnostic detail.

JobCancelParams

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.

LayoutArrangement

One supported measurement arrangement.

LayoutMutationResult

Arrangement after editing and its optional inverse token.

LayoutPoint

One measurement microphone point in centimetres.

LayoutResult

Editable arrangement and measurement options.

LayoutSetParams

Optional arrangement and timing edits.

LayoutTiming

Measurement timing-reference settings stored under extra.devices.

LevelMonitorStartParams

Optional role to associate with a level-monitor start.

LevelPlayParams

Role and output level for one 2.5-second level-check burst.

LevelsResult

Stored level-check readings, keyed by measurement role (upstream extra['levels']).

LocalApiSettings

Opt-in loopback API settings.

LocalApiStatus

App-facing state of the opt-in local API server.

MdatAssignment

An mdat measurement assigned to a speaker role.

MdatImportParams

An mdat file, its assignments, and destination position.

MdatScanMeasurement

One scanned measurement with an unambiguous row identifier.

MdatScanParams

The REW mdat file to scan.

MdatScanResult

Measurements, suggested assignments, and problem codes found in an mdat file.

MeasureConfigResult

The active measurement settings.

MeasureConfigureParams

Measurement method and device settings.

MeasureDevice

An enumerated native audio endpoint.

MeasureMethodsResult

Measurement methods available on this host.

MeasurePositionParams

The measurement position to record.

MeasurementCurve

A measurement curve, already smoothed and normalized to the mid-band mean.

MeasurementCurvesParams

Optional measurement selection; an absent selection includes every recorded pair.

MeasurementCurvesResult

Measurement graph data.

MeasurementRecordsResult

Recording status for the complete measurement arrangement.

MetricsSummary

The upstream Metrics fields for one response.

MicCalibrationFile

A validated microphone calibration file selected for the open project.

MicCalibrationSetParams

A microphone calibration file selected by full path.

MicCalibrationStatus

Selected microphone calibration and recorded-measurement attachment counts.

MigrationWarning

A project migration warning code and affected entry.

MimoParams

Optional settings for a MIMO run.

MimoSummary

The screen-facing summary of one MIMO run.

ModeSpecParams

Mode whose numeric specification should be returned.

ModeSpecResult

Presentation-neutral values underlying the upstream mode specification line.

Notice

A presentation-neutral note or warning code with template parameters.

OpenFolderParams

Folder to reveal in the operating-system file manager.

PathParams

A filesystem path used by a project editor.

PathResult

A path written by an editor.

Platform

The operating-system platform running the service.

PositionClearParams

The measurement position to clear.

PositionEstimateResult

Position-duration estimate from upstream step 4 semantics.

PositionRecord

Recording status and upstream source values for one arranged position.

ProjectInfo

Screen-facing information about the open project.

ProjectNewParams

Inputs for creating a project.

ProjectPathParams

A project file path.

ProjectSaveParams

Inputs for saving the open project.

ResultCurve

One named series on a result graph.

ResultCurvesParams

Selection for one ready-to-draw result graph.

ResultCurvesResult

A result graph whose calculations are entirely owned by the service.

ResultLinesResult

Numeric calibration summary lines; no localized sentences cross IPC.

ResultsSummary

The latest calibration and MIMO results.

RewDeviceInfo

RewDriverSetParams

A requested REW audio driver.

RewInfoResult

Facts from REW, distinct from project-stored measurement preferences.

RewStatusResult

Whether REW is running, reachable, and licensed as Pro.

RewSweepInfo

SampleLoadParams

Inputs for loading embedded or synthetic sample measurements.

SubLayoutLine

A typed BA layout summary.

SubResultLines

BA metrics and table, independent of the selected main channel.

SubResultRow

One sub’s output alignment and fixed filters.

TargetPointsParams

Target control points.

TargetPresetParams

One built-in target preset selection.

TargetResult

Target curve, selected preset, and built-in preset table.

UndoParams

A service-issued undo token.

UndoResult

An undo token and the project state it restores.

UpstreamBase

The upstream SECS 2 release a build is ported from (UPSTREAM.toml).

VerdictSummary

Values shown by the upstream step_calibration.py verdict 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.

CamillaCaptureDevice

CamillaDSP capture backend. Channel counts come from the export plan.

CamillaPlaybackDevice

CamillaDSP playback backend. Channel counts come from the export plan.

CamillaWasapiFormat

Sample formats accepted by CamillaDSP’s Wasapi backend.

Envelope

The reply to every call: {"ok": true, "data": ...} or {"ok": false, "error": ...}.

ErrorCode

Why a call failed. The screen maps each code to a written message with the cause and the next action.

ExportBlock

Why a filter export cannot carry the current result (upstream calibration.filter_export_block).

ExportKind

The supported export bundle.

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.

MdatScope

What the REW mdat export (ExportKind::BeforeAfterMdat) carries (docs/DEVIATIONS.md F19). The file name says which: 원 측정 for the measurements, 보정 결과 for the computed responses.

MimoExportDecision

Whether the MIMO result goes into an export, and if not, why.

OpenFileKind

The kind of file a host open dialog accepts.

Request

A call from the screen.

Response

The successful result of a Request, tagged with the same method name.

ResultTab

The calibration graph to display.

SaveFileKind

The kind of file a host save dialog accepts.

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: whether kind can 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, and secs-filters/tests/eqapo_playback.rs plays them through the engine (DEVIATIONS F12). The screen mirrors this rule (screens/export/types.ts).