Return a JSON style result. The JSON format is:
{ /*OBJECT*/ | |||||||||||||||
"Result": NUMBER | 200 means OK, other error code meanings are similar to HTTP Response. | ||||||||||||||
"Status": "STRING" | Status message. Responsing result status of API executive, if there errors, it will describe reasons. | ||||||||||||||
"Data": [ /*ARRAY*/ | Array. Each item is one text overlay item, contents as below: | ||||||||||||||
{ /*OBJECT*/ | |||||||||||||||
"ID": INTEGER | Overlay item ID, range 0-3 | ||||||||||||||
"Type": "STRING" | Overlay contents type:
| ||||||||||||||
"Position": "STRING" | Overlay position. Respectively show:
| ||||||||||||||
"X": INTEGER | Manually specified overlay horizontal location, in pixels. (If 'Position' is 'special') | ||||||||||||||
"Y": INTEGER | Manually specified overlay vertical location, in pixels. (If 'Position' is 'special') | ||||||||||||||
"Font": "STRING" | Font name:
| ||||||||||||||
"Size": INTEGER | Font size.
| ||||||||||||||
"Outline": INTEGER | Font border. 0 means no border, and larger value means heavier border. | ||||||||||||||
"Bold": INTEGER | 0|1, Font bold. 0 means not bold. | ||||||||||||||
"Italic": INTEGER | 0|1, Font italic. 0 means not italic. (NOTE: Current it does not support italic) | ||||||||||||||
"Text": "STRING" | Overlay text( Character encoding must be UTF-8, if 'Type' is 'text') | ||||||||||||||
} | |||||||||||||||
] | |||||||||||||||
} |
KILOVIEW Device HTTP API, v1.0
Copyright (c) 2016, KILOVIEW Electronics.