Root
/channelclippedwritablestripswritable
Example response
{
"clipped": [],
"strips": [
{
"index": 1,
"kind": "input"
},
{
"index": 2,
"kind": "input"
},
{
"index": 3,
"kind": "input"
},
{
"index": 4,
"kind": "input"
},
{
"index": 1,
"kind": "main"
},
{
"index": 1,
"kind": "matrix"
},
{
"index": 1,
"kind": "aux"
},
{
"index": 1,
"kind": "mix"
},
{
"index": 2,
"kind": "mix"
},
{
"index": 1,
"kind": "dca"
}
]
}Align
/channel/{kind}/{index}/aligne.g. /channel/input/1/align
delayMswritable0–100 ms, step 0.01referencewritable
Example response
{
"delayMs": 0,
"reference": ""
}/channel/{kind}/{index}/align/measuremente.g. /channel/input/1/align/measurement
atread-onlyframesread-onlyreferenceread-only
Example response
{
"at": 0,
"frames": 0,
"reference": ""
}Capability
/channel/{kind}/{index}/capabilitye.g. /channel/input/1/capability
featuresread-onlygainRangeread-onlyknownread-onlywritableread-only
Example response
{
"features": [
"fader",
"mute",
"solo",
"pan",
"gain",
"trim",
"polarity",
"name",
"meter",
"eq",
"gate",
"comp",
"inserts",
"phantom",
"pad",
"sens",
"width"
],
"gainRange": {
"maxDb": 55,
"minDb": 0,
"stepDb": 1
},
"known": [
"fader",
"mute",
"solo",
"pan",
"trim",
"polarity",
"name",
"meter",
"eq",
"gate",
"comp",
"inserts",
"width"
],
"writable": [
"fader",
"mute",
"solo",
"pan",
"gain",
"trim",
"polarity",
"name",
"meter",
"eq",
"gate",
"comp",
"inserts",
"phantom",
"pad",
"sens"
]
}Chain
/channel/{kind}/{index}/chaine.g. /channel/input/1/chain
orderread-only
Example response
{
"order": [
"trim",
"insA",
"gate",
"eq",
"dyn",
"insB",
"fader",
"insPost"
]
}/channel/{kind}/{index}/chain/processors/{processorId}e.g. /channel/input/1/chain/processors/trim
enabledwritablekindread-onlylabelread-onlypluginwritablesortread-only-1000000–1000000tapPointread-onlyTop-Of-Ch · Post-Trim · Pre-EQ · Post-EQ · Pre-Fader · Post-Fader
Example response
{
"enabled": true,
"kind": "trim",
"label": "Trim/HPF",
"plugin": "",
"sort": 0,
"tapPoint": "Top-Of-Ch"
}/channel/{kind}/{index}/chain/processors/{processorId}/params/{symbol}e.g. /channel/input/1/chain/processors/1/params/1
No fields observed on the reference rig.
/channel/{kind}/{index}/chain/processors/{processorId}/properties/{property}e.g. /channel/input/1/chain/processors/1/properties/1
No fields observed on the reference rig.
Clip
/channel/{kind}/{index}/clipe.g. /channel/input/1/clip
atread-onlyclippedwritablecountread-only
Example response
{
"at": null,
"clipped": false,
"count": 0
}Colour
/channel/{kind}/{index}/coloure.g. /channel/input/1/colour
colourwritable
Example response
{
"colour": ""
}Delay
/channel/{kind}/{index}/delaye.g. /channel/input/1/delay
feedbackwritable0–0.99mixwritable0–1onwritablepingpongwritablesyncwritablesyncDivisionwritable0.0625–16timeMswritable0–2000 ms, step 1tonewritable0–1
Example response
{
"feedback": 0.3,
"mix": 0.3,
"on": false,
"pingpong": false,
"sync": false,
"syncDivision": 1,
"timeMs": 300,
"tone": 0.3
}Dynamics
/channel/{kind}/{index}/dynamicse.g. /channel/input/1/dynamics
attackMswritable0.1–100 ms, step 1kindwritablecomp · limiter
makeupDbwritable0–24 dB, step 0.5onwritableratiowritable1–20, step 0.5releaseMswritable5–3000 ms, step 10thresholdDbwritable-60–0 dB, step 1
Example response
{
"attackMs": 5,
"kind": "comp",
"makeupDb": 0,
"on": false,
"ratio": 4,
"releaseMs": 200,
"thresholdDb": -18
}Eq
/channel/{kind}/{index}/eqe.g. /channel/input/1/eq
onwritable
Example response
{
"on": true
}/channel/{kind}/{index}/eq/bandse.g. /channel/input/1/eq/bands
bandswritable
Example response
{
"bands": [
{
"freqHz": 120,
"gainDb": 0,
"id": "1",
"name": "low",
"on": true,
"q": 0.7,
"type": "lowShelf"
},
{
"freqHz": 800,
"gainDb": 0,
"id": "2",
"name": "lowMid",
"on": true,
"q": 1,
"type": "bell"
},
{
"freqHz": 3000,
"gainDb": 0,
"id": "3",
"name": "midHigh",
"on": true,
"q": 1,
"type": "bell"
},
{
"freqHz": 10000,
"gainDb": 0,
"id": "4",
"name": "high",
"on": true,
"q": 0.7,
"type": "highShelf"
}
]
}/channel/{kind}/{index}/eq/bands/{bandId}e.g. /channel/input/1/eq/bands/1
freqHzwritable20–20000 Hz, step 10gainDbwritable-15–15 dB, step 0.5idread-onlyonwritableqwritablerange depends on the instancetypewritablebell · lowShelf · highShelf · notch
Example response
{
"freqHz": 120,
"gainDb": 0,
"id": "1",
"on": true,
"q": 0.7,
"type": "lowShelf"
}/channel/{kind}/{index}/eq/bands/sorte.g. /channel/input/1/eq/bands/sort
paramsread-onlyprogressread-onlyrefusalread-onlyreportread-onlyrunningwritablestartedAtread-only
Example response
{
"running": false
}/channel/{kind}/{index}/eq/filters/{filter}e.g. /channel/input/1/eq/filters/hpf
freqHzwritablerange depends on the instanceonwritableslopewritable
Example response
{
"freqHz": 80,
"on": false,
"slope": 12
}Fader
/channel/{kind}/{index}/fadere.g. /channel/input/1/fader
audibleDbread-onlydcaScaleread-onlypositionwritable0–1
Example response
{
"audibleDb": 2.0000000000000018,
"db": 2.0000000000000018,
"dcaScale": 1,
"position": 0.8
}Fbs
/channel/{kind}/{index}/fbse.g. /channel/input/1/fbs
autoBandsread-onlycooldownMinuteswritable0–120 min, step 1holdSecondswritable1–300 s, step 1never
maxAutoBandswritable1–24, step 1mergeCentswritable0–600 cents, step 10modewritableoff · ringout · live
notchQwritable0.3–116, step 1sensitivitywritable0–1, step 0.05
Example response
{
"autoBands": 0,
"cooldownMinutes": 10,
"holdSeconds": 5,
"maxAutoBands": 6,
"mergeCents": 100,
"mode": "off",
"notchQ": 116,
"sensitivity": 0
}/channel/{kind}/{index}/fbs/candidatese.g. /channel/input/1/fbs/candidates
No fields observed on the reference rig.
/channel/{kind}/{index}/fbs/lastActione.g. /channel/input/1/fbs/lastAction
No fields observed on the reference rig.
Gain
/channel/{kind}/{index}/gaine.g. /channel/input/1/gain
dbread-onlyrange depends on the instance
Example response
{
"db": 0
}Gate
/channel/{kind}/{index}/gatee.g. /channel/input/1/gate
attackMswritable0–500 ms, step 0.5holdMswritable0–2000 ms, step 5hysteresisDbwritable0–24 dB, step 0.5kneeEndDbwritable-80–0 dB, step 1kneeStartDbwritable-80–0 dB, step 1onwritablerangeDbwritable-90–0 dB, step 1ratiowritable1–100, step 1releaseMswritable0–5000 ms, step 10thresholdDbwritable-80–0 dB, step 1
Example response
{
"attackMs": 1,
"holdMs": 10,
"hysteresisDb": 3,
"kneeEndDb": -37,
"kneeStartDb": -43,
"on": false,
"rangeDb": -90,
"ratio": 16,
"releaseMs": 100,
"thresholdDb": -40
}Head amp
/channel/{kind}/{index}/headAmpe.g. /channel/input/1/headAmp
gainDbwritablerange depends on the instancegainRangeread-onlypadwritablephantomwritable
Example response
{
"gainDb": 32,
"gainDefaultDb": 32,
"gainRange": {
"maxDb": 55,
"minDb": 0,
"stepDb": 1
},
"pad": false,
"phantom": false
}Hrp
/channel/{kind}/{index}/hrpe.g. /channel/input/1/hrp
amountwritable0–1autoBandsread-onlyfreezewritablemaxAutoBandswritable1–24, step 1modewritableoff · monitor · adaptive
Example response
{
"amount": 0.5,
"autoBands": 0,
"freeze": false,
"maxAutoBands": 8,
"mode": "off"
}/channel/{kind}/{index}/hrp/reporte.g. /channel/input/1/hrp/report
atread-onlyvoicesread-only
Example response
{
"at": 0,
"voices": []
}/channel/{kind}/{index}/hrp/resete.g. /channel/input/1/hrp/reset
paramsread-onlyprogressread-onlyrefusalread-onlyreportread-onlyrunningwritablestartedAtread-only
Example response
{
"running": false
}Inserts
/channel/{kind}/{index}/insertse.g. /channel/input/1/inserts
pluginswritable
Example response
{
"plugins": []
}/channel/{kind}/{index}/inserts/{slot}e.g. /channel/input/1/inserts/1
No fields observed on the reference rig.
/channel/{kind}/{index}/inserts/{slot}/params/{symbol}e.g. /channel/input/1/inserts/1/params/1
No fields observed on the reference rig.
/channel/{kind}/{index}/inserts/{slot}/properties/{property}e.g. /channel/input/1/inserts/1/properties/1
No fields observed on the reference rig.
/channel/{kind}/{index}/inserts/suitabilitye.g. /channel/input/1/inserts/suitability
No fields observed on the reference rig.
Instrument
/channel/{kind}/{index}/instrumente.g. /channel/input/1/instrument
instrumentwritablekick-in · kick-out · snare-top · snare-bottom · hihat · tom-rack · tom-floor · overheads · congas · bongos · timbales · cajon · hand-perc · bass-di · bass-mic · upright-bass · synth-bass · egtr-amp · agtr-di · agtr-steel · egtr-clean · egtr-crunch · keys-di · piano · grand-piano · electric-piano · hammond-organ · synth-pad · synth-lead · lead-vocal-m · lead-vocal-f · backing-vocal · spoken-word · choir · brass · fiscorn · flugelhorn · trumpet · cornet · french-horn · trombone-tenor · trombone-bass · trombone-alto · trombone-valve · tuba · sax-soprano · sax-alto · sax-tenor · sax-baritone · strings · violin-section · solo-violin · viola · cello · double-bass-arco · playback-stereo · backing-tracks · click-track · talkback-band
Example response
{
"instrument": null
}Link
/channel/{kind}/{index}/linke.g. /channel/input/1/link
linkedwritablepartnerwritableroleread-only
Example response
{
"linked": false,
"partner": null,
"role": null
}Meter
/channel/{kind}/{index}/metere.g. /channel/input/1/meter
atread-onlylevelread-only
Example response
{
"at": 0,
"level": -6.023529411764713
}Mix minus
/channel/{kind}/{index}/mixMinuse.g. /channel/main/1/mixMinus
enabledwritable
Example response
{
"enabled": false
}/channel/{kind}/{index}/mixMinus/excludede.g. /channel/input/1/mixMinus/excluded
No fields observed on the reference rig.
Mute
/channel/{kind}/{index}/mutee.g. /channel/input/1/mute
audibleMuteread-onlybyGroupread-onlybyPanicread-onlybySipread-onlyindividualwritable
Example response
{
"audibleMute": false,
"byGroup": false,
"byPanic": false,
"bySip": false,
"individual": false
}Name
/channel/{kind}/{index}/namee.g. /channel/input/1/name
namewritable
Example response
{
"name": ""
}Pan
/channel/{kind}/{index}/pane.g. /channel/input/1/pan
panwritable-1–1
Example response
{
"pan": 0
}Polarity
/channel/{kind}/{index}/polaritye.g. /channel/input/1/polarity
invertedwritable
Example response
{
"inverted": false
}Recall safe
/channel/{kind}/{index}/recallSafee.g. /channel/input/1/recallSafe
allwritableeffectiveread-onlyscopeswritablefader · mute · sends · eq · dyn · inserts
Example response
{
"all": false,
"effective": [],
"scopes": []
}Record
/channel/{kind}/{index}/recorde.g. /channel/input/1/record
armedwritabletapswritablePost-Trim · Pre-Fader · Post-Fader
Example response
{
"armed": true,
"taps": [
"Post-Trim",
"Post-Fader"
]
}Reverb
/channel/{kind}/{index}/reverbe.g. /channel/input/1/reverb
algorithmwritableroom · plate · hall
dampingwritable0–1highcutwritable0–20000 Hz, step 10lowcutwritable0–20000 Hz, step 10mixwritable0–1onwritablepredelayMswritable0–100 ms, step 1sizewritable0–1widthwritable0–1
Example response
{
"algorithm": "room",
"damping": 0.5,
"highcut": 20000,
"lowcut": 0,
"mix": 0.3,
"on": false,
"predelayMs": 0,
"size": 0.7,
"width": 1
}Rta
/channel/{kind}/{index}/rta/arminge.g. /channel/main/1/rta/arming
armedwritable
Example response
{
"armed": false
}Send
/channel/{kind}/{index}/send/{busKind}/{busIndex}e.g. /channel/input/1/send/main/1
levelwritable0–1tapwritableTop-Of-Ch · Post-Trim · Pre-EQ · Post-EQ · Pre-Fader · Post-Fader
Example response
{
"level": 0.75,
"tap": "Post-All"
}Solo
/channel/{kind}/{index}/soloe.g. /channel/input/1/solo
solowritable
Example response
{
"solo": false
}Solo safe
/channel/{kind}/{index}/soloSafee.g. /channel/input/1/soloSafe
safewritable
Example response
{
"safe": false
}Source
/channel/{kind}/{index}/sourcee.g. /channel/input/1/source
modewritablelive · track
Example response
{
"mode": "live"
}Speaker align
/channel/{kind}/{index}/speakerAligne.g. /channel/input/1/speakerAlign
No fields observed on the reference rig.
Spectrum
/channel/{kind}/{index}/spectrume.g. /channel/input/1/spectrum
atread-onlybandsread-onlymagsread-onlymutedread-only
Example response
{
"at": 0,
"mags": [],
"muted": false
}Trim
/channel/{kind}/{index}/trime.g. /channel/input/1/trim
dbwritable-24–24 dB, step 0.1
Example response
{
"db": 0
}Width
/channel/{kind}/{index}/widthe.g. /channel/input/1/width
widthread-only
Example response
{
"width": "mono"
}Dca
/channel/dca/{index}/memberse.g. /channel/dca/1/members
memberswritableparentswritable
Example response
{
"members": [
{
"index": 2,
"kind": "input"
}
],
"parents": []
}Matrix
/channel/matrix/{index}/input/{srcKind}/{srcIndex}e.g. /channel/matrix/1/input/matrix/1
levelwritable0–1
Example response
{
"level": 0
}Mute group
/channel/muteGroup/{index}/activee.g. /channel/muteGroup/1/active
activewritable
Example response
{
"active": false
}/channel/muteGroup/{index}/memberse.g. /channel/muteGroup/1/members
memberswritable
Example response
{
"members": [
{
"index": 2,
"kind": "input"
}
]
}/channel/muteGroup/{index}/namee.g. /channel/muteGroup/1/name
namewritable
Example response
{
"name": ""
}