openmixer — generated API reference
    Preparing search index...

    Interface AdapterConfig

    One declarative adapter entry — exactly what is persisted to the config file.

    interface AdapterConfig {
        enabled: boolean;
        id: string;
        role?: AdapterRole;
        settings: Readonly<Record<string, unknown>>;
        type: string;
    }
    Index
    enabled: boolean

    Whether the manager instantiates + starts this entry on load.

    id: string

    Stable id (assigned on add; survives restarts; keys the config file).

    DSP-ownership role of the bound endpoint (AdapterRole): 'server' = openmixer owns the DSP (software/mock engines), 'client' = a remote desk owns it (midas/x32/ roland). Declared by the factory's family, not free-form config; optional here so existing persisted config files stay valid — an omitted role means "whatever the factory's family declares" (the instantiated MixerAdapter.role is the truth).

    settings: Readonly<Record<string, unknown>>

    Type-specific settings (validated by the factory's AdapterSettingsSchema).

    type: string

    The adapter family — selects the factory.