7. Lightware REST API Reference
UCX series – User's Manual
83
Applied firmware package: v1.2.0b9 | LDC software: v2.5.10b1
7.9.4.
Set Autoselect Operation Mode
Request and Response
ɯ
header:
POST·http://
<ip>
/api/V1/MEDIA/AUDIO/AUTOSELECT/O3/Policy·HTTP/1.1
ɯ
body:
<op_mode>
ɮ
header:
200 OK
ɮ
body:
<op_mode>
Parameters
Parameter
Parameter description
Values
Value description
<op_mode>
Operation mode
Follow video
Follows the video crosspoint state
automatically.
Off
Autoselect function is disabled.
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MEDIA/AUDIO/AUTOSELECT/O3/Policy HTTP/1.1
ɯ
body:
Follow video
ɮ
header:
200 OK
ɮ
body:
Follow video
7.9.5.
Set the Followed Video Port to Autoselect
Request and Response
ɯ
header:
POST·http://
<ip>
/api/V1/MEDIA/AUDIO/AUTOSELECT/O3/VideoFollowPort·HTTP/1.1
ɯ
body:
<out>
ɮ
header:
200 OK
ɮ
body:
<out>
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MEDIA/AUDIO/AUTOSELECT/O3/VideoFollowPort HTTP/1.1
ɯ
body: O1
ɮ
header:
200 OK
ɮ
body: O1
7.9.6.
Lock the Audio Port
Request and Response
ɯ
header:
POST·http://
<ip>
/api/V1/MEDIA/AUDIO/XP/
<audio_port>
/Lock·HTTP/1.1
ɯ
body:
<locked_state>
ɮ
header:
200 OK
ɮ
body:
<locked_state>
Parameters
Parameter
Parameter description
Values
Value description
<audio_port>
Audio Port
I1-I4
O3
Audio input port number
Audio output port number
<locked_state>
Locked state
true
false
The port is locked
The port is unlocked
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MEDIA/AUDIO/XP/I2/Lock HTTP/1.1
ɯ
body: false
ɮ
header:
200 OK
ɮ
body: false
7.9.7.
Mute the Audio Port 1.
INFO:
Suspends the connection of the chosen port (no signal is forwarded).
Request and Response
ɯ
header:
POST·http://
<ip>
/api/V1/MEDIA/AUDIO/XP/
<audio_port>
/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/XP/I2/Mute HTTP/1.1
ɯ
body: false
ɮ
header:
200 OK
ɮ
body: false
INFO:
All inputs and analog output ports have a mute property in the audio XP (e.g.
http://
<ip>
/api/V1/
MEDIA/AUDIO/XP/I1.Mute). Outputs have a separate mute function within the port node as well:
▪
http://
<ip>
/api/V1/MEDIA/VIDEO/XP/O1.EmbeddedAudioMute
▪
http://
<ip>
/api/V1/MEDIA/VIDEO/XP/O2.EmbeddedAudioMute
▪
http://
<ip>
/api/V1/MEDIA/AUDIO/O3.Mute