openmixer — generated API reference
    Preparing search index...

    Interface StartConsoleOptions

    Options for startConsole.

    interface StartConsoleOptions {
        binName?: string;
        config: {
            adapter: "x32" | "midas" | "roland" | "software";
            device: { host: string; options: Record<string, unknown>; port?: number };
            rig: {
                catalog?: string;
                console?: string;
                demoSources?: boolean;
                gig?: string;
                preset?: "bare" | "demo" | "console";
            };
            web: { host: string; manualDir?: string; port: number };
        };
        env?: ProcessEnv;
        nativeEngine?: NativeEngineLoaders;
        net: RuntimeNetwork;
        reacPwConfDir?: string;
    }
    Index
    binName? config env? nativeEngine? net reacPwConfDir?
    binName?: string

    The bin name printed in the final "listening" line. Default openmixer-server.

    config: {
        adapter: "x32" | "midas" | "roland" | "software";
        device: { host: string; options: Record<string, unknown>; port?: number };
        rig: {
            catalog?: string;
            console?: string;
            demoSources?: boolean;
            gig?: string;
            preset?: "bare" | "demo" | "console";
        };
        web: { host: string; manualDir?: string; port: number };
    }

    The resolved server config (a console rig preset; web already overlaid).

    env?: ProcessEnv

    The env the rig's remaining knobs are read from. Default process.env.

    nativeEngine?: NativeEngineLoaders

    Native-engine loaders — a TEST SEAM (see NativeEngineLoaders), never configuration.

    net: RuntimeNetwork

    The resolved runtime network (web binding + state dir + settings file).

    reacPwConfDir?: string

    Where the boot-time REAC role projection reads/writes segment files — a TEST SEAM, never configuration: the operator's reac-pw layered conf has exactly one home (REAC_PW_CONF_DIR, master-arbitration's "the console's ONE door"), and a real boot outside a test must never take another path to it. Default REAC_PW_CONF_DIR.

    Settings
    Member Visibility

    On This Page
    Properties