openmixer — generated API reference
    Preparing search index...

    Interface StageboxEndpointGroup

    One side of a stagebox — its capture (input) or playback (output) channel bank.

    interface StageboxEndpointGroup {
        count: number;
        node: string;
        ordinalChannels?: readonly ChannelRefJson[];
        ordinals?: readonly number[];
        ports: readonly string[];
    }
    Index
    count: number

    How many channels this side carries — the box's real width, clamped from the fabric.

    node: string

    The backing PipeWire node.name (reac-capture / reac-playback).

    ordinalChannels?: readonly ChannelRefJson[]

    The channel each ordinals entry belongs to — parallel array, same order, present exactly when ordinals is.

    A REPLACE on an identity ghost writes a channel's patch directly; recovering "which channel" from a live port is exactly the guess this identity model exists to delete, so the ghost states it instead of leaving a consumer to re-derive it.

    ordinals?: readonly number[]

    The 1-based inputs this side holds, STATED by the patches rather than read from a live node.

    Present only on a ghost built from patch IDENTITY ({box, input} legs), where the box is gone and has no pw-link ports to name — ports is empty there, because inventing the names a departed box would have had is the socket-guessing this identity model exists to delete. A live group states ports and omits this; a consumer that maps by ordinal reads this when it is present and derives from ports when it is not.

    ports: readonly string[]

    The ordered pw-link port names, channel 1..N (sorted by the trailing number), clamped to count.