openmixer — generated API reference
    Preparing search index...

    Interface MainAutorouteOptions

    Options for MixerServer.autorouteMainOutput (the startup main → default-sink route).

    interface MainAutorouteOptions {
        avoidSinkIds?: readonly string[];
        log?: (message: string) => void;
        replaceable?: readonly Partial<Record<ChannelRole, string>>[];
        resolveDefaultSink?: () => Promise<string | undefined>;
    }
    Index
    avoidSinkIds? log? replaceable? resolveDefaultSink?
    avoidSinkIds?: readonly string[]

    Sink ids never to auto-pick — the demo passes its own virtual nodes (their loopback sink sides are enumerated as patchable sinks; auto-routing the main into one of them would re-create the no-consumer loop).

    log?: (message: string) => void

    Where the routing verdict is logged. Default: silent.

    replaceable?: readonly Partial<Record<ChannelRole, string>>[]

    Main-output endpoints regarded as "not really routed": the topology's auto-built placeholder (the demo's own omx-demo-main loopback sink, which has no consumer of its own). A main currently on one of these — or unrouted — is auto-routed; a main on anything else (a restored session, an operator's picker choice) is left alone.

    resolveDefaultSink?: () => Promise<string | undefined>

    Resolve the host's default Audio/Sink node name. Defaults to resolveDefaultSinkName (pw-metadata -n default 0 default.audio.sink); tests inject a fake so no PipeWire is touched.

    Settings
    Member Visibility

    On This Page
    Properties