getOSDItem.lua
[INDEX]

ABSTRACT

Get main stream/sub stream text overlay configurations

ARGUMENTS

HTTP Arguments submit: GET; POST

Test this API over HTTP - (URL):

Stream
(MUST)

Specify the stream:

main

Main stream

sub

Sub stream

Test value:

RETURNS

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:

text

Text overlay

time

System date/time

none

Disabled

"Position":
"STRING"

Overlay position. Respectively show:

left-top

Left top corner

top-center

Top center

right-top

Right top corner

left-bottom

Left bottom corner

bottom-center

Bottom center

right-bottom

Right bottom corner

special

Manually specify location

"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:

default

Default, english

song

Chinese, 'SONG'

vera

English, Vera

lucida

English, Lucida

"Size":
INTEGER

Font size.

0

A special value, means the font is in small size. Aka. 16px of 1920x1080 resolution.

1

A special value, means the font is in medium size.

2

A special value, means the font is in large size.

Large than 2

Font size in 'px'.

"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')

}
]
}

OTHER NOTES

KILOVIEW Device HTTP API, v1.0