openmixer — generated API reference
    Preparing search index...

    Interface LabelVocabulary

    The WORDS a display label is built from, injected so the rule below can be stated once.

    The console's own vocabulary is CONSOLE_LABELS; a localised surface passes its catalog instead. Only the words differ — which name adds information, and which is the console repeating itself, is not a per-locale decision.

    interface LabelVocabulary {
        numbered(
            kind:
                | "input"
                | "fxReturn"
                | "aux"
                | "mix"
                | "matrix"
                | "cue"
                | "main"
                | "fxSend"
                | "dca"
                | "muteGroup"
                | "mixMinus",
            index: number,
        ): string;
        role(
            kind:
                | "input"
                | "fxReturn"
                | "aux"
                | "mix"
                | "matrix"
                | "cue"
                | "main"
                | "fxSend"
                | "dca"
                | "muteGroup"
                | "mixMinus",
        ): string;
        withName(numbered: string, name: string): string;
    }
    Index
    numbered role withName

    • The role and its 1-based number as one phrase: "Aux 3".

      Parameters

      • kind:
            | "input"
            | "fxReturn"
            | "aux"
            | "mix"
            | "matrix"
            | "cue"
            | "main"
            | "fxSend"
            | "dca"
            | "muteGroup"
            | "mixMinus"
      • index: number

      Returns string

    • The role word for a channel kind: "Aux", "Group", "Matrix", "DCA", "Main", …

      Parameters

      • kind:
            | "input"
            | "fxReturn"
            | "aux"
            | "mix"
            | "matrix"
            | "cue"
            | "main"
            | "fxSend"
            | "dca"
            | "muteGroup"
            | "mixMinus"

      Returns string

    • The numbered role joined to a custom name: "Aux 3 · Monitors".

      Parameters

      • numbered: string
      • name: string

      Returns string

    Settings
    Member Visibility

    On This Page
    Methods