openmixer — generated API reference
    Preparing search index...

    Interface StageboxAssignPlan

    The computed bulk assignment (or clear) plan — pure data the server applies.

    interface StageboxAssignPlan {
        clear: boolean;
        deviceId: string;
        direction: StageboxDirection;
        ops: readonly StageboxAssignOp[];
        skipped: number;
        targetKind:
            | "input"
            | "fxReturn"
            | "aux"
            | "mix"
            | "matrix"
            | "cue"
            | "main"
            | "fxSend"
            | "dca"
            | "muteGroup"
            | "mixMinus";
        unnumbered: readonly string[];
    }
    Index
    clear deviceId direction ops skipped targetKind unnumbered
    clear: boolean
    deviceId: string
    direction: StageboxDirection
    ops: readonly StageboxAssignOp[]

    The channel ↔ port mappings to apply, in channel order.

    skipped: number

    How many of the box's ports were dropped for exceeding StageboxAssignOptions.channelCount.

    targetKind:
        | "input"
        | "fxReturn"
        | "aux"
        | "mix"
        | "matrix"
        | "cue"
        | "main"
        | "fxSend"
        | "dca"
        | "muteGroup"
        | "mixMinus"
    unnumbered: readonly string[]

    Ports whose local name carries no channel number (portChannelNumber) — left out of ops and reported here, because a port with no number has no channel to claim and guessing one by list position renumbers every port after a gap.

    Settings
    Member Visibility

    On This Page
    Properties