openmixer — generated API reference
    Preparing search index...

    Interface WireIoNode

    One live PipeWire I/O endpoint on the wire (a patchbay source or sink).

    interface WireIoNode {
        card?: string;
        deferred?: boolean;
        description: string;
        group?: string;
        id: string;
        ignored?: boolean;
        kind: "source" | "sink";
        name: string;
        ports: readonly string[];
    }
    Index
    card? deferred? description group? id ignored? kind name ports
    card?: string

    The node's sound card band label (local hardware only) — so the patchbay can group two same-type endpoints under a VISIBLE per-card header on a touch screen, not only on a mouse-hover title (operator #84). Absent for app streams / network nodes.

    deferred?: boolean

    Whether this node is deferred/absent (issue #154): it is still referenced by a patch but its ports are not in the live graph — a stopped app stream (node present, ports unregistered) or an unplugged device. Surfaces render its crosspoint row/column GHOSTED ("device absent — will connect when it appears"), never identical to a live node. Sourced from the #168 deferral ledger. Absent (never false) for a live node.

    description: string

    Longer description (falls back to the name).

    group?: string

    Optional group label (e.g. "Talkback / Generators"); absent for plain nodes.

    id: string

    Stable id (the PipeWire node name).

    ignored?: boolean

    Whether this source is ignored — shown but folded into the collapsed "Ignored" group (operator #83). Set by the built-in noise defaults + the operator's persisted ignore set. Absent (never false) for a plainly-offered source; never set on a sink.

    kind: "source" | "sink"

    source (take audio from) or sink (route audio to).

    name: string

    Short label.

    ports: readonly string[]

    The node's port names, FL/FR in pw-link order.

    Settings
    Member Visibility

    On This Page
    Properties