Skip to main content

API Tree

API docs by Redocly

DHD control api (1.0.0)

Download OpenAPI specification:Download

E-mail: dhd@dhd.audio Terms of Service

This is the basic api tree for DHD consoles with firmware 10.3 and newer.

DHD developer

root

Root of the control api tree

root

Query the whole mixer tree

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "audio": {
    },
  • "control": {
    },
  • "general": {
    }
}

/audio

Query the mixer audio node with all parameters

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "levels": {
    },
  • "loudness": {
    },
  • "mixer": {
    },
  • "pots": {
    },
  • "routing": {
    },
  • "selectors": {
    }
}

/control

The control system.

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "labels": {
    },
  • "logics": {
    }
}

/general

General system information.

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "_api_version": "1.0.0",
  • "_firmware_version": "10.3.0.17",
  • "_hardwareserial": "",
  • "_hourmeter": 0,
  • "_sync2ok": true,
  • "_syncsource": 1,
  • "_systemfrequency": 48001,
  • "_systemtime": 0,
  • "_uptime": 0
}

/range

All value ranges and units, delivered as json objects. Self-documenting, so no documentation given.

Authorizations:
token

Responses

audio/flexprocessings

Flex processings

audio/levels

Level detect related operations

/audio/levels

Query all peak-based level detects of the mixer. Level detects are listed by ID, their types can differ, as defined in toolbox.

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "0": {
    }
}

/audio/levels/{levelDetectID}

Query the state of the level detect

Authorizations:
token
path Parameters
levelDetectID
required
any

ID of level detect to return

Responses

Response samples

Content type
application/json
{
  • "_correlation": 0,
  • "_left": -125,
  • "_mode": "PPM",
  • "_name": "PGM1",
  • "_right": -125
}

/audio/levels/{levelDetectID}/_correlation

Query correlation of the level detect

Authorizations:
token
path Parameters
levelDetectID
required
any

ID of level detect to return

Responses

Response samples

Content type
application/json
0
0

/audio/levels/{levelDetectID}/_left

Query the left ppm value of the level detect

Authorizations:
token
path Parameters
levelDetectID
required
any

ID of level detect to return

Responses

Response samples

Content type
application/json
-125

/audio/levels/{levelDetectID}/_right

Query the right ppm value of the level detect

Authorizations:
token
path Parameters
levelDetectID
required
any

ID of level detect to return

Responses

Response samples

Content type
application/json
-125

/audio/levels/{levelDetectID}/_mode

Query the ppm mode of the level detect. Modes can be "PPM", "TruePeak" or "VU"

Authorizations:
token
path Parameters
levelDetectID
required
any

ID of level detect to return

Responses

Response samples

Content type
application/json
-125

/audio/levels/{levelDetectID}/_name

Query the name of the level detect, as defined in Toolbox

Authorizations:
token
path Parameters
levelDetectID
required
any

ID of level detect to return

Responses

Response samples

Content type
application/json
-125

audio/loudness

Loudness detect related operations

/audio/loudness

Query all r128 loudness level detects of the mixer. Level detects are listed by ID

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "0": {
    }
}

/audio/loudness/{levelDetectID}

Query a specific level detect

Authorizations:
token
path Parameters
levelDetectID
required
any

ID of level detect to return

Responses

Response samples

Content type
application/json
{
  • "_leveli": -47,
  • "_levelm": -37,
  • "_levelo": -47,
  • "_levels": -37,
  • "_levelu": -47,
  • "_maxm": -37,
  • "_maxpeak": -150,
  • "_maxs": -37,
  • "_mode": "R128",
  • "_name": "LOUDNESS",
  • "_peak": -172.8
}

/audio/loudness/{levelDetectID}/_leveli

Query the integrated loudness value of the level detect

Authorizations:
token
path Parameters
levelDetectID
required
any

ID of level detect to return

Responses

Response samples

Content type
application/json
-47

/audio/loudness/{levelDetectID}/_levelm

Query the momentary loudness value of the level detect

Authorizations:
token
path Parameters
levelDetectID
required
any

ID of level detect to return

Responses

Response samples

Content type
application/json
-37

/audio/loudness/{levelDetectID}/_levelo

For loudness range measurement, that forms the maximum value measured. The difference between _levelo and _levelu forms the range.

Authorizations:
token
path Parameters
levelDetectID
required
any

ID of level detect to return

Responses

Response samples

Content type
application/json
-47

/audio/loudness/{levelDetectID}/_levels

Query the short term loudness value of the level detect

Authorizations:
token
path Parameters
levelDetectID
required
any

ID of level detect to return

Responses

Response samples

Content type
application/json
-37

/audio/loudness/{levelDetectID}/_levelu

For loudness range measurement, that forms the minimum value measured. The difference between _levelo and _levelu forms the range.

Authorizations:
token
path Parameters
levelDetectID
required
any

ID of level detect to return

Responses

Response samples

Content type
application/json
-47

/audio/loudness/{levelDetectID}/_maxm

Query the maximum momentary loudness value of the level detect

Authorizations:
token
path Parameters
levelDetectID
required
any

ID of level detect to return

Responses

Response samples

Content type
application/json
-37

/audio/loudness/{levelDetectID}/_maxpeak

Query the maximum true peak value of the level detect

Authorizations:
token
path Parameters
levelDetectID
required
any

ID of level detect to return

Responses

Response samples

Content type
application/json
-150

/audio/loudness/{levelDetectID}/_maxs

Query the maximum short term loudness value of the level detect

Authorizations:
token
path Parameters
levelDetectID
required
any

ID of level detect to return

Responses

Response samples

Content type
application/json
-37

/audio/loudness/{levelDetectID}/_mode

Query the mode of the level detect

Authorizations:
token
path Parameters
levelDetectID
required
any

ID of level detect to return

Responses

Response samples

Content type
application/json
"R128"

/audio/loudness/{levelDetectID}/_name

Query the name of the level detect

Authorizations:
token
path Parameters
levelDetectID
required
any

ID of level detect to return

Responses

Response samples

Content type
application/json
"LOUDNESS"

/audio/loudness/{levelDetectID}/_peak

Query the current true peak value of the level detect

Authorizations:
token
path Parameters
levelDetectID
required
any

ID of level detect to return

Responses

Response samples

Content type
application/json
-172.8

audio/mixers

Mixer audio system

/audio/mixers

Query a specific level detect

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "0": {
    }
}

/audio/mixers/{mixerID}

Query a specific level detect

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

Responses

Response samples

Content type
application/json
{
  • "_lastloadedsnap": "Mic1",
  • "automix": {
    },
  • "cleanfeeds": {
    },
  • "faders": {
    },
  • "mutegroups": {
    },
  • "options": {
    },
  • "sourcelist": [
    ]
}

/audio/mixers/{mixerID}/_lastloadedsnap

Name/Label of the last loaded mixer snapshot.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

Responses

Response samples

Content type
application/json
"Mic1"

audio/mixers/automix

Automix group settings

/audio/mixers/{mixerID}/automix

Settings of all automix groups. Group IDs start with 1.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

Responses

Response samples

Content type
application/json
{
  • "1": {
    }
}

/audio/mixers/{mixerID}/automix/{automixID}

Settings of a specific automix groups

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

automixID
required
any

ID of automix group object to return

Responses

Response samples

Content type
application/json
{
  • "_active": true,
  • "maxattenuation": 12,
  • "passiveattenuation": 15,
  • "hold": 260,
  • "ratio": 1.5,
  • "release": 8.5
}

/audio/mixers/{mixerID}/automix/{automixID}/_active

Active state of the automix group. Read only as defined in Toolbox.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

automixID
required
any

ID of automix group object to return

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/automix/{automixID}/maxattenuation

Max attenuation of the automix group.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

automixID
required
any

ID of automix group object to return

query Parameters
set
integer
Example: set=12

Responses

Response samples

Content type
application/json
12

/audio/mixers/{mixerID}/automix/{automixID}/passiveattenuation

Attenuation of passive channels of the automix group.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

automixID
required
any

ID of automix group object to return

query Parameters
set
integer
Example: set=15

Responses

Response samples

Content type
application/json
15

/audio/mixers/{mixerID}/automix/{automixID}/hold

Hold time of the automix group.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

automixID
required
any

ID of automix group object to return

query Parameters
set
integer
Example: set=260

Responses

Response samples

Content type
application/json
260

/audio/mixers/{mixerID}/automix/{automixID}/ratio

Ratio of the automix group.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

automixID
required
any

ID of automix group object to return

query Parameters
set
number <double>
Example: set=1.5

Responses

Response samples

Content type
application/json
1.5

/audio/mixers/{mixerID}/automix/{automixID}/release

Release time of the automix group.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

automixID
required
any

ID of automix group object to return

query Parameters
set
number <double>
Example: set=8.5

Responses

Response samples

Content type
application/json
8.5

audio/mixers/cleanfeeds

Cleanfeed settings

/audio/mixers/{mixerID}/cleanfeeds

Mixer-global settings of all cleanfeeds. cleanfeedID equals respective Bus ID.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

Responses

Response samples

Content type
application/json
{
  • "1": {
    }
}

/audio/mixers/{mixerID}/cleanfeeds/{cleanfeedID}

Mixer-global settings of a specific cleanfeed

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

cleanfeedID
required
any

ID of cleanfeed object to return

Responses

Response samples

Content type
application/json
{
  • "_active": true,
  • "cut": false,
  • "n": false,
  • "outgain": 0,
  • "outsel": false,
  • "srcsel": 0
}

/audio/mixers/{mixerID}/cleanfeeds/{cleanfeedID}/_active

Active state of the cleanfeed. Read only as defined in Toolbox.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

cleanfeedID
required
any

ID of cleanfeed object to return

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/cleanfeeds/{cleanfeedID}/cut

Cut state of the cleanfeed.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

cleanfeedID
required
any

ID of cleanfeed object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/cleanfeeds/{cleanfeedID}/n

Switch cleanfeed return signal between n-1 (off) and n (on).

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

cleanfeedID
required
any

ID of cleanfeed object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/cleanfeeds/{cleanfeedID}/outgain

Cleanfeed output gain.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

cleanfeedID
required
any

ID of cleanfeed object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/cleanfeeds/{cleanfeedID}/outsel

Enables the output selector instead of the cleanfeed as outgoing signal.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

cleanfeedID
required
any

ID of cleanfeed object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/cleanfeeds/{cleanfeedID}/srcsel

Select the cleanfeed source by ID.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

cleanfeedID
required
any

ID of cleanfeed object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

audio/mixers/faders

Fader settings

/audio/mixers/{mixerID}/faders

A list of all faders currently processed within the virtual mixer.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

Responses

Response samples

Content type
application/json
{
  • "0": {
    }
}

/audio/mixers/{mixerID}/faders/{faderID}

All attributes of a fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "_channelcnt": 1,
  • "_defaultlabel": "Mic1",
  • "_faderstart": false,
  • "_lastloadedsnap": "Mic1",
  • "_poolavailable": true,
  • "_readystate": false,
  • "_usecleanfeed": 0,
  • "altinput": false,
  • "bypass": false,
  • "fader": -160,
  • "isolate": false,
  • "label": "Mic1",
  • "memo": false,
  • "meter": {
    },
  • "mutegroups": {
    },
  • "offair": false,
  • "on": true,
  • "_paramlist": [
    ],
  • "pfl1": false,
  • "pfl2": false,
  • "preparation": false,
  • "solo": false,
  • "sourceid": 1,
  • "vcagroup": 0,
  • "voice": false,
  • "options": {
    },
  • "params": {
    }
}

/audio/mixers/{mixerID}/faders/{faderID}/_channelcnt

Represents the number of channels contained within the fader. 1 equals a mono fader, 2 equals stereo, 8 equals 5.1 (5.1 + stereo source).

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
1

/audio/mixers/{mixerID}/faders/{faderID}/_defaultlabel

Represents the default channel label as defind in Toolbox configuration.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
"Mic1"

/audio/mixers/{mixerID}/faders/{faderID}/_faderstart

Fader start logic for the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/_lastloadedsnap

Name/Label of the last loaded channel snapshot aka preset.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
"Mic1"

/audio/mixers/{mixerID}/faders/{faderID}/_poolavailable

Information, if the fader can be assigned another input from sourcelist.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/faders/{faderID}/_readystate

Displays if the channel is ready. Used for signalling ready state, triggered by logic defined in Toolbox.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/_usecleanfeed

Displays if and which cleanfeed is assigned. If value is 0, no cleanfeed is assigned.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/altinput

Use to alternative source as defined in toolbox instead of current input.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/bypass

Bypasses the whole processing of the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/fader

The current fader value in dB.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
number <double>
Example: set=-160

Responses

Response samples

Content type
application/json
-160

/audio/mixers/{mixerID}/faders/{faderID}/isolate

Enable isolate on the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/label

Channel Label. Send empty value to use default label.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
string
Example: set=Mic1

Responses

Response samples

Content type
application/json
"Mic1"

/audio/mixers/{mixerID}/faders/{faderID}/memo

Trigger memory hook of the fader, affects ON key behaviour - see toolbox documentation for further details.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/offair

Offair state of the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/on

Channel on/off.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=true

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/faders/{faderID}/pfl1

PFL1 on/off state.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/pfl2

PFL2 on/off state.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/preparation

Cleanfeed preparation on/off state.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/solo

Solo on/off state.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/sourceid

Channel source ID.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=1

Responses

Response samples

Content type
application/json
1

/audio/mixers/{mixerID}/faders/{faderID}/vcagroup

Assignment of the channel to a vca group.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/voice

Routes the signal to the internal voice bus. If false, it is routed to the internal music bus.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/mutgroups

Assignment of the channel to mute groups.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "0": false
}

/audio/mixers/{mixerID}/faders/{faderID}/mutgroups/{mutegroupID}

Assignment of the channel to mute groups.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

mutegroupID
required
any

ID of mute group object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/options

Returns various channel options.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "autooffair": true,
  • "combilogic0": true,
  • "timerreset": false
}

/audio/mixers/{mixerID}/faders/{faderID}/options/autooffair

Enable auto off air.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=true

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/faders/{faderID}/options/timerreset

Timers will be reset when opening the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/options/combilogic{combilogicID}

Assign channel to a combined logic.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

combilogicID
required
any

ID of combined logic object to return

query Parameters
set
boolean
Example: set=true

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/faders/{faderID}/meter

All metering information of the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "_afl": [
    ],
  • "_input": [
    ],
  • "_pfl": [
    ]
}

/audio/mixers/{mixerID}/faders/{faderID}/meter/_afl

Meter information of the after fader level. Array contains as much channels as channel count.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
[
  • -160
]

/audio/mixers/{mixerID}/faders/{faderID}/meter/_input

Meter information of the source input level. Array contains as much channels as channel count.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
[
  • -160
]

/audio/mixers/{mixerID}/faders/{faderID}/meter/_pfl

Meter information of the pre fader level. Array contains as much channels as channel count.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
[
  • -160
]

/audio/mixers/{mixerID}/faders/{faderID}/_paramlist

Lists all used DSP plugins in the correct signal flow order. Signal flow is defined in Toolbox.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

audio/mixers/faders/busparams

Fader bus parameters

/audio/mixers/{mixerID}/faders/{faderID}/busparams

All bus parameters of a fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "automix": {
    },
  • "bus": {
    },
  • "preparation": {
    }
}

/audio/mixers/{mixerID}/faders/{faderID}/busparams/automix

All channel related automix parameters.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "_active": true,
  • "_gainreduction": 0,
  • "group": 0,
  • "on": false,
  • "passive": false,
  • "weight": 0
}

/audio/mixers/{mixerID}/faders/{faderID}/busparams/automix/_active

If automix is generally enabled for this fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/faders/{faderID}/busparams/automix/_gainreduction

Current gain reduction value in dB. Can also have positive values.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/busparams/automix/group

Assigned automix group.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/busparams/automix/on

Enable/disable automix operation for the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/busparams/automix/passive

Enable/disable passive automix behavior for the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/busparams/automix/weight

Individual weight of the fader within the automix group.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
number <double>
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/busparams/bus

All universal bus assignments of the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "1": {
    }
}

/audio/mixers/{mixerID}/faders/{faderID}/busparams/bus/{busID}

All universal bus assignments of the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

busID
required
any

ID of bus object to return

Responses

Response samples

Content type
application/json
{
  • "_active": true,
  • "gain": 0,
  • "on": true,
  • "type": 2
}

/audio/mixers/{mixerID}/faders/{faderID}/busparams/bus/{busID}/_active

Describes if the function is available. Must be true.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

busID
required
any

ID of bus object to return

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/faders/{faderID}/busparams/bus/{busID}/gain

All universal bus assignments of the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

busID
required
any

ID of bus object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/busparams/bus/{busID}/on

Enable send of the fader on bus.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

busID
required
any

ID of bus object to return

query Parameters
set
boolean
Example: set=true

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/faders/{faderID}/busparams/bus/{busID}/type

Bus send type - 0 = pre switch, 1 = pre fader, 2 = post fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

busID
required
any

ID of bus object to return

query Parameters
set
integer
Example: set=2

Responses

Response samples

Content type
application/json
2

/audio/mixers/{mixerID}/faders/{faderID}/busparams/preparation

Required for pre talk on cleanfeeds.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

/audio/mixers/{mixerID}/faders/{faderID}/busparams/preparation/_active

Describes if the function is available. Must be true.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/faders/{faderID}/busparams/preparation/gain

Pre talk gain on cleanfeed.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

audio/mixers/faders/params

DSP plugin parameters

/audio/mixers/{mixerID}/faders/{faderID}/params

All DSP Plugins and their respective parameters.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "agc": {
    },
  • "compressor": {
    },
  • "deesser": {
    },
  • "deesser2": {
    },
  • "eq": {
    },
  • "expander": {
    },
  • "gain": {
    },
  • "gate": {
    },
  • "limiter": {
    },
  • "panbal": {
    },
  • "r128agc": {
    },
  • "subsonic": {
    },
  • "swc": {
    },
  • "varfilter": {
    }
}

/audio/mixers/{mixerID}/faders/{faderID}/params/agc

Peak-based automatic gain control. Adjusts DGain over time.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "_active": true,
  • "_gainreduction": 0,
  • "freeze": false,
  • "gain": 20,
  • "level": 0,
  • "on": false,
  • "threshold": -20,
  • "velocity": 0.30000000000000004
}

/audio/mixers/{mixerID}/faders/{faderID}/params/agc/_active

Describes if plugin is configured for the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/faders/{faderID}/params/agc/_gainreduction

Current gain reduction value in dB. Can also have positive values.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/agc/freeze

Freeze the agc.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/agc/gain

Maximum signal shift in dB.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=20

Responses

Response samples

Content type
application/json
20

/audio/mixers/{mixerID}/faders/{faderID}/params/agc/level

Output level in dB.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/agc/on

Enable/disable.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/agc/threshold

Freeze threshold of the AGC in dBint.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=-20

Responses

Response samples

Content type
application/json
-20

/audio/mixers/{mixerID}/faders/{faderID}/params/agc/velocity

Control agc velocity in dB/second.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
number <double>
Example: set=0.30000000000000004

Responses

Response samples

Content type
application/json
0.30000000000000004

/audio/mixers/{mixerID}/faders/{faderID}/params/compressor

Compressor plugin.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "_active": true,
  • "_gainreduction": 0,
  • "attack": 7,
  • "gain": 0,
  • "on": false,
  • "ratio": 2,
  • "release": 1,
  • "threshold": 0
}

/audio/mixers/{mixerID}/faders/{faderID}/params/compressor/_active

Describes if plugin is configured for the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/faders/{faderID}/params/compressor/_gainreduction

Current gain reduction value in dB.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/compressor/attack

Compressor attack in ms. This is a integer map for an array of values, defined in /range node.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=7

Responses

Response samples

Content type
application/json
7

/audio/mixers/{mixerID}/faders/{faderID}/params/compressor/gain

Output gain in dB.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/compressor/on

Enable/disable.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/compressor/ratio

Compression ratio, defined in 1:{value}.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
number <double>
Example: set=2

Responses

Response samples

Content type
application/json
2

/audio/mixers/{mixerID}/faders/{faderID}/params/compressor/release

Compressor release in s. This is a integer map for an array of values, defined in /range node.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=1

Responses

Response samples

Content type
application/json
1

/audio/mixers/{mixerID}/faders/{faderID}/params/compressor/threshold

Compressor threshold in dBint.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/deesser

Deesser plugin.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "_active": false,
  • "bandwidth": 0.3,
  • "on": false,
  • "ratio": 1,
  • "sharpness": 1
}

/audio/mixers/{mixerID}/faders/{faderID}/params/deesser/_active

Describes if plugin is configured for the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/deesser/bandwidth

Deesser bandwidth.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
number <double>
Example: set=0.3

Responses

Response samples

Content type
application/json
0.3

/audio/mixers/{mixerID}/faders/{faderID}/params/deesser/on

Enable/disable.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/deesser/ratio

Deesser ratio.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
number <double>
Example: set=1

Responses

Response samples

Content type
application/json
1

/audio/mixers/{mixerID}/faders/{faderID}/params/deesser/sharpness

Deesser sharpness threshold.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
number <double>
Example: set=1

Responses

Response samples

Content type
application/json
1

/audio/mixers/{mixerID}/faders/{faderID}/params/deesser2

Compressor plugin.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "_active": true,
  • "_gainreduction": 0,
  • "frequency": 4000,
  • "on": false,
  • "threshold": 0
}

/audio/mixers/{mixerID}/faders/{faderID}/params/deesser2/_active

Describes if plugin is configured for the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/faders/{faderID}/params/deesser2/_gainreduction

Current gain reduction value in dB.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/deesser2/frequency

Deesser2 freqency.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=4000

Responses

Response samples

Content type
application/json
4000

/audio/mixers/{mixerID}/faders/{faderID}/params/deesser2/on

Enable/disable.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/deesser2/threshold

Deesser2 threshold in dB.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/eq{eqID}

Equalizer plugin. We have 4 EQ bands available, numbered eq1-eq4.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

eqID
required
any

ID of eq object to return

Responses

Response samples

Content type
application/json
{
  • "_active": true,
  • "frequency": 125,
  • "gain": 0.25,
  • "on": true,
  • "q": 1,
  • "type": 0
}

/audio/mixers/{mixerID}/faders/{faderID}/params/eq{eqID}/_active

Describes if plugin is configured for the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

eqID
required
any

ID of eq object to return

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/faders/{faderID}/params/eq{eqID}/frequency

EQ band frequency in Hz.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

eqID
required
any

ID of eq object to return

query Parameters
set
integer
Example: set=125

Responses

Response samples

Content type
application/json
125

/audio/mixers/{mixerID}/faders/{faderID}/params/eq{eqID}/gain

EQ gain in dB. Set in 0.25dB steps.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

eqID
required
any

ID of eq object to return

query Parameters
set
number <double>
Example: set=0.25

Responses

Response samples

Content type
application/json
0.25

/audio/mixers/{mixerID}/faders/{faderID}/params/eq{eqID}/on

Enable/disable.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

eqID
required
any

ID of eq object to return

query Parameters
set
boolean
Example: set=true

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/faders/{faderID}/params/eq{eqID}/q

EQ band q-factor. Option is ignored if type is shelving/high/low.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

eqID
required
any

ID of eq object to return

query Parameters
set
number <double>
Example: set=1

Responses

Response samples

Content type
application/json
1

/audio/mixers/{mixerID}/faders/{faderID}/params/eq{eqID}/type

EQ type. Toggle between 0=bell, 1=notch, 2=high shelving, 3=low shelving.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

eqID
required
any

ID of eq object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/expander

Expander plugin.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "_active": true,
  • "_gainreduction": 0,
  • "attack": 0,
  • "gain": 0,
  • "on": false,
  • "ratio": -2,
  • "release": 3,
  • "threshold": 0
}

/audio/mixers/{mixerID}/faders/{faderID}/params/expander/_active

Describes if plugin is configured for the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/faders/{faderID}/params/expander/_gainreduction

Current gain reduction value in dB.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/expander/attack

Expander attack time in ms. This is a integer map for an array of values, defined in /range node.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/expander/gain

Expander output gain in dB.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/expander/on

Enable/disable.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/expander/ratio

Expander ratio.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
number <double>
Example: set=-2

Responses

Response samples

Content type
application/json
-2

/audio/mixers/{mixerID}/faders/{faderID}/params/expander/release

Expander release time. This is a integer map for an array of values, defined in /range node.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=3

Responses

Response samples

Content type
application/json
3

/audio/mixers/{mixerID}/faders/{faderID}/params/expander/threshold

Expander threshold in dBint.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/gain

Gain parameters.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "_active": true,
  • "_hasagain": false,
  • "_hasp48": false,
  • "again": {
    },
  • "dgain": 0,
  • "p48": false,
  • "phase": false
}

/audio/mixers/{mixerID}/faders/{faderID}/params/gain/_active

Must be active.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/faders/{faderID}/params/gain/_hasagain

Displays if analog gain (again) is available for the input. If false, setting again value will have no effect.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/gain/_hasp48

Displays if 48V phantom power (p48) is available for the input.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/gain/dgain

Set the digital gain in dB.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/gain/p48

Enable 48V phantom power. Changes affect only channels where _hasp48 is true.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/gain/phase

Invert phase.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/gain/again/

Preamp properties. Are different for different I/O modules, so respective properties are reqpresented within this object per fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "_max": 84,
  • "_min": -30,
  • "_step": 1,
  • "inc": 0,
  • "value": 0
}

/audio/mixers/{mixerID}/faders/{faderID}/params/gain/again/_max

Maximum preamp value in dB.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
84

/audio/mixers/{mixerID}/faders/{faderID}/params/gain/again/_min

Minimum preamp value in dB.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
-30

/audio/mixers/{mixerID}/faders/{faderID}/params/gain/again/_step

Increment/decrement step width.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
1

/audio/mixers/{mixerID}/faders/{faderID}/params/gain/again/inc

Increment preamp value in dimensionless steps. Parameter is reset afterwards. Useful for remote control of preamps. Affects absloute again value.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/gain/again/value

Absolute analog gain value in dB.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/gate

Noise gate plugin.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "_active": false,
  • "_gainreduction": 0,
  • "attack": 3,
  • "attenuation": 0,
  • "on": false,
  • "release": 3,
  • "threshold": 0
}

/audio/mixers/{mixerID}/faders/{faderID}/params/gate/_active

Describes if plugin is configured for the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/gate/_gainreduction

Current gain reduction value in dB.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/gate/attack

Gate attack time in ms. This is a integer map for an array of values, defined in /range node.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=3

Responses

Response samples

Content type
application/json
3

/audio/mixers/{mixerID}/faders/{faderID}/params/gate/attenuation

Gate attenuaton in dB.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/gate/on

Enable/disable.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/gate/release

Gate release time in ms. This is a integer map for an array of values, defined in /range node.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=3

Responses

Response samples

Content type
application/json
3

/audio/mixers/{mixerID}/faders/{faderID}/params/gate/threshold

Gate threshold in dBint.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=3

Responses

Response samples

Content type
application/json
3

/audio/mixers/{mixerID}/faders/{faderID}/params/limiter

Limiter plugin.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "_active": true,
  • "_gainreduction": 0,
  • "on": false,
  • "release": 12,
  • "threshold": 0
}

/audio/mixers/{mixerID}/faders/{faderID}/params/limiter/_active

Describes if plugin is configured for the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/faders/{faderID}/params/limiter/_gainreduction

Current gain reduction value in dB.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/limiter/on

Enable/disable.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/limiter/release

Limiter release in db/s.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=12

Responses

Response samples

Content type
application/json
12

/audio/mixers/{mixerID}/faders/{faderID}/params/limiter/threshold

Limiter threshold in dBint.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=12

Responses

Response samples

Content type
application/json
12

/audio/mixers/{mixerID}/faders/{faderID}/params/panbal

Panorama / Balance plugin.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "_active": true,
  • "divergency": 0,
  • "lfeonly": false,
  • "lfesend": -61,
  • "matrix": 0,
  • "panbal": 0,
  • "rear": 0
}

/audio/mixers/{mixerID}/faders/{faderID}/params/panbal/_active

Must be active.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/faders/{faderID}/params/panbal/divergency

Surround sound divergency between l/r speakers (equals 0) and center.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/panbal/lfeonly

Mutes channels FL, FR, C, LS, RS and sends signal only to LFE channel. After fader value. Equals LFE mix mode if disabled.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/panbal/lfesend

Send signals to LFE channels with desired level in dB. After fader value.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=-61

Responses

Response samples

Content type
application/json
-61

/audio/mixers/{mixerID}/faders/{faderID}/params/panbal/matrix

Switch between panbal modes 0=LR, 1=LL, 2=RR, 3=RL, 4=Mono, 5=Mono-3, 6=Mono-6.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/panbal/panbal

panorama (mono faders)/balance (stereo faders). Dimensionless. Center equals 0.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/panbal/rear

Rear/Front balance. Dimensionless. Front equals 0.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/r128agc

EBU r128/Loudness based automatic gain control (agc) plugin. Adjusts DGain to reach target level.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "_active": false,
  • "_gainreduction": 0,
  • "freeze": false,
  • "gain": 0,
  • "level": 0,
  • "on": false,
  • "threshold": -35,
  • "velocity": 1
}

/audio/mixers/{mixerID}/faders/{faderID}/params/r128agc/_active

Describes if plugin is configured for the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/r128agc/_gainreduction

Current gain reduction value in dB. Can also have positive values.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/r128agc/freeze

Freeze the agc.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/r128agc/gain

Maximum signal shift in dB.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/r128agc/level

Output level in dB.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/r128agc/on

Enable/disable.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/r128agc/threshold

Freeze threshold of the AGC in dBint.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=-35

Responses

Response samples

Content type
application/json
-35

/audio/mixers/{mixerID}/faders/{faderID}/params/r128agc/velocity

Control agc velocity in dB/second.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
number <double>
Example: set=1

Responses

Response samples

Content type
application/json
1

/audio/mixers/{mixerID}/faders/{faderID}/params/subsonic

Subsonic plugin.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "_active": true,
  • "frequency": 50,
  • "on": false
}

/audio/mixers/{mixerID}/faders/{faderID}/params/subsonic/_active

Describes if plugin is configured for the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
true

/audio/mixers/{mixerID}/faders/{faderID}/params/subsonic/frequency

subsonic frequency in Hz.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=50

Responses

Response samples

Content type
application/json
50

/audio/mixers/{mixerID}/faders/{faderID}/params/subsonic/on

Enable/disable.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/swc

Stereo Width Control.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
{
  • "_active": false,
  • "direction": 0,
  • "type": false,
  • "width": 20
}

/audio/mixers/{mixerID}/faders/{faderID}/params/swc/_active

Must be active.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/swc/direction

Control stereo direction.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=0

Responses

Response samples

Content type
application/json
0
0

/audio/mixers/{mixerID}/faders/{faderID}/params/swc/ms

Switch between ms (true) and xy (false) mode.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/swc/width

Control stereo width.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

query Parameters
set
integer
Example: set=20

Responses

Response samples

Content type
application/json
20

/audio/mixers/{mixerID}/faders/{faderID}/params/varfilter{filtID}

Variable filter plugin. Currently, var filter plugins are available.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

filtID
required
any

ID of var filter object to return

Responses

Response samples

Content type
application/json
{
  • "_active": false,
  • "frequency": 1000,
  • "hipass": false,
  • "on": false,
  • "order": 1
}

/audio/mixers/{mixerID}/faders/{faderID}/params/varfilter{filtID}/_active

Describes if plugin is configured for the fader.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

filtID
required
any

ID of var filter object to return

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/varfilter{filtID}/frequency

Subsonic frequency.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

filtID
required
any

ID of var filter object to return

query Parameters
set
integer
Example: set=1000

Responses

Response samples

Content type
application/json
1000

/audio/mixers/{mixerID}/faders/{faderID}/params/varfilter{filtID}/hipass

Toggle between highpass (true) and lowpass (false) filter type.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

filtID
required
any

ID of var filter object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/varfilter{filtID}/on

Enable/disable.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

filtID
required
any

ID of var filter object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/faders/{faderID}/params/varfilter{filtID}/order

Order in dB/octave of the filter.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

faderID
required
any

ID of fader object to return

filtID
required
any

ID of var filter object to return

query Parameters
set
integer
Example: set=1

Responses

Response samples

Content type
application/json
1

audio/mixers/mutegroups

Mute group status

/audio/mixers/{mixerID}/mutegroups

On/off state of all mutegroups.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

Responses

Response samples

Content type
application/json
{
  • "0": false
}

/audio/mixers/{mixerID}/mutegroups/{mutegroupID}

On/off state of a specific mutegroup.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

mutegroupID
required
any

ID of mute group object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

audio/mixers/options

Mixer options

/audio/mixers/{mixerID}/options

On/off state of all mutegroups.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

Responses

Response samples

Content type
application/json
{
  • "directoffair": false,
  • "pfl1": {
    },
  • "pfl2": {
    }
}

/audio/mixers/{mixerID}/options/directoffair

Enable direct off air mode.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/options/pfl1

pfl1 options.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

Responses

Response samples

Content type
application/json
{
  • "afl": false,
  • "aflwhenon": false,
  • "mix": false,
  • "reset": false,
  • "resetfader": false,
  • "return": false
}

/audio/mixers/{mixerID}/options/pfl1/afl

Set pfl1 to afl mode.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/options/pfl1/aflwhenon

Toggles pfl1 mode to afl if the fader is opened.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/options/pfl1/mix

If true, several channels can be simultaneously routed to pfl1.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/options/pfl1/reset

If a fader currently routed to any pfl gets opened, the currently active pfl1 routings are reset.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/options/pfl1/resetfader

If a fader currently routed to any pfl gets opened, the currently active pfl1 routing of that fader is reset.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/options/pfl1/return

if a fader routed to pfl1 is opened, it will disable pfl until the fader is closed again.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/options/pfl2

pfl2 options.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

Responses

Response samples

Content type
application/json
{
  • "afl": false,
  • "djpfl": false,
  • "mix": false,
  • "reset": false,
  • "resetfader": false,
  • "return": false
}

/audio/mixers/{mixerID}/options/pfl2/afl

Set pfl2 to afl mode.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/options/pfl2/djpfl

Allows predefined fader position of next channel start, alternating to fader level 0.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/options/pfl2/mix

If true, several channels can be simultaneously routed to pfl2.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/options/pfl2/reset

If a fader currently routed to any pfl gets opened, the currently active pfl2 routings are reset.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/options/pfl2/resetfader

If a fader currently routed to any pfl gets opened, the currently active pfl2 routing of that fader is reset.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

/audio/mixers/{mixerID}/options/pfl2/return

if a fader routed to pfl2 is opened, it will disable pfl until the fader is closed again.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

audio/mixers/sourcelist

Fader source list

/audio/mixers/{mixerID}/sourcelist

A list of available fader sources for assignment, grouped as objects. Assignable through _sourceid valu. Only channels that are assigned to an input pool are displayed.

Authorizations:
token
path Parameters
mixerID
required
any

ID of mixer object to return

Responses

Response samples

Content type
application/json
[
  • {
    }
]

audio/pots

Potentiometers

/audio/pots

Available potentiometers.

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "0": {
    }
}

/audio/pots/{potID}

Query state of a specific potentiometer.

Authorizations:
token
path Parameters
potID
required
any

ID of potentiometer object to return

Responses

Response samples

Content type
application/json
{
  • "_max": 20,
  • "_min": -101,
  • "_name": "Mon 2",
  • "_step": 0.01,
  • "value": -20
}

/audio/pots/{potID}/_max

Maximum value of the potentiometer in dB.

Authorizations:
token
path Parameters
potID
required
any

ID of potentiometer object to return

Responses

Response samples

Content type
application/json
20

/audio/pots/{potID}/_min

Minimum value of the potentiometer in dB.

Authorizations:
token
path Parameters
potID
required
any

ID of potentiometer object to return

Responses

Response samples

Content type
application/json
-101

/audio/pots/{potID}/_name

Label of the potentiometer.

Authorizations:
token
path Parameters
potID
required
any

ID of potentiometer object to return

Responses

Response samples

Content type
application/json
"Mon 2"

/audio/pots/{potID}/_step

Step width of the potentiometer in dB.

Authorizations:
token
path Parameters
potID
required
any

ID of potentiometer object to return

Responses

Response samples

Content type
application/json
0.01

/audio/pots/{potID}/value

Value of the potentiometer in dB. If a physical potentiometer is connected, the value can still be set, but might be overwritten by the physical potentiometer.

Authorizations:
token
path Parameters
potID
required
any

ID of potentiometer object to return

query Parameters
set
number <double>
Example: set=-20

Responses

Response samples

Content type
application/json
-20

/audio/routing/outputs/{outputID}

Output/sink details.

Authorizations:
token
path Parameters
outputID
required
any

ID of output object to return

Responses

Response samples

Content type
application/json
{
  • "_channels": 2,
  • "_device": "Headphone I/O 1",
  • "_name": "HP1"
}

/audio/routing/outputs/{outputID}/_channels

Number of channels the output contains.

Authorizations:
token
path Parameters
outputID
required
any

ID of output object to return

Responses

Response samples

Content type
application/json
2

/audio/routing/outputs/{outputID}/_device

The device/module where the output is located.

Authorizations:
token
path Parameters
outputID
required
any

ID of output object to return

Responses

Response samples

Content type
application/json
"Headphone I/O 1"

audio/routing

Audio routings

/audio/routing

The matrix of the device.

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "inputs": {
    },
  • "outputs": {
    },
  • "routes": {
    }
}

/audio/routing/inputs

Input/source list for routings.

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "0": {
    }
}

/audio/routing/inputs/{inputID}

Input/source details.

Authorizations:
token
path Parameters
inputID
required
any

ID of input object to return

Responses

Response samples

Content type
application/json
{
  • "_channels": 1,
  • "_device": "Mic I/O 1",
  • "_name": "Mic Front"
}

/audio/routing/inputs/{inputID}/_channels

Number of channels the input contains.

Authorizations:
token
path Parameters
inputID
required
any

ID of input object to return

Responses

Response samples

Content type
application/json
1

/audio/routing/inputs/{inputID}/_device

The device/module where the input is located.

Authorizations:
token
path Parameters
inputID
required
any

ID of input object to return

Responses

Response samples

Content type
application/json
"Mic I/O 1"

/audio/routing/inputs/{inputID}/_name

Input label.

Authorizations:
token
path Parameters
inputID
required
any

ID of input object to return

Responses

Response samples

Content type
application/json
"Mic Front"

/audio/routing/outputs

Output/sink list for routings.

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "0": {
    }
}

/audio/routing/outputs/{outputID}/_name

Output label.

Authorizations:
token
path Parameters
outputID
required
any

ID of output object to return

Responses

Response samples

Content type
application/json
"HP1"

/audio/routing/routes

The list of active routes. It is a list of sinks (as keys), which have their individual sources (as values). Sources can be available multiple times.

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "0": {
    }
}

/audio/routing/routes/{routeID}

A defined route. The ID of the route is the ID of the output. Use "off" to disable a route.

Authorizations:
token
path Parameters
routeID
required
any

ID of route object to return

query Parameters
set
string
Example: set=198

Responses

Response samples

Content type
application/json
"198"

audio/selectors

Audio selectors

/audio/selectors

Selector system of the device.

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "selectors": {
    },
  • "sourcelists": {
    }
}

/audio/selectors/selectors

All selectors by their ID.

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "0": {
    }
}

/audio/selectors/selectors/{selectorID}

A selector object.

Authorizations:
token
path Parameters
selectorID
required
any

ID of selector object to return

Responses

Response samples

Content type
application/json
{
  • "_name": "MONITOR1",
  • "_sourcelist": "1",
  • "left": "40",
  • "right": "41"
}

/audio/selectors/selectors/{selectorID}/_name

The selector name.

Authorizations:
token
path Parameters
selectorID
required
any

ID of selector object to return

Responses

Response samples

Content type
application/json
"MONITOR1"

/audio/selectors/selectors/{selectorID}/_sourcelist

The assigned source list. If no sourcelist is assigned, the entry will be "0".

Authorizations:
token
path Parameters
selectorID
required
any

ID of selector object to return

Responses

Response samples

Content type
application/json
"1"

/audio/selectors/selectors/{selectorID}/left

Left source of the selector. Can be any audio source ID. If no source is assigned, ID is 0.

Authorizations:
token
path Parameters
selectorID
required
any

ID of selector object to return

query Parameters
set
string
Example: set=40

Responses

Response samples

Content type
application/json
"40"

/audio/selectors/selectors/{selectorID}/right

Right source of the selector. Can be any audio source ID. If no source is assigned, ID is 0.

Authorizations:
token
path Parameters
selectorID
required
any

ID of selector object to return

query Parameters
set
string
Example: set=41

Responses

Response samples

Content type
application/json
"41"

/audio/selectors/sourcelists

All selector sourcelists by their ID.

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "1": {
    }
}

/audio/selectors/sourcelists/{sourcelistID}

A selector sourcelist object.

Authorizations:
token
path Parameters
sourcelistID
required
any

ID of sourcelist object to return

Responses

Response samples

Content type
application/json
{
  • "_name": "MONITOR LIST",
  • "entries": {
    }
}

/audio/selectors/sourcelists/{sourcelistID}/_name

The name of the selector sourcelist.

Authorizations:
token
path Parameters
sourcelistID
required
any

ID of sourcelist object to return

Responses

Response samples

Content type
application/json
"MONITOR LIST"

/audio/selectors/sourcelists/{sourcelistID}/entries

Available sources of the sourcelist, by their respective ID.

Authorizations:
token
path Parameters
sourcelistID
required
any

ID of sourcelist object to return

Responses

Response samples

Content type
application/json
{
  • "0": {
    }
}

/audio/selectors/sourcelists/{sourcelistID}/entries/{entryID}

Attributes of a specific sourcelist entry.

Authorizations:
token
path Parameters
sourcelistID
required
any

ID of sourcelist object to return

entryID
required
any

ID of entry object to return

Responses

Response samples

Content type
application/json
{
  • "_label": "PGM 1",
  • "_sourcel": "40",
  • "_sourcer": "41"
}

/audio/selectors/sourcelists/{sourcelistID}/entries/{entryID}/_label

The label of the source entry, to be displayed in source selection.

Authorizations:
token
path Parameters
sourcelistID
required
any

ID of sourcelist object to return

entryID
required
any

ID of entry object to return

Responses

Response samples

Content type
application/json
"PGM 1"

/audio/selectors/sourcelists/{sourcelistID}/entries/{entryID}/_sourcel

The left audio source.

Authorizations:
token
path Parameters
sourcelistID
required
any

ID of sourcelist object to return

entryID
required
any

ID of entry object to return

Responses

Response samples

Content type
application/json
"40"

/audio/selectors/sourcelists/{sourcelistID}/entries/{entryID}/_sourcer

The right audio source.

Authorizations:
token
path Parameters
sourcelistID
required
any

ID of sourcelist object to return

entryID
required
any

ID of entry object to return

Responses

Response samples

Content type
application/json
"41"

control

Control system

/control

The control system.

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "labels": {
    },
  • "logics": {
    }
}

/control/logics

All logics available.

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "0": {
    }
}

/control/logics/{logicID}

A specific logic by ID.

Authorizations:
token
path Parameters
logicID
required
any

ID of logic object to return

Responses

Response samples

Content type
application/json
{
  • "_name": "LF1",
  • "_path": "logic function",
  • "value": false
}

/control/logics/{logicID}/_name

Name of the logic.

Authorizations:
token
path Parameters
logicID
required
any

ID of logic object to return

Responses

Response samples

Content type
application/json
"LF1"

/control/logics/{logicID}/_path

Path of the logic within system logic tree.

Authorizations:
token
path Parameters
logicID
required
any

ID of logic object to return

Responses

Response samples

Content type
application/json
"logic function"

/control/logics/{logicID}/value

Value of the logic. Can be set for most logics, some logics might be overwritten by the system.

Authorizations:
token
path Parameters
logicID
required
any

ID of logic object to return

query Parameters
set
boolean
Example: set=false

Responses

Response samples

Content type
application/json
false

general

General system information

/general

General system information.

Authorizations:
token

Responses

Response samples

Content type
application/json
{
  • "_api_version": "1.0.0",
  • "_firmware_version": "10.3.0.17",
  • "_hardwareserial": "",
  • "_hourmeter": 0,
  • "_sync2ok": true,
  • "_syncsource": 1,
  • "_systemfrequency": 48001,
  • "_systemtime": 0,
  • "_uptime": 0
}

/general/_api_version

API version.

Authorizations:
token

Responses

Response samples

Content type
application/json
"1.0.0"

/general/_firmware_version

Firmware version.

Authorizations:
token

Responses

Response samples

Content type
application/json
"10.3.0.17"

/general/_hardwareserial

Hardware serial.

Authorizations:
token

Responses

Response samples

Content type
application/json
""

/general/_hourmeter

Hour meter of the device.

Authorizations:
token

Responses

Response samples

Content type
application/json
0
0

/general/_sync2ok

Sync source 2 status. True if sync source 2 is available. Will become active if source 1 becomes unavailable.

Authorizations:
token

Responses

Response samples

Content type
application/json
true

/general/_syncsource

Current sync source locked by the device. 0=Internal, 1=Sync Source 1, 2=Sync Source 2, .

Authorizations:
token

Responses

Response samples

Content type
application/json
1

/general/_systemfrequency

Current system frequency / sample rate.

Authorizations:
token

Responses

Response samples

Content type
application/json
48001

/general/_systemtime

Current system time.

Authorizations:
token

Responses

Response samples

Content type
application/json
0
0

/general/_uptime

System uptime.

Authorizations:
token

Responses

Response samples

Content type
application/json
0
0