7. Lightware REST API Reference
UCX series – User's Manual
86
Applied firmware package: v1.2.0b9 | LDC software: v2.5.10b1
7.10.
USB Port Settings
7.10.1.
Switch USB Input
Request and Response
#usb
ɯ
header:
POST·http://
<ip>
/api/V1/MEDIA/USB/XP/switch
<host>
/H1·HTTP/1.1
ɯ
body:
<host>
:H1
ɮ
header:
200 OK
ɮ
body:
<host>
:H1
Parameters
Parameter
Parameter description
Values
Value description
<host>
USB Host
0
U1-U4
disconnected
USB-C and USB-B port number
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MEDIA/USB/XP/switch HTTP/1.1
ɯ
body: U1:H1
ɮ
header:
200 OK
ɮ
body: OK
INFO:
When using the '0' value as an input, the input will be disconnected and no signal will appear on the
output.
7.10.2. Query the Connected Source
Request and Response
ɯ
header:
GET·http://
<ip>
/api/V1/MEDIA/USB/XP/H1/ConnectedSource·HTTP/1.1
ɮ
header: 200·OK
ɮ
body:
<host>
Parameters
Parameter
Parameter description
Values
Value description
<host>
USB Host
U1-U4
USB-C and USB-B port number
Example
ɯ
header:
GET http://192.168.0.50/api/V1/MEDIA/USB/XP/H1/ConnectedSource HTTP/1.1
ɮ
header:
200 OK
ɮ
body: U4
7.10.3. Query the Connected Destinations
Request and Response
#autoselect
ɯ
header:
GET·http://
<ip>
/api/V1/MEDIA/USB/XP/
<host>
/ConnectedDestinations·HTTP/1.1
ɮ
header: 200·OK
ɮ
body:
<host>
Parameters
Parameter
Parameter description
Values
Value description
<host>
USB Host
U1-U4
USB-C and USB-B port number
Example
ɯ
header:
GET http://192.168.0.50/api/V1/MEDIA/USB/XP/U3/ConnectedDestinations HTTP/1.1
ɮ
header:
200 OK
ɮ
body: H1
7.10.4.
Lock the USB Port
Request and Response
#lock
ɯ
header:
POST·http://
<ip>
/api/V1/MEDIA/USB/XP/
<usb_port>
/Lock·HTTP/1.1
ɯ
body:
<locked_state>
ɮ
header:
200 OK
ɮ
body:
<locked_state>
Parameters
Parameter
Parameter description
Values
Value description
<usb_port>
USB Port
U1-U4
H1
USB-C and USB-B port number
USB hub
<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/USB/XP/U2/Lock HTTP/1.1
ɯ
body: false
ɮ
header:
200 OK
ɮ
body: false