首頁(yè) > 文檔中心 > 實(shí)時(shí)數(shù)據(jù)傳輸 > Web影像傳輸 > Agent

Nebula指令集2

TUTK 設(shè)備接口說(shuō)明 - 核心功能接口（1/8）

指令目錄

1. queryLocalRecordingIntervel
2 .buildTunnel
3. getChannelsCapabilities
4. upgradeChannelFirmware
5. checkChannelUpgradeStatus
6. setLastWill
7. startEventDownloadwithURL
8. getLiveCapabilitiesEx
9. startLiveStreamEx
10. answerDoorBell
11. getGeoLocation
12. startWebRtcEx
13. triggerCloudRecording
14. triggerLocalRecording
15. reboot
16. zoomStep
17. stopLiveStreamEx
18. setPTZPreset
19. gotoPTZPreset
20. deletePTZPreset
21. startPTZPatrol
22. stopPTZPatrol
23. setLightMode
24. getLightStatus
25. setAudioVolume
26. getAudioVolume
27. enableTwoWayAudio
28. disableTwoWayAudio
29. setMotionDetection
30. getMotionDetection
31. setHumanDetection
32. getHumanDetection
33. setVideoQuality
34. getVideoQuality
35. enableMotionAlarm
36. disableMotionAlarm
37. enableHumanAlarm
38. disableHumanAlarm
39. startRecord
40. stopRecord
41. getRecordStatus
42. setRecordSchedule
43. getRecordSchedule
44. enableSoundAlarm
45. disableSoundAlarm
46. setAlarmSensitivity
47. getAlarmSensitivity
48. enableIRCut
49. disableIRCut
50. getIRCutStatus
51. setVideoRotation
52. getVideoRotation
53. enableSDCardFormat
54. getSDCardStatus
55. setSDCardLoopRecord
56. getSDCardLoopRecord
57. enableCloudRecord
58. disableCloudRecord
59. getCloudRecordStatus
60. setAlarmNotification
61. getAlarmNotification
62. enablePTZControl
63. setPTZDirection
64. getPTZStatus

核心接口說(shuō)明

queryLocalRecordingIntervel

描述：查詢(xún)本地錄像時(shí)間區(qū)間

版本： 1.1

指令集： playback

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
startTime	Int	M	開(kāi)始時(shí)間戳（UNIX時(shí)間）
endTime	Int	M	結(jié)束時(shí)間戳（UNIX時(shí)間）
channel	Int	O	通道ID

返回值： 200, 400

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
results	interval object array	M	時(shí)間區(qū)間對(duì)象數(shù)組（每個(gè)區(qū)間為兩個(gè)Int型UNIX時(shí)間戳組成的數(shù)組）

An interval object is an array that contains two “Int” to represent an interval of time by UNIX timestamp.

Profile定義：

{ "func":"queryLocalRecordingIntervel", "args":{ "startTime":"Int", "endTime":"Int", "channels":"Array" }, "return":{ "results":[["Int"]] } }

Nebula指令請(qǐng)求例子：

{ "func":"queryLocalRecordingIntervel", "args":{ "startTime":1512121200, "endTime":1515121200, "channels":[1,2] } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "results":[[1512121200,1512131200],[1512141200,1512151200]] } }

buildTunnel

描述：構(gòu)建隧道連接

版本： 1.1

指令集： tunnel

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
protocol	String	M	隧道協(xié)議類(lèi)型

返回值： 200, 400

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
username	String	M	隧道認(rèn)證用戶(hù)名
password	String	M	隧道認(rèn)證密碼
iotc-channel	Int	M	IOTC通道ID

Profile定義：

{ "func":"buildTunnel", "args":{ "protocol":"String" }, "return":{ "username":"String", "password":"String", "iotc-channel":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"buildTunnel", "args":{ "protocol":"iotc-tunnel" } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "username":"admin", "password":"12345678", "iotc-channel":1 } }

getChannelsCapabilities

描述：獲取通道能力信息

版本： 1.1

指令集： channelInfo

請(qǐng)求參數(shù)： Empty

返回值： 200, 400

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
channels	capability object array	M	通道能力對(duì)象數(shù)組

Elements of a capability object

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
signal	String	M	信號(hào)類(lèi)型
capabilities	String array	M	能力列表
hasBattery	Boolean	M	是否有電池
light	String array	O	燈光能力
ptz	String array	O	PTZ控制能力
sensors	sensor object array	O	傳感器對(duì)象數(shù)組

Elements of a sensor object

Parameter name	Data type	Requirement	Description
sensor	String	M	傳感器類(lèi)型
modes	String array	O	傳感器模式

Please check setEventRecordingTriggers for the enumeration of triggers.

Profile定義：

{ "func":"getChannelsCapabilities", "return":{ "channels":[ { "channel":"Int", "signal":"String", "capabilities":["String"], "light":["String"], "ptz":["String"], "sensors":[{ "sensor":"String", "modes":["String"] } ], "hasBattery":"Boolean" } ] } }

Nebula指令請(qǐng)求例子：

{ "func":"getChannelsCapabilities" }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content": { "channels": [ { "channel": 1, "hasBattery": false, "signal": "TVI", "capabilities": [ "cloudRecording", "mic", "speaker", "full_duplex", "light", "ptz", "sensor", "accelerometer" ], "light": [ "autoDawnDusk" ], "ptz": [ "pan", "tilt", "zoom", "nodes", "patrol" ], "sensors": [ { "sensor": "motion", "modes": [ "motionSensor", "pir" ] }, { "sensor": "objectDetection", "modes": [ "human", "vehicle", "animal" ] }, { "sensor": "facialRecognition", "modes": [ "familiar", "unfamiliar" ] }, { "sensor": "other", "modes": [ "doorbellRing", "lowBattery" ] }, { "sensor": "soundDetection", "modes": [ "babyCry", "rareSound" ] }, { "sensor": "schedule" } ] }, { "channel": 2, "hasBattery": false, "signal": "TVI", "capabilities": [ "cloudRecording", "speaker", "full_duplex", "ptz", "sensor" ], "ptz": [ "pan", "tilt", "zoom" ], "sensors": [ { "sensor": "motion", "modes": [ "lineCrossing", "pir" ] } ] } ] } }

upgradeChannelFirmware

描述：升級(jí)通道固件

版本： 1.1

指令集： ota

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
url	String	M	固件升級(jí)包URL
auto	Boolean	M	自動(dòng)升級(jí)標(biāo)識(shí)

返回值： 200, 400

返回內(nèi)容： Empty

Profile定義：

{ "func": "upgradeChannelFirmware", "args": { "channel": "Int", "url": "String", "auto": "Boolean" } }

Nebula指令請(qǐng)求例子：

{ "func": "upgradeChannelFirmware", "args": { "channel": 1, "url": "https://kota.kalayservice.com/ota/GET/i/Company/Product/Model", "auto": true } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

checkChannelUpgradeStatus

描述：檢查通道升級(jí)狀態(tài)

版本： 1.1

指令集： ota

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
status	Int	M	升級(jí)狀態(tài)（參考checkFirmwareUpgradeStatus枚舉值）

Please check checkFirmwareUpgradeStatus for the enumeration of status

Profile定義：

{ "func": "checkChannelUpgradeStatus", "args": { "channel": "Int" }, "return":{ "status":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func": "checkChannelUpgradeStatus", "args": { "channel": 1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "status":1 } }

setLastWill

描述：設(shè)置遺囑消息

版本： 1.1

指令集： serverNotification

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
url	String	M	通知URL
header	Dictionary	O	請(qǐng)求頭信息

返回值： 200, 400

返回內(nèi)容： Empty

Profile定義：

{ "func":"setLastWill", "args":{ "url":"String", "header": "Dictionary" } }

Nebula指令請(qǐng)求例子：

{ "func":"setLastWill", "args":{ "url":"String", "header": { "headerData1":"242343432423" } } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

startEventDownloadwithURL

描述：通過(guò)URL啟動(dòng)事件下載

版本： 1.1

指令集： playback

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
startTime	Int	O	時(shí)間戳（單位：秒），1.2版本改為可選
channel	Int	O	通道ID
fileName	String	O	若設(shè)備僅能通過(guò)文件名生成下載URL則使用此字段

返回值： 200, 400

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
downloadUrl	String	M	下載URL
filesize	Int	O	文件大?。▎挝唬鹤止?jié)）

Profile定義：

{ "func":"startEventDownloadwithURL", "args":{ "channel":"int", "startTime":"Int" }, "return":{ "downloadUrl":"String", "filesize":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"startEventDownloadwithURL", "args":{ "channel":1, "startTime":1567612800 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "downloadUrl":"http://iotc-tunnel:80/file/to/path", "filesize":12000000 } }

getLiveCapabilitiesEx

描述：獲取直播能力擴(kuò)展信息

版本： 1.1

指令集： liveStreamingEx

請(qǐng)求參數(shù)： Empty

返回值： 200, 400

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
protocol	String array	M	支持的協(xié)議列表
channels	Array of channel object	M	每個(gè)通道的能力信息

The elements of a channel object

Parameter name	Data type	Requirement	Description
channelId	Int	O	通道ID
streamType	String array	M	流類(lèi)型列表

Enumeration of protocol

webrtc
rtsp-iotc-tunnel
iotc-av

Enumeration of streamType

video
audio
subVideo
audioAndVideo
audioAndSubVideo

Profile定義：

{ "func":"getLiveCapabilitiesEx", "return":{ "protocol":["String"], "channels":[ { "channelId":"Int", "streamType":["String"] } ] } }

Nebula指令請(qǐng)求例子：

{ "func":"getLiveCapabilitiesEx" }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "protocol":["rtsp-iotc-tunnel","iotc-av","webrtc"], "channels":[ { "channelId":0, "streamType":["video","audioAndVideo"] }, { "channelId":1, "streamType":["video","audioAndVideo"] } ] } }

or the camera without channelId

{ "statusCode": 200, "statusMsg": "OK", "content":{ "protocol":["rtsp-iotc-tunnel","iotc-av","webrtc"], "channels":[ { "streamType":["video","audioAndVideo"] } ] } }

startLiveStreamEx

描述：啟動(dòng)直播流擴(kuò)展

版本： 1.1

指令集： liveStreamingEx

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channels	Array of channel object	M	通道對(duì)象數(shù)組

The elements of a channel object

Parameter name	Data type	Requirement	Description
channelId	Int	O	通道ID
streamType	String	M	流類(lèi)型（參考getLiveCapabilitiesEx枚舉）
resolution	Object	O	分辨率{width:Int, height:Int}，默認(rèn)最高分辨率
frameRate	Int	O	幀率（fps），默認(rèn)25
bitrate	Int	O	碼率（kbps），默認(rèn)2048

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"startLiveStreamEx", "args":{ "channels":[ { "channelId":"Int", "streamType":"String", "resolution":{ "width":"Int", "height":"Int" }, "frameRate":"Int", "bitrate":"Int" } ] } }

Nebula指令請(qǐng)求例子：

{ "func":"startLiveStreamEx", "args":{ "channels":[ { "channelId":0, "streamType":"video", "resolution":{ "width":1920, "height":1080 }, "frameRate":30, "bitrate":4096 } ] } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

getLiveStreamStatusEx

描述：獲取直播流狀態(tài)擴(kuò)展

版本： 1.1

指令集： liveStreamingEx

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 404

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
status	String	M	流狀態(tài)（running/stopped/error）
streamType	String	M	當(dāng)前流類(lèi)型
resolution	Object	M	當(dāng)前分辨率{width:Int, height:Int}
frameRate	Int	M	當(dāng)前幀率（fps）
bitrate	Int	M	當(dāng)前碼率（kbps）
duration	Int	O	流運(yùn)行時(shí)長(zhǎng)（秒），僅status=running時(shí)返回

Profile定義：

{ "func":"getLiveStreamStatusEx", "args":{ "channel":"Int" }, "return":{ "status":"String", "streamType":"String", "resolution":{ "width":"Int", "height":"Int" }, "frameRate":"Int", "bitrate":"Int", "duration":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"getLiveStreamStatusEx", "args":{ "channel":0 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "status":"running", "streamType":"video", "resolution":{ "width":1920, "height":1080 }, "frameRate":30, "bitrate":4096, "duration":120 } }

setPTZSpeed

描述：設(shè)置PTZ云臺(tái)移動(dòng)速度

版本： 1.1

指令集： ptzControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
panSpeed	Int	M	水平移動(dòng)速度（1-10，1最慢，10最快）
tiltSpeed	Int	M	垂直移動(dòng)速度（1-10，1最慢，10最快）
zoomSpeed	Int	O	變焦速度（1-10，默認(rèn)5）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"setPTZSpeed", "args":{ "channel":"Int", "panSpeed":"Int", "tiltSpeed":"Int", "zoomSpeed":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"setPTZSpeed", "args":{ "channel":1, "panSpeed":8, "tiltSpeed":6, "zoomSpeed":5 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

controlPTZ

描述：控制PTZ云臺(tái)移動(dòng)

版本： 1.1

指令集： ptzControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
action	String	M	操作類(lèi)型（panLeft/panRight/tiltUp/tiltDown/zoomIn/zoomOut）
continuous	Boolean	O	是否持續(xù)移動(dòng)（true/false，默認(rèn)false）
duration	Int	O	移動(dòng)時(shí)長(zhǎng)（秒），僅continuous=false時(shí)生效，默認(rèn)1

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"controlPTZ", "args":{ "channel":"Int", "action":"String", "continuous":"Boolean", "duration":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"controlPTZ", "args":{ "channel":1, "action":"panRight", "continuous":false, "duration":2 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

stopPTZ

描述：停止PTZ云臺(tái)移動(dòng)

版本： 1.1

指令集： ptzControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
action	String	O	停止的操作類(lèi)型（pan/tilt/zoom/all，默認(rèn)all）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"stopPTZ", "args":{ "channel":"Int", "action":"String" } }

Nebula指令請(qǐng)求例子：

{ "func":"stopPTZ", "args":{ "channel":1, "action":"all" } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

getPTZPresetList

描述：獲取PTZ預(yù)置位列表

版本： 1.1

指令集： ptzControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 404

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
presets	Array of Object	M	預(yù)置位列表

The elements of a preset object

Parameter name	Data type	Requirement	Description
presetId	Int	M	預(yù)置位ID（1-255）
presetName	String	O	預(yù)置位名稱(chēng)
pan	Int	O	水平角度（0-360）
tilt	Int	O	垂直角度（0-90）
zoom	Int	O	變焦倍數(shù)（1-10）

Profile定義：

{ "func":"getPTZPresetList", "args":{ "channel":"Int" }, "return":{ "presets":[ { "presetId":"Int", "presetName":"String", "pan":"Int", "tilt":"Int", "zoom":"Int" } ] } }

Nebula指令請(qǐng)求例子：

{ "func":"getPTZPresetList", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "presets":[ { "presetId":5, "presetName":"FrontDoor", "pan":90, "tilt":45, "zoom":3 }, { "presetId":8, "presetName":"BackYard", "pan":270, "tilt":30, "zoom":5 } ] } }

getPTZPatrolList

描述：獲取PTZ巡航列表

版本： 1.1

指令集： ptzControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 404

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
patrols	Array of Object	M	巡航列表

The elements of a patrol object

Parameter name	Data type	Requirement	Description
patrolId	Int	M	巡航ID（1-16）
patrolName	String	O	巡航名稱(chēng)
presetIds	Array of Int	M	巡航包含的預(yù)置位ID列表
dwellTimes	Array of Int	O	每個(gè)預(yù)置位停留時(shí)長(zhǎng)（秒），與presetIds一一對(duì)應(yīng)
speed	Int	O	巡航速度（1-10，默認(rèn)5）

Profile定義：

{ "func":"getPTZPatrolList", "args":{ "channel":"Int" }, "return":{ "patrols":[ { "patrolId":"Int", "patrolName":"String", "presetIds":["Int"], "dwellTimes":["Int"], "speed":"Int" } ] } }

Nebula指令請(qǐng)求例子：

{ "func":"getPTZPatrolList", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "patrols":[ { "patrolId":1, "patrolName":"MainArea", "presetIds":[5,8,10], "dwellTimes":[10,15,10], "speed":6 }, { "patrolId":2, "patrolName":"SideArea", "presetIds":[3,7], "dwellTimes":[8,12], "speed":5 } ] } }

stopLiveStreamEx

描述：停止直播流擴(kuò)展

版本： 1.1

指令集： liveStreamingEx

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channels	Array of channel object	M	通道對(duì)象數(shù)組

The elements of a channel object

Parameter name	Data type	Requirement	Description
channelId	Int	O	通道ID
streamType	String	M	流類(lèi)型（參考getLiveCapabilitiesEx枚舉）

返回值： 200, 400

返回內(nèi)容： Empty

Profile定義：

{ "func":"stopLiveStreamEx", "args":{ "channels":[ { "channelId":"Int", "streamType":"String" } ] } }

Nebula指令請(qǐng)求例子：

{ "func":"stopLiveStreamEx", "args":{ "channels":[ { "channelId":0, "streamType":"video" } ] } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

setPTZPreset

描述：設(shè)置PTZ預(yù)置位

版本： 1.1

指令集： ptzControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
presetId	Int	M	預(yù)置位ID（1-255）
presetName	String	O	預(yù)置位名稱(chēng)

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"setPTZPreset", "args":{ "channel":"Int", "presetId":"Int", "presetName":"String" } }

Nebula指令請(qǐng)求例子：

{ "func":"setPTZPreset", "args":{ "channel":1, "presetId":5, "presetName":"FrontDoor" } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

gotoPTZPreset

描述：跳轉(zhuǎn)至PTZ預(yù)置位

版本： 1.1

指令集： ptzControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
presetId	Int	M	預(yù)置位ID（1-255）
speed	Int	O	移動(dòng)速度（1-10，默認(rèn)5）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"gotoPTZPreset", "args":{ "channel":"Int", "presetId":"Int", "speed":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"gotoPTZPreset", "args":{ "channel":1, "presetId":5, "speed":8 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

deletePTZPreset

描述：刪除PTZ預(yù)置位

版本： 1.1

指令集： ptzControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
presetId	Int	M	預(yù)置位ID（1-255）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"deletePTZPreset", "args":{ "channel":"Int", "presetId":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"deletePTZPreset", "args":{ "channel":1, "presetId":5 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

startPTZPatrol

描述：啟動(dòng)PTZ巡航

版本： 1.1

指令集： ptzControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
patrolId	Int	M	巡航ID（1-16）
speed	Int	O	巡航速度（1-10，默認(rèn)5）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"startPTZPatrol", "args":{ "channel":"Int", "patrolId":"Int", "speed":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"startPTZPatrol", "args":{ "channel":1, "patrolId":1, "speed":6 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

stopPTZPatrol

描述：停止PTZ巡航

版本： 1.1

指令集： ptzControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
patrolId	Int	M	巡航ID（1-16）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"stopPTZPatrol", "args":{ "channel":"Int", "patrolId":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"stopPTZPatrol", "args":{ "channel":1, "patrolId":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

setLightMode

描述：設(shè)置燈光模式

版本： 1.1

指令集： deviceControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
mode	String	M	燈光模式（auto/on/off/dawnDusk）
brightness	Int	O	亮度（1-100，僅mode=on時(shí)生效）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"setLightMode", "args":{ "channel":"Int", "mode":"String", "brightness":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"setLightMode", "args":{ "channel":1, "mode":"on", "brightness":80 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

getLightStatus

描述：獲取燈光狀態(tài)

版本： 1.1

指令集： deviceControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 404

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
mode	String	M	當(dāng)前燈光模式
brightness	Int	O	當(dāng)前亮度（1-100）
status	String	M	實(shí)際狀態(tài)（on/off）

Profile定義：

{ "func":"getLightStatus", "args":{ "channel":"Int" }, "return":{ "mode":"String", "brightness":"Int", "status":"String" } }

Nebula指令請(qǐng)求例子：

{ "func":"getLightStatus", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "mode":"auto", "brightness":80, "status":"on" } }

setAudioVolume

描述：設(shè)置音頻音量

版本： 1.1

指令集： audioControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
type	String	M	音頻類(lèi)型（speaker/mic/all）
volume	Int	M	音量值（0-100）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"setAudioVolume", "args":{ "channel":"Int", "type":"String", "volume":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"setAudioVolume", "args":{ "channel":1, "type":"speaker", "volume":75 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

getAudioVolume

描述：獲取音頻音量

版本： 1.1

指令集： audioControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
type	String	M	音頻類(lèi)型（speaker/mic/all）

返回值： 200, 400, 404

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
volume	Int	M	當(dāng)前音量值（0-100）

Profile定義：

{ "func":"getAudioVolume", "args":{ "channel":"Int", "type":"String" }, "return":{ "volume":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"getAudioVolume", "args":{ "channel":1, "type":"speaker" } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "volume":75 } }

enableTwoWayAudio

描述：啟用雙向音頻

版本： 1.1

指令集： audioControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
mode	String	O	模式（fullDuplex/halfDuplex，默認(rèn)fullDuplex）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"enableTwoWayAudio", "args":{ "channel":"Int", "mode":"String" } }

Nebula指令請(qǐng)求例子：

{ "func":"enableTwoWayAudio", "args":{ "channel":1, "mode":"fullDuplex" } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

disableTwoWayAudio

描述：禁用雙向音頻

版本： 1.1

指令集： audioControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"disableTwoWayAudio", "args":{ "channel":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"disableTwoWayAudio", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

setMotionDetection

描述：設(shè)置移動(dòng)偵測(cè)

版本： 1.1

指令集： detection

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
enable	Boolean	M	是否啟用（true/false）
sensitivity	Int	O	靈敏度（1-10，默認(rèn)5）
regions	Array of Int	O	偵測(cè)區(qū)域（0-65535，默認(rèn)全區(qū)域）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"setMotionDetection", "args":{ "channel":"Int", "enable":"Boolean", "sensitivity":"Int", "regions":["Int"] } }

Nebula指令請(qǐng)求例子：

{ "func":"setMotionDetection", "args":{ "channel":1, "enable":true, "sensitivity":7, "regions":[1,2,3] } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

getMotionDetection

描述：獲取移動(dòng)偵測(cè)配置

版本： 1.1

指令集： detection

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 404

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
enable	Boolean	M	是否啟用
sensitivity	Int	M	靈敏度（1-10）
regions	Array of Int	M	偵測(cè)區(qū)域

Profile定義：

{ "func":"getMotionDetection", "args":{ "channel":"Int" }, "return":{ "enable":"Boolean", "sensitivity":"Int", "regions":["Int"] } }

Nebula指令請(qǐng)求例子：

{ "func":"getMotionDetection", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "enable":true, "sensitivity":7, "regions":[1,2,3] } }

setHumanDetection

描述：設(shè)置人形偵測(cè)

版本： 1.1

指令集： detection

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
enable	Boolean	M	是否啟用（true/false）
sensitivity	Int	O	識(shí)別靈敏度（1-10，默認(rèn)6）
alertEnable	Boolean	O	是否啟用告警（true/false，默認(rèn)false）
regions	Array of Int	O	偵測(cè)區(qū)域（0-65535，默認(rèn)全區(qū)域）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"setHumanDetection", "args":{ "channel":"Int", "enable":"Boolean", "sensitivity":"Int", "alertEnable":"Boolean", "regions":["Int"] } }

Nebula指令請(qǐng)求例子：

{ "func":"setHumanDetection", "args":{ "channel":1, "enable":true, "sensitivity":8, "alertEnable":true, "regions":[1,2,3,4] } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

getHumanDetection

描述：獲取人形偵測(cè)配置

版本： 1.1

指令集： detection

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 404

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
enable	Boolean	M	是否啟用人形偵測(cè)
sensitivity	Int	M	識(shí)別靈敏度（1-10）
alertEnable	Boolean	M	是否啟用告警
regions	Array of Int	M	偵測(cè)區(qū)域
detectStatus	Boolean	O	當(dāng)前是否檢測(cè)到人形（實(shí)時(shí)狀態(tài)）

Profile定義：

{ "func":"getHumanDetection", "args":{ "channel":"Int" }, "return":{ "enable":"Boolean", "sensitivity":"Int", "alertEnable":"Boolean", "regions":["Int"], "detectStatus":"Boolean" } }

Nebula指令請(qǐng)求例子：

{ "func":"getHumanDetection", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "enable":true, "sensitivity":8, "alertEnable":true, "regions":[1,2,3,4], "detectStatus":false } }

setVideoQuality

描述：設(shè)置視頻畫(huà)質(zhì)

版本： 1.1

指令集： videoControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
quality	String	M	畫(huà)質(zhì)等級(jí)（low/medium/high，對(duì)應(yīng)標(biāo)清/高清/超清）
resolution	String	O	分辨率（如1080p/720p/480p，默認(rèn)隨畫(huà)質(zhì)等級(jí)適配）
fps	Int	O	幀率（1-30，默認(rèn)25）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"setVideoQuality", "args":{ "channel":"Int", "quality":"String", "resolution":"String", "fps":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"setVideoQuality", "args":{ "channel":1, "quality":"high", "resolution":"1080p", "fps":30 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

getVideoQuality

描述：獲取視頻畫(huà)質(zhì)配置

版本： 1.1

指令集： videoControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 404

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
quality	String	M	當(dāng)前畫(huà)質(zhì)等級(jí)（low/medium/high）
resolution	String	M	當(dāng)前分辨率
fps	Int	M	當(dāng)前幀率

Profile定義：

{ "func":"getVideoQuality", "args":{ "channel":"Int" }, "return":{ "quality":"String", "resolution":"String", "fps":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"getVideoQuality", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "quality":"high", "resolution":"1080p", "fps":30 } }

enableMotionAlarm

描述：啟用移動(dòng)偵測(cè)告警

版本： 1.1

指令集： alarmControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
alertType	String	O	告警類(lèi)型（sound/light/push/all，默認(rèn)all）
duration	Int	O	告警持續(xù)時(shí)長(zhǎng)（秒，1-300，默認(rèn)30）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"enableMotionAlarm", "args":{ "channel":"Int", "alertType":"String", "duration":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"enableMotionAlarm", "args":{ "channel":1, "alertType":"all", "duration":60 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

disableMotionAlarm

描述：禁用移動(dòng)偵測(cè)告警

版本： 1.1

指令集： alarmControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"disableMotionAlarm", "args":{ "channel":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"disableMotionAlarm", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

enableHumanAlarm

描述：啟用人形偵測(cè)告警

版本： 1.1

指令集： alarmControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
alertType	String	O	告警類(lèi)型（sound/light/push/all，默認(rèn)all）
sensitivity	Int	O	告警觸發(fā)靈敏度（1-10，默認(rèn)7）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"enableHumanAlarm", "args":{ "channel":"Int", "alertType":"String", "sensitivity":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"enableHumanAlarm", "args":{ "channel":1, "alertType":"push", "sensitivity":8 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

disableHumanAlarm

描述：禁用人形偵測(cè)告警

版本： 1.1

指令集： alarmControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"disableHumanAlarm", "args":{ "channel":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"disableHumanAlarm", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

startRecord

描述：開(kāi)始錄像

版本： 1.1

指令集： recordControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
recordType	String	O	錄像類(lèi)型（local/cloud，默認(rèn)local）
duration	Int	O	錄像時(shí)長(zhǎng)（分鐘，1-1440，默認(rèn)無(wú)限時(shí)長(zhǎng)）
quality	String	O	錄像畫(huà)質(zhì)（low/medium/high，默認(rèn)high）

返回值： 200, 400, 404

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
recordId	String	M	錄像任務(wù)ID（唯一標(biāo)識(shí)）

Profile定義：

{ "func":"startRecord", "args":{ "channel":"Int", "recordType":"String", "duration":"Int", "quality":"String" }, "return":{ "recordId":"String" } }

Nebula指令請(qǐng)求例子：

{ "func":"startRecord", "args":{ "channel":1, "recordType":"local", "duration":60, "quality":"high" } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "recordId":"REC20251219100001CH1" } }

stopRecord

描述：停止錄像

版本： 1.1

指令集： recordControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
recordId	String	O	錄像任務(wù)ID（為空時(shí)停止該通道所有錄像）

返回值： 200, 400, 404

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
recordDuration	Int	M	實(shí)際錄像時(shí)長(zhǎng)（秒）
fileSize	Int	M	錄像文件大?。↘B）

Profile定義：

{ "func":"stopRecord", "args":{ "channel":"Int", "recordId":"String" }, "return":{ "recordDuration":"Int", "fileSize":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"stopRecord", "args":{ "channel":1, "recordId":"REC20251219100001CH1" } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "recordDuration":3600, "fileSize":288000 } }

getRecordStatus

描述：獲取錄像狀態(tài)

版本： 1.1

指令集： recordControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
recordId	String	O	錄像任務(wù)ID（為空時(shí)查詢(xún)?cè)撏ǖ浪袖浵駹顟B(tài)）

返回值： 200, 400, 404

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
status	String	M	錄像狀態(tài)（recording/idle/error，對(duì)應(yīng)錄制中/空閑/異常）
currentDuration	Int	M	當(dāng)前錄像時(shí)長(zhǎng)（秒，空閑時(shí)為0）
currentFileSize	Int	M	當(dāng)前錄像文件大?。↘B，空閑時(shí)為0）
recordType	String	M	錄像類(lèi)型（local/cloud，空閑時(shí)為空）

Profile定義：

{ "func":"getRecordStatus", "args":{ "channel":"Int", "recordId":"String" }, "return":{ "status":"String", "currentDuration":"Int", "currentFileSize":"Int", "recordType":"String" } }

Nebula指令請(qǐng)求例子：

{ "func":"getRecordStatus", "args":{ "channel":1, "recordId":"REC20251219100001CH1" } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "status":"recording", "currentDuration":1800, "currentFileSize":144000, "recordType":"local" } }

setRecordSchedule

描述：設(shè)置錄像計(jì)劃

版本： 1.1

指令集： recordControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
scheduleType	String	M	計(jì)劃類(lèi)型（timing/motion/human/all，對(duì)應(yīng)定時(shí)/移動(dòng)偵測(cè)/人形偵測(cè)/全天）
startTime	String	O	開(kāi)始時(shí)間（HH:MM，僅定時(shí)計(jì)劃必填，如08:00）
endTime	String	O	結(jié)束時(shí)間（HH:MM，僅定時(shí)計(jì)劃必填，如20:00）
weekDays	String	O	生效星期（逗號(hào)分隔，如1,3,5，默認(rèn)全部星期生效）
quality	String	O	計(jì)劃錄像畫(huà)質(zhì)（low/medium/high，默認(rèn)high）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"setRecordSchedule", "args":{ "channel":"Int", "scheduleType":"String", "startTime":"String", "endTime":"String", "weekDays":"String", "quality":"String" } }

Nebula指令請(qǐng)求例子：

{ "func":"setRecordSchedule", "args":{ "channel":1, "scheduleType":"timing", "startTime":"08:00", "endTime":"20:00", "weekDays":"1,2,3,4,5", "quality":"medium" } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

getRecordSchedule

描述：獲取錄像計(jì)劃配置

版本： 1.1

指令集： recordControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 404

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
scheduleType	String	M	計(jì)劃類(lèi)型（timing/motion/human/all）
startTime	String	M	開(kāi)始時(shí)間（HH:MM，非定時(shí)計(jì)劃為空）
endTime	String	M	結(jié)束時(shí)間（HH:MM，非定時(shí)計(jì)劃為空）
weekDays	String	M	生效星期（逗號(hào)分隔）
quality	String	M	計(jì)劃錄像畫(huà)質(zhì)（low/medium/high）

Profile定義：

{ "func":"getRecordSchedule", "args":{ "channel":"Int" }, "return":{ "scheduleType":"String", "startTime":"String", "endTime":"String", "weekDays":"String", "quality":"String" } }

Nebula指令請(qǐng)求例子：

{ "func":"getRecordSchedule", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "scheduleType":"timing", "startTime":"08:00", "endTime":"20:00", "weekDays":"1,2,3,4,5", "quality":"medium" } }

enableSoundAlarm

描述：啟用聲音告警（獨(dú)立控制）

版本： 1.1

指令集： alarmControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
soundType	String	O	告警聲音類(lèi)型（siren/beep/voice，默認(rèn)siren）
volume	Int	O	告警音量（1-10，默認(rèn)8）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"enableSoundAlarm", "args":{ "channel":"Int", "soundType":"String", "volume":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"enableSoundAlarm", "args":{ "channel":1, "soundType":"siren", "volume":9 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

disableSoundAlarm

描述：禁用聲音告警（獨(dú)立控制）

版本： 1.1

指令集： alarmControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"disableSoundAlarm", "args":{ "channel":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"disableSoundAlarm", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

setAlarmSensitivity

描述：設(shè)置告警靈敏度（通用）

版本： 1.1

指令集： alarmControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
alarmType	String	M	告警類(lèi)型（motion/human/all，對(duì)應(yīng)移動(dòng)/人形/全部）
sensitivity	Int	M	靈敏度（1-10，1最低/10最高）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"setAlarmSensitivity", "args":{ "channel":"Int", "alarmType":"String", "sensitivity":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"setAlarmSensitivity", "args":{ "channel":1, "alarmType":"all", "sensitivity":6 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

getAlarmSensitivity

描述：獲取告警靈敏度配置（通用）

版本： 1.1

指令集： alarmControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
alarmType	String	O	告警類(lèi)型（motion/human/all，默認(rèn)all）

返回值： 200, 400, 404

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
motionSensitivity	Int	M	移動(dòng)偵測(cè)靈敏度（1-10）
humanSensitivity	Int	M	人形偵測(cè)靈敏度（1-10）

Profile定義：

{ "func":"getAlarmSensitivity", "args":{ "channel":"Int", "alarmType":"String" }, "return":{ "motionSensitivity":"Int", "humanSensitivity":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"getAlarmSensitivity", "args":{ "channel":1, "alarmType":"all" } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "motionSensitivity":6, "humanSensitivity":6 } }

enableIRCut

描述：啟用紅外切換（夜視模式）

版本： 1.1

指令集： videoControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
mode	String	O	紅外模式（auto/manual，默認(rèn)auto）
brightness	Int	O	紅外亮度（1-10，默認(rèn)7，僅手動(dòng)模式生效）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"enableIRCut", "args":{ "channel":"Int", "mode":"String", "brightness":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"enableIRCut", "args":{ "channel":1, "mode":"auto", "brightness":8 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

disableIRCut

描述：禁用紅外切換（關(guān)閉夜視模式）

版本： 1.1

指令集： videoControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"disableIRCut", "args":{ "channel":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"disableIRCut", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

getIRCutStatus

描述：獲取紅外切換狀態(tài)

版本： 1.1

指令集： videoControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 404

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
status	String	M	紅外狀態(tài)（enabled/disabled，對(duì)應(yīng)啟用/禁用）
mode	String	M	紅外模式（auto/manual，禁用時(shí)為空）
brightness	Int	M	紅外亮度（1-10，禁用時(shí)為0）

Profile定義：

{ "func":"getIRCutStatus", "args":{ "channel":"Int" }, "return":{ "status":"String", "mode":"String", "brightness":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"getIRCutStatus", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "status":"enabled", "mode":"auto", "brightness":8 } }

setVideoRotation

描述：設(shè)置視頻旋轉(zhuǎn)角度

版本： 1.1

指令集： videoControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
rotation	Int	M	旋轉(zhuǎn)角度（0/90/180/270，默認(rèn)0）
mirror	Boolean	O	是否鏡像（true/false，默認(rèn)false）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"setVideoRotation", "args":{ "channel":"Int", "rotation":"Int", "mirror":"Boolean" } }

Nebula指令請(qǐng)求例子：

{ "func":"setVideoRotation", "args":{ "channel":1, "rotation":180, "mirror":false } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

getVideoRotation

描述：獲取視頻旋轉(zhuǎn)配置

版本： 1.1

指令集： videoControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 404

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
rotation	Int	M	旋轉(zhuǎn)角度（0/90/180/270）
mirror	Boolean	M	是否鏡像（true/false）

Profile定義：

{ "func":"getVideoRotation", "args":{ "channel":"Int" }, "return":{ "rotation":"Int", "mirror":"Boolean" } }

Nebula指令請(qǐng)求例子：

{ "func":"getVideoRotation", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "rotation":180, "mirror":false } }

enableSDCardFormat

描述：啟用SD卡格式化

版本： 1.1

指令集： storageControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
formatType	String	O	格式化類(lèi)型（quick/full，默認(rèn)quick）
encrypt	Boolean	O	是否加密格式化（true/false，默認(rèn)false）

返回值： 200, 400, 404, 500

返回內(nèi)容： Empty

Profile定義：

{ "func":"enableSDCardFormat", "args":{ "formatType":"String", "encrypt":"Boolean" } }

Nebula指令請(qǐng)求例子：

{ "func":"enableSDCardFormat", "args":{ "formatType":"quick", "encrypt":false } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

getSDCardStatus

描述：獲取SD卡狀態(tài)

版本： 1.1

指令集： storageControl

請(qǐng)求參數(shù)： Empty

返回值： 200, 404, 500

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
status	String	M	SD卡狀態(tài)（normal/error/unmounted/formating，對(duì)應(yīng)正常/異常/未掛載/格式化中）
totalCapacity	Int	M	總?cè)萘浚∕B，未掛載時(shí)為0）
usedCapacity	Int	M	已用容量（MB，未掛載時(shí)為0）
freeCapacity	Int	M	剩余容量（MB，未掛載時(shí)為0）
health	String	M	健康狀態(tài)（good/warning/bad，對(duì)應(yīng)良好/警告/損壞）

Profile定義：

{ "func":"getSDCardStatus", "args":{}, "return":{ "status":"String", "totalCapacity":"Int", "usedCapacity":"Int", "freeCapacity":"Int", "health":"String" } }

Nebula指令請(qǐng)求例子：

{ "func":"getSDCardStatus", "args":{} }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "status":"normal", "totalCapacity":32768, "usedCapacity":15600, "freeCapacity":17168, "health":"good" } }

setSDCardLoopRecord

描述：設(shè)置SD卡循環(huán)錄像

版本： 1.1

指令集： storageControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
enable	Boolean	M	是否啟用循環(huán)錄像（true/false）
reserveDays	Int	O	錄像保留天數(shù)（1-30，默認(rèn)7，僅啟用時(shí)生效）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"setSDCardLoopRecord", "args":{ "channel":"Int", "enable":"Boolean", "reserveDays":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"setSDCardLoopRecord", "args":{ "channel":1, "enable":true, "reserveDays":7 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

getSDCardLoopRecord

描述：獲取SD卡循環(huán)錄像配置

版本： 1.1

指令集： storageControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 404

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
enable	Boolean	M	是否啟用循環(huán)錄像（true/false）
reserveDays	Int	M	錄像保留天數(shù)（1-30）

Profile定義：

{ "func":"getSDCardLoopRecord", "args":{ "channel":"Int" }, "return":{ "enable":"Boolean", "reserveDays":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"getSDCardLoopRecord", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "enable":true, "reserveDays":7 } }

enableCloudRecord

描述：啟用云錄像

版本： 1.1

指令集： cloudControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
quality	String	O	云錄像畫(huà)質(zhì)（low/medium/high，默認(rèn)high）
reserveDays	Int	O	云錄像保留天數(shù)（1-30，默認(rèn)7）

返回值： 200, 400, 401, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"enableCloudRecord", "args":{ "channel":"Int", "quality":"String", "reserveDays":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"enableCloudRecord", "args":{ "channel":1, "quality":"medium", "reserveDays":15 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

disableCloudRecord

描述：禁用云錄像

版本： 1.1

指令集： cloudControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 401, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"disableCloudRecord", "args":{ "channel":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"disableCloudRecord", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

getCloudRecordStatus

描述：獲取云錄像狀態(tài)

版本： 1.1

指令集： cloudControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 401, 404

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
status	String	M	云錄像狀態(tài)（enabled/disabled/expired，對(duì)應(yīng)啟用/禁用/過(guò)期）
quality	String	M	云錄像畫(huà)質(zhì)（low/medium/high，禁用/過(guò)期時(shí)為空）
reserveDays	Int	M	云錄像保留天數(shù)（禁用/過(guò)期時(shí)為0）
expireTime	String	M	過(guò)期時(shí)間（YYYY-MM-DD HH:MM:SS，禁用時(shí)為空）

Profile定義：

{ "func":"getCloudRecordStatus", "args":{ "channel":"Int" }, "return":{ "status":"String", "quality":"String", "reserveDays":"Int", "expireTime":"String" } }

Nebula指令請(qǐng)求例子：

{ "func":"getCloudRecordStatus", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "status":"enabled", "quality":"medium", "reserveDays":15, "expireTime":"2025-12-31 23:59:59" } }

setAlarmNotification

描述：設(shè)置告警通知方式

版本： 1.1

指令集： alarmControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
notificationType	String	M	通知方式（push/sms/email/all/none，對(duì)應(yīng)推送/短信/郵件/全部/無(wú)）
sound	Boolean	O	推送是否帶聲音（true/false，默認(rèn)true）
vibration	Boolean	O	推送是否震動(dòng)（true/false，默認(rèn)true）

返回值： 200, 400, 404

返回內(nèi)容： Empty

Profile定義：

{ "func":"setAlarmNotification", "args":{ "channel":"Int", "notificationType":"String", "sound":"Boolean", "vibration":"Boolean" } }

Nebula指令請(qǐng)求例子：

{ "func":"setAlarmNotification", "args":{ "channel":1, "notificationType":"all", "sound":true, "vibration":true } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

getAlarmNotification

描述：獲取告警通知方式

版本： 1.1

指令集： alarmControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 404

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
notificationType	String	M	通知方式（push/sms/email/all/none）
sound	Boolean	M	推送是否帶聲音（true/false）
vibration	Boolean	M	推送是否震動(dòng)（true/false）

Profile定義：

{ "func":"getAlarmNotification", "args":{ "channel":"Int" }, "return":{ "notificationType":"String", "sound":"Boolean", "vibration":"Boolean" } }

Nebula指令請(qǐng)求例子：

{ "func":"getAlarmNotification", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "notificationType":"all", "sound":true, "vibration":true } }

enablePTZControl

描述：啟用PTZ控制

版本： 1.1

指令集： ptzControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
timeout	Int	O	PTZ控制超時(shí)時(shí)間（秒，10-300，默認(rèn)60）

返回值： 200, 400, 404, 501

返回內(nèi)容： Empty

Profile定義：

{ "func":"enablePTZControl", "args":{ "channel":"Int", "timeout":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"enablePTZControl", "args":{ "channel":1, "timeout":120 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

setPTZDirection

描述：設(shè)置PTZ轉(zhuǎn)動(dòng)方向

版本： 1.1

指令集： ptzControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID
direction	String	M	轉(zhuǎn)動(dòng)方向（up/down/left/right/stop/zoomIn/zoomOut，對(duì)應(yīng)上/下/左/右/停止/放大/縮小）
speed	Int	O	轉(zhuǎn)動(dòng)速度（1-10，默認(rèn)5，停止時(shí)無(wú)效）

返回值： 200, 400, 403, 404, 501

返回內(nèi)容： Empty

Profile定義：

{ "func":"setPTZDirection", "args":{ "channel":"Int", "direction":"String", "speed":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"setPTZDirection", "args":{ "channel":1, "direction":"up", "speed":6 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK" }

getPTZStatus

描述：獲取PTZ狀態(tài)

版本： 1.1

指令集： ptzControl

請(qǐng)求參數(shù)：

Parameter name	Data type	Requirement	Description
channel	Int	M	通道ID

返回值： 200, 400, 404, 501

返回內(nèi)容：

Parameter name	Data type	Requirement	Description
status	String	M	PTZ狀態(tài)（idle/moving/error/unavailable，對(duì)應(yīng)空閑/轉(zhuǎn)動(dòng)中/異常/不支持）
currentDirection	String	M	當(dāng)前方向（up/down/left/right/stop/zoomIn/zoomOut，空閑時(shí)為stop）
panAngle	Int	M	水平角度（0-359，不支持時(shí)為-1）
tiltAngle	Int	M	垂直角度（0-90，不支持時(shí)為-1）
zoomLevel	Int	M	變焦級(jí)別（1-10，1為廣角，不支持時(shí)為-1）

Profile定義：

{ "func":"getPTZStatus", "args":{ "channel":"Int" }, "return":{ "status":"String", "currentDirection":"String", "panAngle":"Int", "tiltAngle":"Int", "zoomLevel":"Int" } }

Nebula指令請(qǐng)求例子：

{ "func":"getPTZStatus", "args":{ "channel":1 } }

Nebula指令回復(fù)例子：

{ "statusCode": 200, "statusMsg": "OK", "content":{ "status":"idle", "currentDirection":"stop", "panAngle":90, "tiltAngle":45, "zoomLevel":3 } }