7. Lightware REST API Reference
UCX series – User's Manual
84
Applied firmware package: v1.2.0b9 | LDC software: v2.5.10b1
7.9.8.
Mute the Audio Port 2.
INFO:
The volume of the analog audio output is set to low.
Request and Response
ɯ
header:
POST·http://
<ip>
/api/V1/MEDIA/AUDIO/O3/Mute·HTTP/1.1
ɯ
body:
<muted_state>
ɮ
header:
200 OK
ɮ
body:
<muted_state>
Parameters
Parameter
Parameter description
Values
Value description
<audio_port>
Audio Port
I1-I4
O3
Audio input port number
Audio output port number
<muted_state>
Muted state
true
false
The port is muted.
The port is unmuted.
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MEDIA/AUDIO/O3/Mute HTTP/1.1
ɯ
body: false
ɮ
header:
200 OK
ɮ
body: false
7.9.9. Query the Audio Signal Presence
Request and Response
ɯ
header:
GET·http://
<ip>
/api/V1/MEDIA/AUDIO/
<audio_port>
/SignalPresent·HTTP/1.1
ɮ
header: 200·OK
ɮ
body:
<signal_state>
Parameters
Parameter
Parameter description
Values
Value description
<audio_port>
USB Port
I1-I4
O3
Audio input port number
Audio output port number
<signal_state>
Signal presence
true
false
The audio signal is present.
No audio signal is present.
Example
ɯ
header:
GET http://192.168.0.50/api/V1/MEDIA/AUDIO/I1/SignalPresent HTTP/1.1
ɮ
header:
200 OK
ɮ
body: false
7.9.10.
Analog Audio Output Volume (dB) Setting
Request and Response
#analogaudio #volume
ɯ
header:
POST·http://
<ip>
/api/V1/MEDIA/AUDIO/O3/VolumedB·HTTP/1.1
ɯ
body:
<level>
ɮ
header:
200 OK
ɮ
body:
<level>
Parameter
The
<level>
parameters sets the output volume (attenuation) between -95.62 dB and 0 dB in step of -0.375 dB.
The value is rounded up if necessary to match with the step value.
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MEDIA/AUDIO/O3/VolumedB HTTP/1.1
ɯ
body: -15
ɮ
header:
200 OK
ɮ
body: -15
7.9.11.
Analog Audio Output Volume Percent Setting
Request and Response
ɯ
header:
POST·http://
<ip>
/api/V1/MEDIA/AUDIO/O3/VolumePercent·HTTP/1.1
ɯ
body:
<percent>
ɮ
header:
200 OK
ɮ
body:
<percent>
Parameters
The
<percent>
parameter sets the output volume (attenuation) between 100% and 0%, in step of 1%. The
value is rounded up if necessary to match with the step value.
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MEDIA/AUDIO/O3/VolumePercent HTTP/1.1
ɯ
body: 50
ɮ
header:
200 OK
ɮ
body: 50
