7. Lightware REST API Reference
UCX series – User's Manual
81
Applied firmware package: v1.2.0b9 | LDC software: v2.5.10b1
7.7.
Welcome Screen Settings
7.7.1.
Display Welcome Screen Image
Request and Response
#welcomescreen
ɯ
header:
POST·http://
<ip>
/api/V1/MEDIA/VIDEO/I5/WELCOMESCREEN/ImageEnabled·HTTP/1.1
ɯ
body:
<image_state>
ɮ
header:
200 OK
ɮ
body:
<image_state>
Parameters
Parameter
Parameter description
Values
Value description
<image_state>
true
false
The welcome screen image is displayed.
The welcome screen image is not displayed.
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MEDIA/VIDEO/I5/WELCOMESCREEN/ImageEnabled HTTP/1.1
ɯ
body: true
ɮ
header:
200 OK
ɮ
body: true
7.7.2.
Display Welcome Screen Text
Request and Response
ɯ
header:
POST·http://
<ip>
/api/V1/MEDIA/VIDEO/I5/WELCOMESCREEN/MessageEnabled HTTP/1.1
ɯ
body:
<text_state>
ɮ
header:
200 OK
ɮ
body:
<text_state>
Parameters
Parameter
Parameter description
Values
Value description
<text_state>
true
false
The welcome screen text is displayed.
The welcome screen text is not displayed.
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MEDIA/VIDEO/I5/WELCOMESCREEN/MessageEnabled HTTP/1.1
ɯ
body: false
ɮ
header:
200 OK
ɮ
body: false
7.7.3.
Set Welcome Screen Text
Request and Response
ɯ
header:
POST·http://
<ip>
/api/V1/MEDIA/VIDEO/I5/WELCOMESCREEN/MessageText·HTTP/1.1
ɯ
body:
<text>
ɮ
header:
200 OK
ɮ
body:
<text>
Parameters
The
<text>
may consist of letters (A-Z) and (a-z), hyphen (-), underscore (_), numbers (0-9), space ( ) and dot
(.). Max length: 63 character. Longer names are truncated.
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MEDIA/VIDEO/I5/WELCOMESCREEN/MessageText HTTP/1.1
ɯ
body: helloworld
ɮ
header:
200 OK
ɮ
body: helloworld
7.7.4.
Reset Welcome Screen Image
This command restores the original welcome screen image.
Request and Response
ɯ
header:
POST·http://
<ip>
/api/V1/MEDIA/VIDEO/I5/WELCOMESCREEN/resetImage·HTTP/1.1
INFO:
The body has to be empty, and the content type should be text/plain.
ɮ
header:
200 OK
Example
ɯ
header:
POST http://192.168.0.50/api/V1/MEDIA/VIDEO/I5/WELCOMESCREEN/resetImage HTTP/1.1
ɮ
header:
200 OK