Version T · BroadwayOSC v1.0.2

BroadwayOSC

Version 1.0.2 Universal audio console control over UDP

Abstract

BroadwayOSC is an open protocol for bidirectional control of professional audio consoles over UDP. It extends Open Sound Control (OSC 1.0/1.1) with a richer type system, wildcard index-range addressing, and a human-readable namespace that maps directly to the Broadway universal audio model.

All float values are in engineering units — dB, Hz, ms, µs — as produced by the console’s value converters. The server translates to and from console wire format internally. Clients never deal with raw wire values.

Fully backward compatible with OSC 1.0 for scalar float/int/string messages.

Related standards:

• OSC 1.0 / 1.1 — base transport, framing, array types, boolean tags
• ADM-OSC — complementary spatial audio standard; namespaces do not conflict (/adm/ vs /ChannelType/)

1. Connecting

Protocol: UDP Default port: 8765

No handshake required. Send any BroadwayOSC message and you are registered as a client. Send /Unsubscribe/* to cleanly disconnect.

Multiple clients are supported simultaneously. Each client is identified by "ip:port" and maintains its own independent subscription set.

2. Message Intent

Every BroadwayOSC message is a SET, GET, SUBSCRIBE, or UNSUBSCRIBE. Intent is determined by the path prefix and the presence or absence of a value argument.

SET — Send a value

Include a value argument. The console parameter is updated immediately.

/Input/1/Level      ,f  0.0       ← unity (0 dB)
/Input/3/Mute       ,T            ← mute on
/Dca/2/Level        ,f  0.0       ← DCA at unity
/Bus/4/Mute         ,F            ← mute off

Use the explicit prefix if your client requires it:

/Set/Input/1/Level  ,f  -10.0     ← set to -10 dB

GET — Request the current value

Send the path with no arguments. The current value is returned and you are auto-subscribed to all future changes for that address.

/Input/1/Level
/Input/3/Mute

Explicit prefix form:

/Get/Input/1/Level

If the value is not yet known, the server subscribes to it from the console and pushes it as soon as it arrives. No re-request needed.

SUBSCRIBE — Register for ongoing updates

/Subscribe/Input/1/Level
/Subscribe/Input/1/Mute
/Subscribe/Dca/1/Level

UNSUBSCRIBE — Stop receiving updates

/Unsubscribe/Input/1/Level      ← stop this address
/Unsubscribe/*                  ← remove client entirely

3. Address Format

/ChannelType/index/Parameter
/ChannelType/index/ProcessingBlock/Parameter
/ChannelType/index/ProcessingBlock/SubBlock/Parameter
/ChannelType/index/ChannelType/index/Parameter

Processing blocks (Comp, Gate, Hpf, Lpf, Preamp, Eq) take no index in the OSC path. Sub-blocks (Filter, Parallel) extend a processing block without adding an index. Crosspoints (sends from one channel to a bus) require both channel indices.

Tokens are case-insensitive — /input/1/level and /Input/1/Level are equivalent.

Examples:

/Input/1/Level                  Input 1 fader
/Input/1/Mute                   Input 1 mute
/Aux/3/Level                    Aux bus 3 fader
/Input/1/Aux/3/Level            Input 1 send to Aux 3
/Dca/1/Level                    DCA 1 fader
/MainStereo/1/Level             Main LR fader
/Input/1/Comp/Threshold         Input 1 compressor threshold
/Input/1/Comp/Filter/Freq       Input 1 comp sidechain filter freq
/Input/1/Hpf/Freq               Input 1 HPF frequency
/Input/1/Gate/Enable            Input 1 gate on/off
/Input/1/Gate/Filter/Source     Input 1 gate sidechain source
/Input/1/Preamp/Trim            Input 1 preamp trim
/Input/1/Eq/Enable              Input 1 EQ in/out
/Input/1/Eq/2/Gain              Input 1 EQ band 2 gain

Index Ranges and Sets

Multiple expanded positions produce the Cartesian product:

/Input/1-32/Level       ,f  0.0     ← set all 32 inputs to unity
/Input/1-8/Mute         ,T          ← mute inputs 1–8
/Input/1,4,7/Mute       ,T          ← mute inputs 1, 4, and 7
/Input/1-32/Aux/1-16/Level          ← 512 crosspoints in one message
/Dca/1-8/Level          ,           ← get all DCA faders
/Input/*/Name           ,           ← get all input names

On SET: the same value is applied to every expanded address. On GET/SUBSCRIBE: each expanded address is handled individually.

4. Channel Types

Tokens are case-insensitive. Indices start at 1.

Input Channels

Mix Buses

Groups

5. Parameters

All float values are engineering units. The server converts to/from console wire format internally.

Fader and Level

Fader calibration anchors (AHNet/dLive):

Fader calibration anchors (X32/M32, 0.0–1.0 wire float):

Mute and Solo

Identity

Colour palette (X32/M32, 16 colours):

Preamp

Addressed as /Input/n/Preamp/Parameter

High-Pass Filter

Addressed as /Input/n/Hpf/Parameter

Low-Pass Filter

Addressed as /Input/n/Lpf/Parameter

Gate

Addressed as /Input/n/Gate/Parameter

Gate Sidechain Filter

Addressed as /Input/n/Gate/Filter/Parameter

Compressor

Addressed as /Input/n/Comp/Parameter

Compressor Sidechain Filter

Addressed as /Input/n/Comp/Filter/Parameter

Compressor Parallel

Addressed as /Input/n/Comp/Parallel/Parameter

EQ

Addressed as /Input/n/Eq/Enable and /Input/n/Eq/{band}/Parameter

Bands are numbered from 1. AHNet/dLive provides 4 parametric bands per channel.

/Input/1/Eq/Enable          ,T
/Input/1/Eq/2/Freq          ,f  1000.0    ← 1 kHz
/Input/1/Eq/2/Gain          ,f  3.0       ← +3 dB boost
/Input/1/Eq/2/Q             ,f  1.0       ← 1 octave bandwidth
/Input/1/Eq/2/Type          ,s  "Bell"

GEQ (mix buses only)

Addressed as /Group/n/Geq/Enable, /Group/n/Geq/Type, /Group/n/Geq/{band}/Gain

Available on Group, Aux, Matrix buses. Not available on input channels.

Delay

Addressed as /Input/n/Delay/Parameter

Insert

Addressed as /Input/n/Insert/{slot}/Enable

Slots: 1 = Insert A, 2 = Insert B.

/Input/1/Insert/1/Enable    ,T      ← insert slot A on
/Input/1/Insert/2/Enable    ,F      ← insert slot B off

DCA Assignment

Addressed as /Input/n/Dca/{dca}/Enable

/Input/1/Dca/3/Enable       ,T      ← assign input 1 to DCA 3
/Input/1/Dca/3/Enable       ,F      ← remove input 1 from DCA 3

Crosspoint Sends

Addressed as /Input/n/BusType/m/Parameter

Supported bus types for AHNet/dLive: Aux, Group, FxSend, Matrix Supported bus types for X32/M32: Bus (flat numbered)

/Input/1/Aux/3/Level    ,f  0.0       ← send at unity (0 dB)
/Input/1/Aux/3/Level    ,f  -6.0      ← send at -6 dB
/Input/1/Aux/3/Level    ,f  -90.0     ← send off
/Input/1/Aux/3/Enable   ,T
/Input/1/Aux/3/Pre      ,F            ← post-fader

DCA

Scenes and Cues

6. Processing Block Availability by Channel Type

Not all processing blocks are available on all channel types. This table shows what is supported.

Source: AHNetOSCTemplate.capabilities matrix — hardware maximums. X32/M32 supports a subset.

7. Value Types

Engineering Unit Summary

Collection Encoding

Broadway collection values use OSC 1.1 arrays [...]:

8. Client Model

Registration

Clients are registered automatically on first inbound packet, identified by "ip:port". No handshake needed.

Subscriptions

Each client maintains its own subscription set. Pushes are only sent for addresses in the set. Build your set via:

• GET (no value) — auto-subscribes the address
• /Subscribe/ — explicit subscription

Lazy Wire Subscription

When a client GETs an address not yet known to the server:

1. Address added to client subscription set
2. Server fires a wire GET to the connected console
3. Console responds → value stored in bridge state → pushed to all subscribed clients
4. Address remains active — all future console changes are pushed automatically

No re-subscription needed across console reconnections within a session.

Unsolicited Console Pushes

When an operator moves a control on the desk, the push flows through the bridge and is forwarded to all clients subscribed to that address. Clients receive live console state without polling.

9. Quick Reference

SET to unity:           /Input/1/Level              ,f  0.0
SET to -10 dB:          /Input/1/Level              ,f  -10.0
SET off:                /Input/1/Level              ,f  -90.0
GET fader:              /Input/1/Level
Mute on:                /Input/1/Mute               ,T
Mute off:               /Input/1/Mute               ,F
Pan centre:             /Input/1/Pan                ,f  0.0
Pan hard left:          /Input/1/Pan                ,f  -100.0
Get name:               /Input/1/Name
Subscribe mute:         /Subscribe/Input/1/Mute
Unsubscribe all:        /Unsubscribe/*
Fire scene:             /Cues/1/Go                  ,I
DCA unity:              /Dca/1/Level                ,f  0.0
Input→aux unity:        /Input/1/Aux/3/Level        ,f  0.0
Input→aux -6 dB:        /Input/1/Aux/3/Level        ,f  -6.0
Input→aux off:          /Input/1/Aux/3/Level        ,f  -90.0
Comp threshold:         /Input/1/Comp/Threshold     ,f  -18.0
Comp attack:            /Input/1/Comp/Attack        ,f  500.0   ← 500 µs
Comp release:           /Input/1/Comp/Release       ,f  100.0   ← 100 ms
HPF at 80 Hz:           /Input/1/Hpf/Freq           ,f  80.0
HPF on:                 /Input/1/Hpf/Enable         ,T
EQ boost +3 dB:         /Input/1/Eq/2/Gain          ,f  3.0
EQ band freq:           /Input/1/Eq/2/Freq          ,f  1000.0
Comp SC filter on:      /Input/1/Comp/Filter/Enable ,T
Comp SC freq:           /Input/1/Comp/Filter/Freq   ,f  200.0
Assign to DCA 3:        /Input/1/Dca/3/Enable       ,T
Range mute:             /Input/1-8/Mute             ,T
Range GET:              /Input/1-32/Level
Set notation:           /Input/1,4,5-8/Mute         ,T
All inputs:             /Input/*/Mute
All crosspoints:        /Input/*/Aux/*/Level        ,f  0.0

10. Packet Format

Standard OSC framing:

[address string]    null-terminated, 4-byte padded
[type tag string]   starts with ',', null-terminated, 4-byte padded
[arguments]         per type tag, each 4-byte padded

All multi-byte values big-endian. OSC 1.1 bundles (#bundle) accepted and processed sequentially.

11. Relationship to ADM-OSC

ADM-OSC (/adm/obj/n/...) and BroadwayOSC (/ChannelType/n/...) occupy non-overlapping namespaces and may coexist on the same UDP port. A server implementing both routes by path prefix.

Appendix A — Token Reference

All tokens are case-insensitive. Canonical form is PascalCase.

Channel Types

Input           InputStereo     Group           GroupStereo
Aux             AuxStereo       Matrix          MatrixStereo
Bus             BusStereo       Mix             MixStereo
Output          OutputStereo    FxSend          FxSendStereo
FxReturn        FxReturnStereo  AuxInput        AuxInputStereo
MainStereo      MainCentre      MainSub         MainSum
MainSurround    Mon             Dca             DcaGroup
MuteGroup       UfxSend         UfxReturn

Parameters

Level           LevelDCA        Mute            Pan
Trim            Delay           Color           Eq
Comp            Gate            Send            Solo
Phase           Preamp          Phantom         Hpf
Lpf             Invert          Insert          Source
Automix         Name            Select          RoutingSet
RoutingPool     AltSource       Panner          Geq

Processing Sub-blocks

Filter          Parallel

Actions

Recall          Store           Copy            Paste
Reset           Clear           Fire            Stop
Play            Pause           Record          Go
Previous        Next            Toggle          Undo

Sub-parameters

Freq            Gain            Q               Attack
Release         Threshold       Ratio           Bypass
Enable          Knee            Range           Hold
Keyfilter       Makeup          Auto            Peak
Rms             Pre             Post            Type
Slope           Width           Balance         Time
Depth           Rate            Feedback        Size
Model           Wet             Dry

Filter / EQ Shape Values (used with Type parameter)

Bell            Highshelf       Lowshelf        Hpf
Lpf             Bandpass        Notch           Peq

Compressor Model Values (used with Model parameter)

Opto            Vca             Fet             Tube
Bus             Ducker          PeakLimiter

GEQ Type Values (used with Type parameter on Geq)

constant-Q      proportional-Q  hybrid          NEQ12

Cues / Scenes

Cues            CueList         Scene           Snapshot
Show            ActiveCueID     StandbyCue      Go

System

System          Config

Appendix B — BroadwayOSC vs OSC 1.0 vs ADM-OSC

Appendix C — Implementation Notes (Version T)

BroadwayOSC is implemented at the bridge layer. Three files handle all protocol work:

BridgeOSCManager is owned by BridgeManager and started after full console inventory is available. All bridge results pass through oscManager.pushToClients() — OSC clients receive the same live state as the Version T UI. Values are BroadwayVALUE instances in engineering units, passed through unchanged at the OSC boundary.

Supported adaptors: