getVideoSource.lua
[INDEX]

ABSTRACT

Get video source information

ARGUMENTS

HTTP Arguments submit: GET; POST

Test this API over HTTP - (URL):

NONE

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": {
/*OBJECT*/

"Sources":
/*ARRAY*/

[ "HDMI|VGA|SDI|CVBS", ... ]

return all video signal sources list of the device supported.

"CurrentSource":
"STRING"

HDMI|VGA|SDI|...|UNKNOWN|DETECTING

Current video signal input source. If it is 'UNKNOWN', means no source; and 'DETECTING' means the device is detecting source in progress( Only for device with multiple input sources)

"SignalLock":
INTEGER

Whether source signal is locked (input video format is identified)

0

Unlocked

1

Locked

"Mode":
"STRING"

Indicating video mode of current signalBeyond the list has not been identified yet.

3g

for SDI signal input, indicating SDI speed mode is 3G-SDI

hd

for SDI signal input, indicating SDI speed mode is HD-SDI

sd

for SDI signal input, indicating SDI speed mode is SD-SDI

hdmi

for HDMI/DVI input, indicating input video is HDMI mode

dvi

for HDMI/DVI input, indicating input video is DVI mode

vga

input is VGA

"Format":
"STRING"

1080p60|1080p59|1080p50|1080p30|1080p29|1080p25|1080p24|720p60|720p59|720p50|720p30|720p29|720p25|720p24|480p|576p|480i|525i|576i|625i|(w)x(h)@(Hz)|UNKNOWN,

Current video input format ID, if format is(w)x(h)@(Hz) [w means width, h means height, Hz means refresh rate, like 800x600@60], that means it is not a standard HDTV format.

Format = UNKNOWN means got an invalid video format.

"FormatName":
"STRING"

video format's friendly name (refer to Format value)

FormatName is a friendly format name, e.g. Format is 720p60, and FormatName should be '1280x720p 60Hz'

"Width":
INTEGER

Current video width

"Height":
INTEGER

Current video height

"Interlaced":
INTEGER

Indicating current video is interlaced or not. 1 is interlaced and 0 is not.

"FrameRate":
NUMBER

Current video frame rate (e.g. 60.0/59.94)

}
}

OTHER NOTES

KILOVIEW Device HTTP API, v1.0