GET /audio/channel/{channelIndex}/input/description
Get the description of the current input of the selected channel
Parameters
Name Type Description
{channelIndex} (required) integer
The index of the channel that its input is being controlled.
(Channels index from 0)
Response
200 - Description of the current input of the selected channel
The response is a JSON object.
Name Type Description
gainRange object
gainRange.Min number The minimum gain value in dB
gainRange.Max number The maximum gain value in dB
capabilities object
capabilities.PhantomPower boolean Input supports setting of phantom power
capabilities.LowCutFilter boolean Input supports setting of low cut filter
capabilities.Padding object
capabilities.Padding.available boolean Input supports setting of padding
capabilities.Padding.forced boolean Padding is forced to be set for the input
capabilities.Padding.value number Value of the padding in dB
404 - Channel does not exist
GET /audio/channel/{channelIndex}/supportedInputs
Get the list of supported inputs and their availability to switch to for the selected channel
Parameters
Name Type Description
{channelIndex} (required) integer
The index of the channel that its supported inputs are being
queried. (Channels index from 0)
Response
200 - The list of supported inputs
The response is a JSON object.
Name Type Description
supportedInputs array
supportedInputs[i] object
supportedInputs[i].schema object
supportedInputs[i].schema.input string
Possible values are: None, Camera - Left, Camera - Right,
Camera - Mono, XLR1 - Mic, XLR1 - Line, XLR2 - Mic, XLR2
- Line, 3.5mm Left - Line, 3.5mm Left - Mic, 3.5mm Right -
Line, 3.5mm Right - Mic, 3.5mm Mono - Line, 3.5mm Mono
- Mic.
supportedInputs[i].available boolean
Is the input available to be switched into from the current
input for the selected channel
404 - Channel does not exist
245Developer Information
To Next Page
Loading...