REST reference

/channel

68 addresses under /channel.All families · Refusal codes

Root

GETPATCH/channel
  • clippedwritable
  • stripswritable
Example response
{
  "clipped": [
    {
      "at": "2026-01-01T00:00:00.000Z",
      "count": 1,
      "index": 1,
      "kind": "input"
    }
  ],
  "strips": [
    {
      "index": 1,
      "kind": "input"
    },
    {
      "index": 2,
      "kind": "input"
    },
    {
      "index": 3,
      "kind": "input"
    },
    {
      "index": 4,
      "kind": "input"
    },
    {
      "index": 1,
      "kind": "aux"
    },
    {
      "index": 1,
      "kind": "mix"
    },
    {
      "index": 2,
      "kind": "mix"
    },
    {
      "index": 1,
      "kind": "dca"
    },
    {
      "index": 1,
      "kind": "matrix"
    },
    {
      "index": 1,
      "kind": "main"
    }
  ]
}

Align

GETPATCH/channel/{kind}/{index}/align

e.g. /channel/input/1/align

  • delayMswritable0–100 ms, step 0.0001
  • referencewritable
Example response
{
  "delayMs": 0,
  "reference": ""
}
GETon demand/channel/{kind}/{index}/align/measurement

e.g. /channel/input/1/align/measurement

  • atread-only
  • framesread-only
  • referenceread-only
Example response
{
  "at": 0,
  "frames": 0,
  "reference": ""
}

Capability

GET/channel/{kind}/{index}/capability

e.g. /channel/input/1/capability

  • featuresread-only
  • gainRangeread-only
  • knownread-only
  • writableread-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

GETPATCH/channel/{kind}/{index}/chain

e.g. /channel/input/1/chain

  • orderwritable
  • warningsread-only
Example response
{
  "order": [
    "insA",
    "gate",
    "eq",
    "deEsser",
    "dyn",
    "drive",
    "rotary",
    "chorus",
    "flanger",
    "pitch",
    "phaser",
    "tremolo",
    "delay",
    "reverb",
    "geq",
    "insB"
  ],
  "warnings": []
}
GETPATCH/channel/{kind}/{index}/chain/processors

e.g. /channel/input/1/chain/processors

  • maxread-only
  • pluginwritable
  • pluginsread-only
Example response
{
  "max": 16,
  "plugins": 0
}
GETPATCH/channel/{kind}/{index}/chain/processors/{processorId}

e.g. /channel/input/1/chain/processors/trim

  • admissionread-only
  • enabledwritable
  • formatread-only
  • kindread-only
  • labelread-only
  • pluginwritable
  • positionread-only
  • presetwritable
  • presetEditedread-only
  • presetMissingread-only
  • presetsread-only
  • tierread-only
  • tierReasonread-only
Example response
{
  "admission": {
    "code": null,
    "quantum": 1024,
    "rate": 48000
  },
  "enabled": true,
  "format": "",
  "kind": "trim",
  "label": "Trim/HPF",
  "plugin": "",
  "position": -1,
  "preset": "",
  "presetEdited": false,
  "presetMissing": false,
  "presets": [],
  "tier": "",
  "tierReason": ""
}
GETon demand/channel/{kind}/{index}/chain/processors/{processorId}/meters

e.g. /channel/input/1/chain/processors/1/meters

No fields observed on the reference rig.

GET/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.

GET/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.

GETPATCH/channel/{kind}/{index}/chain/processors/{processorId}/tempo

e.g. /channel/input/1/chain/processors/delay/tempo

  • syncwritable
  • syncDivisionwritable0.0625–16
Example response
{
  "sync": false,
  "syncDivision": 1
}
GET/channel/{kind}/{index}/chain/suitability

e.g. /channel/input/1/chain/suitability

No fields observed on the reference rig.

Clip

GETPATCH/channel/{kind}/{index}/clip

e.g. /channel/input/1/clip

  • atread-only
  • clippedwritable
  • countread-only
Example response
{
  "at": "2026-01-01T00:00:00.000Z",
  "clipped": true,
  "count": 1
}

Colour

GETPATCH/channel/{kind}/{index}/colour

e.g. /channel/input/1/colour

  • colourwritable
Example response
{
  "colour": ""
}

Divergence

GETPATCH/channel/{kind}/{index}/divergence

e.g. /channel/input/1/divergence

  • divergencewritable0–1
Example response
{
  "divergence": 1
}

Dynamics

GETPATCH/channel/{kind}/{index}/dynamics

e.g. /channel/input/1/dynamics

  • attackMswritable0.1–100 ms, step 0.1
  • detectorOversampledread-only
  • detectorOversamplingwritable

    auto · off · 4x

  • kindwritable

    comp · limiter

  • makeupDbwritable0–24 dB, step 0.5
  • onwritable
  • ratiowritable1–20, step 0.5
  • releaseMswritable5–3000 ms, step 5
  • thresholdDbwritable-60–0 dB, step 1
Example response
{
  "attackMs": 5,
  "detectorOversampled": false,
  "detectorOversampling": "auto",
  "kind": "comp",
  "makeupDb": 0,
  "on": false,
  "ratio": 4,
  "releaseMs": 200,
  "thresholdDb": -18
}

Eq

GETPATCH/channel/{kind}/{index}/eq

e.g. /channel/input/1/eq

  • onwritable
Example response
{
  "on": true
}
GETPATCH/channel/{kind}/{index}/eq/bands

e.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"
    }
  ]
}
GETPATCH/channel/{kind}/{index}/eq/bands/{bandId}

e.g. /channel/input/1/eq/bands/1

  • freqHzwritable20–20000 Hz, step 10
  • gainDbwritable-15–15 dB, step 0.5
  • idread-only
  • onwritable
  • qwritablerange depends on the instance
  • typewritable

    bell · lowShelf · highShelf · notch · allpass1 · allpass2

Example response
{
  "freqHz": 120,
  "gainDb": 0,
  "id": 1,
  "on": true,
  "q": 0.7,
  "type": "lowShelf"
}
GETPATCH/channel/{kind}/{index}/eq/bands/sort

e.g. /channel/input/1/eq/bands/sort

  • paramsread-only
  • progressread-only
  • refusalread-only
  • reportread-only
  • runningwritable
  • startedAtread-only
Example response
{
  "running": false
}
GETPATCH/channel/{kind}/{index}/eq/filters/{filter}

e.g. /channel/input/1/eq/filters/hpf

  • freqHzwritablerange depends on the instance
  • onwritable
  • slopewritable

    12 · 24

Example response
{
  "freqHz": 80,
  "on": false,
  "slope": 12
}

Fader

GETPATCH/channel/{kind}/{index}/fader

e.g. /channel/input/1/fader

  • audibleDbread-only
  • dcaScaleread-only
  • positionwritable0–1
Example response
{
  "audibleDb": 2.0000000000000018,
  "db": 2.0000000000000018,
  "dcaScale": 1,
  "position": 0.8
}

Fbs

GETPATCH/channel/{kind}/{index}/fbs

e.g. /channel/input/1/fbs

  • autoBandsread-only
  • cooldownSecondswritable0–7200 s, step 10
  • holdSecondswritable1–300 s, step 1

    never

  • maxAutoBandswritable1–24, step 1
  • mergeCentswritable0–600 cents, step 10
  • modewritable

    off · ringout · live

  • notchQwritable0.3–116, step 0.1
  • sensitivitywritable0–1, step 0.05
Example response
{
  "autoBands": 0,
  "cooldownSeconds": 600,
  "holdSeconds": 5,
  "maxAutoBands": 6,
  "mergeCents": 100,
  "mode": "off",
  "notchQ": 116,
  "sensitivity": 0
}
GET/channel/{kind}/{index}/fbs/candidates

e.g. /channel/input/1/fbs/candidates

No fields observed on the reference rig.

GET/channel/{kind}/{index}/fbs/lastAction

e.g. /channel/input/1/fbs/lastAction

No fields observed on the reference rig.

Format

GETPATCH/channel/{kind}/{index}/format

e.g. /channel/main/1/format

  • centreLiveread-only
  • formatwritablerange depends on the instance

    stereo · lcr

Example response
{
  "centreLive": false,
  "format": "stereo"
}

Gain

GET/channel/{kind}/{index}/gain

e.g. /channel/input/1/gain

  • dbread-onlyrange depends on the instance
Example response
{
  "db": 0
}

Gate

GETPATCH/channel/{kind}/{index}/gate

e.g. /channel/input/1/gate

  • attackMswritable0–500 ms, step 0.5
  • holdMswritable0–2000 ms, step 5
  • hysteresisDbwritable0–24 dB, step 0.5
  • kneeEndDbwritable-80–0 dB, step 1
  • kneeStartDbwritable-80–0 dB, step 1
  • onwritable
  • rangeDbwritable-90–0 dB, step 1
  • ratiowritable1–100, step 1
  • releaseMswritable0–5000 ms, step 10
  • thresholdDbwritable-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
}
GETPATCH/channel/{kind}/{index}/gate/key

e.g. /channel/input/1/gate/key

  • hpHzwritable0–20000 Hz, step 1
  • listenwritable
  • lpHzwritable0–20000 Hz, step 1
  • sourcewritable
  • sourcesread-only
Example response
{
  "hpHz": 0,
  "listen": false,
  "lpHz": 0,
  "source": null,
  "sources": [
    {
      "index": 2,
      "kind": "input"
    },
    {
      "index": 3,
      "kind": "input"
    },
    {
      "index": 4,
      "kind": "input"
    },
    {
      "index": 1,
      "kind": "dca"
    }
  ]
}

Head amp

GETPATCH/channel/{kind}/{index}/headAmp

e.g. /channel/input/1/headAmp

  • deliveryread-only
  • gainDbwritablerange depends on the instance
  • gainRangeread-only
  • padwritable
  • phantomwritable
Example response
{
  "delivery": {
    "keyed": false,
    "reached": false,
    "refused": []
  },
  "gainDb": 32,
  "gainDefaultDb": 32,
  "gainDefaultFrom": "measured",
  "gainRange": {
    "maxDb": 55,
    "minDb": 0,
    "stepDb": 1
  },
  "pad": false,
  "phantom": false,
  "present": true
}

Hrp

GETPATCH/channel/{kind}/{index}/hrp

e.g. /channel/input/1/hrp

  • amountwritable0–1
  • autoBandsread-only
  • freezewritable
  • maxAutoBandswritable1–24, step 1
  • modewritable

    off · monitor · adaptive

Example response
{
  "amount": 0.5,
  "autoBands": 0,
  "freeze": false,
  "maxAutoBands": 8,
  "mode": "off"
}
GETon demand/channel/{kind}/{index}/hrp/report

e.g. /channel/input/1/hrp/report

  • atread-only
  • voicesread-only
Example response
{
  "at": 0,
  "voices": []
}
GETPATCH/channel/{kind}/{index}/hrp/reset

e.g. /channel/input/1/hrp/reset

  • paramsread-only
  • progressread-only
  • refusalread-only
  • reportread-only
  • runningwritable
  • startedAtread-only
Example response
{
  "running": false
}

Instrument

GETPATCH/channel/{kind}/{index}/instrument

e.g. /channel/input/1/instrument

  • instrumentwritable

    kick-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
}

Latency

GET/channel/{kind}/{index}/latency

e.g. /channel/input/1/latency

  • basisread-only
  • introducedFramesread-only
  • introducedMsread-only
  • quantumread-only
  • rateread-only
  • totalFramesread-only
  • totalMsread-only
  • transportFramesread-only
  • transportMsread-only
Example response
{
  "basis": [
    {
      "frames": 1024,
      "ms": 21.333333333333332,
      "term": "quantum-in"
    },
    {
      "frames": 1024,
      "ms": 21.333333333333332,
      "term": "quantum-out"
    }
  ],
  "introducedFrames": 0,
  "introducedMs": 0,
  "quantum": 1024,
  "rate": 48000,
  "totalFrames": 2048,
  "totalMs": 42.666666666666664,
  "transportFrames": 2048,
  "transportMs": 42.666666666666664
}

Limiter

GETPATCH/channel/{kind}/{index}/limiter

e.g. /channel/main/1/limiter

  • ceilingDbwritable-12–0 dBFS, step 0.1
  • gainReductionDbread-only
  • lookaheadMswritable0.5–5 ms, step 0.1
  • onwritable
  • releaseMswritable1–1000 ms, step 1
  • truePeakDbread-only
Example response
{
  "ceilingDb": -1,
  "gainReductionDb": 0,
  "lookaheadMs": 1.5,
  "on": false,
  "releaseMs": 50,
  "truePeakDb": -180
}

Link

GETPATCH/channel/{kind}/{index}/link

e.g. /channel/input/1/link

  • linkedwritable
  • partnerwritable
  • roleread-only
Example response
{
  "linked": false,
  "partner": null,
  "role": null
}

Loudness

GETon demand/channel/{kind}/{index}/loudness

e.g. /channel/input/1/loudness

No fields observed on the reference rig.

Loudness setup

GETPATCH/channel/{kind}/{index}/loudnessSetup

e.g. /channel/main/1/loudnessSetup

  • resetIntegratedwritable
  • targetLufswritable-40–0 LUFS, step 0.5
  • targetPresetsread-only
Example response
{
  "resetIntegrated": false,
  "targetLufs": -23,
  "targetPresets": [
    -14,
    -16,
    -23
  ]
}

Meter

GETon demand/channel/{kind}/{index}/meter

e.g. /channel/input/1/meter

  • atread-only
  • levelread-only
Example response
{
  "at": 0,
  "level": -6.023529411764713
}

Mix minus

GETPATCH/channel/{kind}/{index}/mixMinus

e.g. /channel/aux/1/mixMinus

  • enabledwritable
Example response
{
  "enabled": false
}
GET/channel/{kind}/{index}/mixMinus/excluded

e.g. /channel/input/1/mixMinus/excluded

No fields observed on the reference rig.

Mute

GETPATCH/channel/{kind}/{index}/mute

e.g. /channel/input/1/mute

  • audibleMuteread-only
  • byGroupread-only
  • byPanicread-only
  • bySipread-only
  • individualwritable
Example response
{
  "audibleMute": false,
  "byGroup": false,
  "byPanic": false,
  "bySip": false,
  "individual": false
}

Name

GETPATCH/channel/{kind}/{index}/name

e.g. /channel/input/1/name

  • namewritable
Example response
{
  "name": ""
}

Pan

GETPATCH/channel/{kind}/{index}/pan

e.g. /channel/input/1/pan

  • panwritable-1–1
Example response
{
  "pan": 0
}

Polarity

GETPATCH/channel/{kind}/{index}/polarity

e.g. /channel/input/1/polarity

  • invertedwritable
Example response
{
  "inverted": false
}

Recall safe

GETPATCH/channel/{kind}/{index}/recallSafe

e.g. /channel/input/1/recallSafe

  • allwritable
  • effectiveread-only
  • scopeswritable

    fader · mute · sends · eq · dyn · inserts · patch

Example response
{
  "all": false,
  "effective": [],
  "scopes": []
}

Record

GETPATCH/channel/{kind}/{index}/record

e.g. /channel/input/1/record

  • armedwritable
  • tapswritable

    Post-Trim · Pre-Fader · Post-Fader

Example response
{
  "armed": true,
  "taps": [
    "Post-Trim",
    "Post-Fader"
  ]
}

Room

GETPATCH/channel/{kind}/{index}/room/apply

e.g. /channel/main/1/room/apply

  • hzwritable
  • paramsread-only
  • progressread-only
  • refusalread-only
  • reportread-only
  • runningwritable
  • startedAtread-only
Example response
{
  "running": false
}
GETPATCH/channel/{kind}/{index}/room/clear

e.g. /channel/main/1/room/clear

  • paramsread-only
  • progressread-only
  • refusalread-only
  • reportread-only
  • runningwritable
  • startedAtread-only
Example response
{
  "running": false
}
GETon demand/channel/{kind}/{index}/room/measurement

e.g. /channel/input/1/room/measurement

No fields observed on the reference rig.

GETPATCH/channel/{kind}/{index}/room/sweep

e.g. /channel/main/1/room/sweep

  • paramsread-only
  • progressread-only
  • refusalread-only
  • reportread-only
  • runningwritable
  • startedAtread-only
Example response
{
  "running": false
}

Rta

GETPATCH/channel/{kind}/{index}/rta/arming

e.g. /channel/main/1/rta/arming

  • armedwritable
  • holdersread-only
Example response
{
  "armed": false,
  "holders": []
}

Send

GETPATCH/channel/{kind}/{index}/send/{busKind}/{busIndex}

e.g. /channel/input/1/send/main/1

  • levelread-only0–1
  • tapwritable

    Top-Of-Ch · Post-Trim · Pre-EQ · Post-EQ · Pre-Fader · Post-Fader

Example response
{
  "db": 0,
  "level": 0.75,
  "tap": "Post-Fader"
}

Solo

GETPATCH/channel/{kind}/{index}/solo

e.g. /channel/input/1/solo

  • solowritable
Example response
{
  "solo": false
}

Solo safe

GETPATCH/channel/{kind}/{index}/soloSafe

e.g. /channel/input/1/soloSafe

  • safewritable
Example response
{
  "safe": false
}

Source

GETPATCH/channel/{kind}/{index}/source

e.g. /channel/input/1/source

  • modewritable

    live · track

Example response
{
  "mode": "live"
}

Speaker align

GETon demand/channel/{kind}/{index}/speakerAlign/{side}

e.g. /channel/input/1/speakerAlign/1

No fields observed on the reference rig.

Spectrum

GETon demand/channel/{kind}/{index}/spectrum

e.g. /channel/input/1/spectrum

  • atread-only
  • bandsread-only
  • magsread-only
  • mutedread-only
Example response
{
  "at": 0,
  "mags": [],
  "muted": false
}

Trim

GETPATCH/channel/{kind}/{index}/trim

e.g. /channel/input/1/trim

  • dbwritable-24–24 dB, step 0.1
Example response
{
  "db": 0
}

True peak

GETPATCH/channel/{kind}/{index}/truePeak

e.g. /channel/main/1/truePeak

  • atread-only
  • ceilingDbread-only
  • countread-only
  • overwritable
Example response
{
  "at": null,
  "ceilingDb": null,
  "count": 0,
  "over": false
}

Width

GET/channel/{kind}/{index}/width

e.g. /channel/input/1/width

  • widthread-only
Example response
{
  "width": "mono"
}

Dca

GETPATCH/channel/dca/{index}/members

e.g. /channel/dca/1/members

  • memberswritable
  • parentswritable
Example response
{
  "members": [
    {
      "index": 2,
      "kind": "input"
    }
  ],
  "parents": []
}

Matrix

GETPATCH/channel/matrix/{index}/input/{srcKind}/{srcIndex}

e.g. /channel/matrix/1/input/matrix/1

  • levelwritable0–1
Example response
{
  "db": -90,
  "level": 0
}

Mute group

GETPATCH/channel/muteGroup/{index}/active

e.g. /channel/muteGroup/1/active

  • activewritable
Example response
{
  "active": false
}
GETPATCH/channel/muteGroup/{index}/colour

e.g. /channel/muteGroup/1/colour

  • colourwritable

    · red · amber · green · cyan · blue · violet

Example response
{
  "colour": ""
}
GETPATCH/channel/muteGroup/{index}/members

e.g. /channel/muteGroup/1/members

  • memberswritable
Example response
{
  "members": [
    {
      "index": 2,
      "kind": "input"
    }
  ]
}
GETPATCH/channel/muteGroup/{index}/name

e.g. /channel/muteGroup/1/name

  • namewritable
Example response
{
  "name": ""
}

openmixer

A software mixing console for Linux. The desk is the software; the browser is the surface.

Pages

Licence

OpenMixer is free software under the GPL-3.0-or-later. Every package in the workspace carries the same licence.

Roland, Midas, Behringer, RME and the product names used here belong to their respective owners. OpenMixer is an independent project and is not affiliated with any of them.