openmixer — generated API reference
    Preparing search index...

    Interface SurfaceTemplate

    One ready-made preset for a control surface, selectable in the Setup menu.

    interface SurfaceTemplate {
        adapterType: string;
        description?: string;
        id: string;
        name: string;
        settings: Readonly<Record<string, unknown>>;
        transportHint: string;
    }
    Index
    adapterType description? id name settings transportHint
    adapterType: string

    The registered adapter type this template configures.

    description?: string

    Short description of the physical surface.

    id: string

    Stable catalog key (not persisted — only the resulting adapter.add is).

    name: string

    Human label for the picker, e.g. "Behringer X-Touch (MCU)".

    settings: Readonly<Record<string, unknown>>

    Default settings seeded into the add form / adapter.add call.

    transportHint: string

    Human-readable transport note shown in the picker (MIDI carriage, mode, …).

    Settings
    Member Visibility

    On This Page
    Properties