getAudioSource.lua
[INDEX]

ABSTRACT

Get audio 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*/

[ "DIGITAL|ANALOG|LINE|MIC|HDMI|SDI|...", ... ]

Array, return an audio source lists of the device supported

DIGITAL

Is a general name, for HDMI/SDI signal source with embedded audio, 'DIGITAL' represents embeded audio of HDMI/SDI.

ANALOG

Similarly, 'ANALOG' represents general analog audio input (for most devices, it represents 'Line in' input)

LINE

line in

MIC

Microphone input

HDMI

HDMI embedded audio

SDI

SDI embedded audio

"CurrentSource":
"STRING"

"DIGITAL|ANALOG|LINE|MIC|HDMI|SDI|...|UNKNOWN|DETECTING",Current audio source selected. If it is 'UNKNOWN', means no signal input; and 'DETECTING' means device is detecting signal yet (Only for device with multiple audio sources)

"Sampling":
INTEGER

(E.g. 48000,44100,32000 ...), current audio sampling rate

"Channels":
INTEGER

(E.g. 2), current audio channels

}
}

OTHER NOTES

KILOVIEW Device HTTP API, v1.0