欢迎您使用KILOVIEW Device HTTP API!

KILOVIEW Device HTTP API是为KILOVIEW全系列网络编码、解码和转换设备设计的软件开发编程接口。KILOVIEW Device HTTP API旨在通过简单的HTTP请求/响应机制, 实现对设备的各种功能控制。软件开发者利用KILOVIEW Device HTTP API,可以达到远程管理和控制设备的目的。

API的每一个功能,对应有一个HTTP请求路径。在当前版本的API中,这个路径的格式是: http://<host-address>[:<http-port>]/api/v1/<filename>.lua 本文档将列出每一个API功能对应的文件名(filename)及其功能描述。同时,在每个API文档中,会有一个测试接口,您可以根据请求参数的描述,在测试接口中填写您需要进 行测试的请求参数,执行测试,可以在线验证API功能,十分方便。

API的请求遵循标准的HTTP协议,开发人员可以使用任何符合HTTP标准的工具、软件开发库来完成API调用(例如Web浏览器,JavaScript库,C/C++的HTTP协议库,JAVA,.NET等)。
参数的提交根据不同API的接口要求,可能为POST或GET,或者两者均可,具体请参见API说明。
API的响应为JSON格式,JSON对象中的每一个参数的意义,请参见每一个API的文档说明。

我们尽可能保持产品API接口的一致,但不可排除因产品特性差异而导致不同产品的API接口会存在部分差异。因此,请开发人员按照KILOVIEW的官方指导,区别和处理这些细节差异。

常规

addUser.lua

添加HTTP登录用户

changeUser.lua

修改HTTP登录用户(的密码)

deviceInfo.lua

获取设备的基本信息

get.lua

通用的参数获取API

getDeviceNames.lua

获取设备的名称配置

getWebServicePort.lua

获得Web (HTTP)服务端口

listUsers.lua

列出当前的HTTP登录用户列表

reboot.lua

重启设备

removeUser.lua

删除HTTP登录用户

reset.lua

快速复位(软重启)

restore.lua

恢复出厂设置

set.lua

通用的参数设置API

setDeviceNames.lua

设置设备的名称

setWebServicePort.lua

配置Web (HTTP)服务端口

upgrade.lua

固件升级

通用的网络操作

getNetInterface.lua

获得设备上的所有网络设备列表

网络数据转发(试验性功能)

addPortForwarding.lua

Add a port forwarding setting

getPortForwardingList.lua

Get port forwarding list

removeAllPortForwarding.lua

Remove all port forwarding items

removePortForwarding.lua

Remove a port forwarding item

以太网连接管理

connectEthernet.lua

连接(或重新连接)一个以太网Connection

getEthernetDetail.lua

获得当前(或指定的)以太网的详细状态信息

getFailsafeAddress.lua

获得Ethernet接口的Failsafe IP地址配置

setEthernet.lua

修改一个有线以太网连接

setFailsafeAddress.lua

设置Ethernet接口的Failsafe IP地址

WIFI管理

addWifiConnection.lua

添加一个WIFI连接

connectWifi.lua

连接到一个WIFI Connection

disconnectWifi.lua

断开当前WIFI连接

forgetWifiConnection.lua

忘记(删除)一个WIFI连接

getWifiConnection.lua

获取WIFI连接配置参数

getWifiDetail.lua

获得当前Wifi的详细状态信息

getWifiGlobal.lua

获得Wi-Fi的全局配置选项

listSSID.lua

获得WIFI扫描的SSID列表

listWifiConnection.lua

列出所有已保存的Wifi连接列表

setWifiConnection.lua

修改一个WIFI连接

setWifiGlobal.lua

设置Wi-Fi的全局配置选项

3G/4G无线广域网管理

addWWanConnection.lua

添加一个无线宽带(WWan)的连接配置

connectWWan.lua

连接到一个WWan Connection

disconnectWWan.lua

断开当前WWan连接

forgetWWanConnection.lua

忘记(删除)一个WWAN连接

getModemDetail.lua

获得当前无线Modem设备(WWan)的详细状态信息

getWWanDetail.lua

获得当前无线宽带连接(WWan)的详细状态信息

listWWanConnection.lua

列出所有已保存的WWan连接配置列表

sendATCommand.lua

向指定无线Modem设备(WWan)发送AT指令

setWWanConnection.lua

修改一个WWan的连接

视频/音频源的管理

getAudioGain.lua

获得音频增益

getAudioLoopThrough.lua

获取模拟音频环出状态

getAudioSource.lua

获得音频信号源信息

getVideoSource.lua

获得视频源信息

selectAudioSource.lua

选择音频信号源

selectVideoSource.lua

选择视频信号源(仅针对具有多个视频输入信号源的设备有效)

setAudioGain.lua

设置音频增益

setAudioLoopThrough.lua

设置模拟音频环出

画面处理

getFlipping.lua

获取视频的旋转/翻转参数配置

getPictureCrop.lua

获取视频后级(编码)图像裁切参数

getSourceCrop.lua

获取视频源图像裁切参数

getSourceScale.lua

获取视频前级缩放的配置参数

setFlipping.lua

设置视频的旋转/翻转参数配置

setPictureCrop.lua

设置视频后级(编码)图像裁切参数

setSourceCrop.lua

设置视频源图像裁切参数

setSourceScale.lua

设置视频前级缩放

视频/音频编码和流媒体

getAudioEngChannel.lua

获取音频编码引擎的通道列表

getJPEGStreaming.lua

获得当前MotionJPEG编码和Streaming参数

getStreamService.lua

获得指定码流(主码流/子码流/Motion-JPEG码流)的媒体服务信息。

getStreamingMode.lua

获得当前的编码/Streaming模式

getVideoEncoding.lua

获取指定码流(主码流/子码流)的编码参数和/或状态

setAudioEngChannel.lua

设置指定音频编码通道的编码参数

setJPEGStreaming.lua

设置MotionJPEG编码/Streaming的参数。

setStreamService.lua

添加流媒体服务 / 设置指定码流、指定媒体服务的参数 / 删除一个流媒体服务

setStreamingMode.lua

设置当前编码/Streaming模式

setVideoEncoding.lua

设置指定码流(主码流/子码流)的编码参数

updateStream.lua

更新主码流/子码流。

录像

deleteRecordFile.lua

删除录像文件

getDisks.lua

获取可移动磁盘列表

getRecordList.lua

获得指定磁盘上的所有录像文件列表

getRecordOptions.lua

获得指定码流的录像选项参数

getRecordingStatus.lua

获得当前录像状态

renameRecordFile.lua

重命名录像文件

setRecordOptions.lua

设置指定码流的录像选项参数

startRecord.lua

开启指定码流的录像

stopRecord.lua

停止指定码流的录像

文字叠加

getOSDItem.lua

获得主码流/子码流的字符叠加配置

setOSDEnable.lua

设置主码流/子码流的字符叠加功能使能

setOSDItem.lua

设置主码流/子码流的字符叠加选项

ONVIF协议支持

addOnvifUser.lua

添加Onvif用户

getOnvif.lua

获取Onvif配置参数

getOnvifUser.lua

获取Onvif用户信息

removeOnvifUser.lua

删除ONVIF用户

setOnvif.lua

配置Onvif参数

setOnvifUser.lua

修改Onvif用户信息(及密码)

区域、位置和时间

getLocation.lua

获取设备的位置/时区配置

getTime.lua

获取设备的时间配置参数

setLocation.lua

设置设备的位置/时区配置

setTime.lua

设置设备时间

开关和LED控制

BatteryControl.lua

电池状态获取以及控制电池

ledControl.lua

控制LED显示状态

setLEDUserControl.lua

设置由用户自行控制LED选项开关