openmixer — generated API reference
    Preparing search index...

    Class ChannelMuteResource

    Channel mute as a ConsoleResource: /channel/{kind}/{index}/mute.

    {kind}/{index} is TWO path segments (issue #438) — /channel/main/1/mute, /channel/input/3/mute — resolved by channelIdOf, the one parser every channel-addressed entity uses. The kind is always explicit: this entity reaches beyond the input tier because a mains-scoped panic targets a BUS (spec §4.3), and a grammar where only inputs get a short spelling is two grammars. Anything unparseable — a float, an unknown kind — is a not-found, never a defaulted channel.

    Implements

    Index
    path: "/channel/{kind}/{index}/mute" = CHANNEL_MUTE_PATH

    The path template, e.g. /channel/{kind}/{index}/headAmp. Braced segments become ResourceId keys. One template per entity type; instances differ only by id.

    • The one broadcast spelling: numeric {kind, index}, resolved to the strip that OWNS the state — a linked follower's canonical name is its primary, so the pair has one instance on the wire exactly as it has one in a patch.

      Parameters

      Returns Readonly<Record<string, string | number>> | undefined

    • The strips the console holds, each under the id that OWNS its mute — a linked follower folds onto its primary, so a snapshot carries one frame per instance exactly as the wire carries one id per instance.

      Returns Iterable<Readonly<Record<string, string | number>>, any, any> | undefined

    • Read the ONE state. undefined when the instance does not exist — the layer turns that into a not-found rather than an empty object, so "absent" and "default" stay distinct. Pure: a read may not bind, seed, or persist anything.

      Parameters

      Returns ChannelMuteState | undefined