@freemixer/server

The openmixer server. It wires a chosen device adapter into core's MixerEngine and exposes it to the browser surface over a single REST entity API (rest-router.ts, mounted under /api): GET/PATCH for state, GET ?watch=1 for a live Server-Sent Events stream of the same resource. The surface and engine never know which console is behind the adapter — only the adapter does.

 web-ui  ──GET/PATCH /api/*──────▶  @freemixer/server  ──▶  MixerEngine (@freemixer/core)
         ──GET /api/*?watch=1 (SSE)──▶    │                       │
                                          │           MixerAdapter (midas | x32 | roland | software | mock)
                                          └── GET /health ────────┘
Copy

What it does

• Instantiates the configured adapter, wraps it in a MixerEngine.
• GET /health → { ok, model, connected } (connected = adapter.checkConnection()).
• The REST entity layer (rest-router.ts, prefix /api) is the primary control surface: every entity supports GET (seed state, ?watch=1 for SSE) and PATCH (apply a delta, answered by the re-read state). This is what the web UI's useResource composable talks to.
• Forwards every engine event to every open SSE stream, so a device-side change (or another control source) shows up live in every browser.

Configuration

Everything is configuration — nothing about a device is hard-coded. Build a ServerConfig from a plain object (parseConfig) or the environment (configFromEnv):

See src/config.ts for the full, authoritative list.

Run

OPENMIXER_ADAPTER=midas OPENMIXER_DEVICE_HOST=192.0.2.5 OPENMIXER_DEVICE_PORT=10002 openmixer-server
Copy

Or embed it:

import { MixerServer, parseConfig } from '@freemixer/server';
const server = new MixerServer({ config: parseConfig({ adapter: 'mock' }) });
await server.start();
Copy

Adapters are loaded lazily

The real device adapters (@freemixer/adapter-midas, -x32, -roland) live in this monorepo as separate packages, but the server never statically imports them: it codes to the @freemixer/core MixerAdapter interface and resolves the concrete adapter with a guarded dynamic import() only when that adapter is selected (adapter-loader.ts) — so this package builds and tests with no adapter packages installed as a runtime dependency. Selecting a name whose package isn't installed fails at boot with an actionable error. The built-in MockAdapter (hardware-free) ships here as the default and as the test surface; software (the PipeWire-native @freemixer/audio-engine mixer) is also built in.

Test

pnpm -F @freemixer/server test
Copy

Tests boot a real server with the MockAdapter and drive it over real HTTP: a PATCH /api/* reaches the adapter's setFader/setMute, and a device-side push (via the adapter's MixerReceiver) shows up on a GET /api/*?watch=1 SSE stream. No hardware.

License

GPL-3.0-or-later. © Pau Aliagas linuxnow@gmail.com.