openmixer — generated API reference
    Preparing search index...

    Function channelDisplayLabel

    • The full surface label for a bus / channel: its numbered role, plus the custom name when the operator has set one that adds information. So an aux named "Monitors" reads "Aux 3 · Monitors"; an un-named aux reads just "Aux 3".

      A SINGULAR kind (see isSingularKind) drops the number: the main mix reads "Main", because a console has one and an index there is the desk repeating an address back.

      A blank/whitespace name, or a name that is already the role phrase ("Aux 3", "Main") or the server's auto default ("aux 3"), adds nothing — so the label never doubles up into "Aux 3 · Aux 3" or "Main · Main". The phrase compared against is the CALLER'S: a localised surface must not treat a foreign locale's phrasing as its own repetition. The auto default is compared regardless of vocabulary, because kind index is a fact about the address rather than a word anyone chose.

      Parameters

      • id: ChannelId

        the channel address (kind + 1-based index)

      • Optionalname: string

        the custom name, if any

      • words: LabelVocabulary = CONSOLE_LABELS

        the label vocabulary; the console's own by default

      Returns string

      the role phrase, optionally suffixed with the custom name