openmixer — generated API reference
    Preparing search index...

    Interface BusStateMessage

    Broadcast after a bus-master move: the bus's new master level (+ whether it is stereo).

    interface BusStateMessage {
        bus: ChannelRef;
        level: number;
        muted?: boolean;
        pan?: number;
        stereo?: boolean;
        type: "bus.state";
    }
    Index
    level: number

    Linear master gain.

    muted?: boolean

    Whether the whole bus is muted (the group master's MUTE). Present on a bus-mute write's echo (PATCH /channel/{kind}/{index}/mute) and on the snapshot frames; omitted on a bare fader-move echo.

    pan?: number

    The bus master L/R balance (−1 hard-left … 0 centre … +1 hard-right). Present on a bus.pan echo; omitted on a bare fader / mute echo (its balance is unchanged).

    stereo?: boolean

    Whether the bus carries distinct L/R (a stereo bus). Present on the snapshot frames so a reconnecting client renders the bus with L/R metering; omitted on a bare fader-move echo where the stereo-ness is unchanged.

    type: "bus.state"