定义

N 表示当前字段为数字
S 表示当前字段为字符串
FI 表示支持Foscam IPC
FN 表示支持Foscam NVR
FB 表示支持Foscam BPI
IN 表示支持使用嵌入式SDK NVR
II 表示支持使用嵌入式SDK IPC
A 表示安霸平台
H 表示海思平台

说明

所有事件数据都是Json格式,第一列表示Json数据Key值,**如果没有使用FI FN FB…特殊表明支持某一类设备,表示设备都支持。


  1. 夜视 IRCUT 状态改变

IVY_CTRL_MSG_DAY_NIGHT_MODE_CHG = 42022

  • 支持设备类型
FI FB FN
  • Json数据说明
mode 0:自动 1:手动 2:计划 N FI FB FN
onoff 0:关 1:开 N FI FB FN
ch 通道号 N FB FN

  1. 预置点改变

IVY_CTRL_MSG_PRESET_CHG = 42023

  • 支持设备类型
FI FN
  • Json数据说明
pointList 预置点名称,一个Json字符串数组 S
curPoint 当前预置点名称 N

  1. 巡航改变

IVY_CTRL_MSG_CRUISE_CHG = 42024

  • 支持设备类型
FI FN
  • Json数据说明
cruiseList 巡航名称,一个Json字符串数组 S
curCruise 当前巡航名称 N

  1. 到达预置点

IVY_CTRL_MSG_PRESET_REACHED = 42025

  • 支持设备类型
FI
  • Json数据说明
name 名称 S

  1. 当前巡航状态该改变

IVY_CTRL_MSG_CURRENT_CRUISE_MAP_STATE_CHG = 42026

  • 支持设备类型
FI
  • Json数据说明
state 状态 N
name 名称 S

  1. 镜像翻转

IVY_CTRL_MSG_MIRROR_FLIP_CHG = 42021

  • 支持设备类型
FI
  • Json数据说明
mirror 0:正常 1:镜像 N
flip 0:正常 1:翻转 N

  1. 到达边缘

IVY_CTRL_MSG_MIRROR_FLIP_CHG = 42021

  • 支持设备类型
FI
  • Json数据说明
orientation N

  1. 回放打开后事件

IVY_CTRL_MSG_START_PLAY_RESULT = 42028

  • 支持设备类型
FI
  • Json数据说明
result 结果 N
totalTime 可播放总事件,单位是ms N
totalFrame 可播放总帧数 N
videoWidth 视频宽度 N
videoHeight 视频高度 N

  1. 获取设备所有信息事件

IVY_CTRL_MSG_GET_PRODUCT_ALL_INFO = 42029

  • 支持设备类型
FI
  • Json数据说明
model model号 N
modelName model名称 S
productAllVersion 产品版本 N
ambarellaFlag amba标志位 N
  • 备注

ambarellaFlag:
bit0:hdr
bit1: wdr
bit2:ept


  1. 设备扩展状态改变

IVY_CTRL_MSG_EXT_STATE_CHG = 42032

  • 支持设备类型
FB
  • Json数据说明
ch 通道号 N
powerStatus 电池状态 N
batteryLv 电量级别 N
wifiLv WIFI信号强度 N
temperature 温度级别 N

  1. 设备播放达时间到最大事件

IVY_CTRL_MSG_EXT_STATE_CHG = 42031

  • 支持设备类型
FB
  • Json数据说明
ch 通道号 N

  1. 主码流视频参数发生改变

IVY_CTRL_MSG_STREAM_PARAM_CHG = 42033

  • 支持设备类型
FI
  • Json数据说明
mainStreamType 当前主码流使用param的索引 N
subStreamType 当前子码流使用param的索引 道号 N
param 参数,Json数组,数组内容是视频参数数组 S
  • param Json数据说明
bitRate 码率 N
frameRate 帧率 N
GOP GOP N
isVBR 0:否 1:是 N
resolution 分辨率 N

  1. 子码流视频参数发生改变

IVY_CTRL_MSG_SUB_STREAM_PARAM_CHG = 42034

  • 支持设备类型
FI
  • Json数据说明
mainStreamType 当前主码流使用param的索引 N
subStreamType 当前子码流使用param的索引 道号 N
param 参数,Json数组,数组内容是视频参数数组 S
  • param Json数据说明
bitRate 码率 N
frameRate 帧率 N
GOP GOP N
isVBR 0:否 1:是 N
resolution 分辨率 N

  1. 子码流模式发生改变

IVY_CTRL_MSG_SUB_STREAM_TYPE_CHG = 42036

  • 支持设备类型
FI
  • Json数据说明
streamType 当前码流使用的模式(0-3),对应当前设备使用的视频参数(13/14事件中的param) N

  1. 主码流模式发生改变

IVY_CTRL_MSG_STREAM_TYPE_CHG = 42035

  • 支持设备类型
FI
  • Json数据说明
streamType 当前码流使用的模式(0-3),对应当前设备使用的视频参数(13/14事件中的param) N

  1. 音量发生改变

IVY_CTRL_MSG_VOLUME_CHG = 42038

  • 支持设备类型
FI
  • Json数据说明
vol 音量 0 - 99 N
mute 0:不静音 1:静音 N

  1. 通道设备状态发生改变

IVY_CTRL_MSG_IPCLIST_CHG = 42020

  • 支持设备类型
FB FN IN
  • Json数据说明
raws 状态数据,Json结构数组 S
  • raws Json结构说明
channel 通道号 N FB / FN / IN
isOnline 0:离线 1:在线 N FB / FN / IN
appVer 应用固件版本号 N FB / FN / IN
sysVer 系统固件版本号 N FB / FN / IN
name 名称(BASE64编码) N FB / FN / IN
macAddr MAC N FB / FN / IN
workState 0:正常工作 1:待命 N FB / FN
powerStatus 0:未充电 1:正在充电 2:充电已满 3:只有适配器,没有电池 N FB / FN / IN
batteryLevel 电量级别 0:电量10% 1:电量20% 2:电量50% 3:电量80% 4:电量100% N FB / FN
wifiLevel WIFI信号强度 (0-4) N FB / FN
temperature 温度 0:低温警告 1:低温 2:正常温度 3:高温 4:高温警告 N FB / FN
protocol 协议版本号 N FN / FB
devType 0-其他IPC 1-foscam IPC N IN

  1. 通道设备能力集发生改变

IVY_CTRL_MSG_ABILITY_CHG = 42037

  • 支持设备类型
FB / FN
  • Json数据说明
channel 通道号 N
language 语言 N
sensorType sensor类型 N
wifiType wifi类型 N
appVer 应用固件版本号 N
sysVer 系统固件版本号 N
mcuVer MCU版本号 N
modelName model名字 N
ability 能力集,按位表示,每一位 0:不支持 1:支持 N
model model号 N
  • ability能力集定义
bit0 sd
bit1 outdoor
bit2 pt
bit3 zoom
bit4 rs485
bit5 ioAlarm
bit6 onvif
bit7 p2p
bit8 wps
bit9 audio
bit10 talk
bit11 anba motion

  1. 设备状态改变

IVY_CTRL_MSG_EXT_STATE_CHG = 42032

  • 支持设备类型
FB
  • Json数据说明
channel 通道号 N
powerStatus 电源状态 N
batteryLv 电量状态 N
wifiLv wifi类型 N
temperature 温度 N
  • 备注

powerStatus / batteryLv / wifiLv / temperature 见 IVY_CTRL_MSG_IPCLIST_CHG 定义


  1. 升级事件

IVY_CTRL_MSG_ONLINE_UPGRADE_STATE = 42019

  • 支持设备类型
FB FI FN II IN
  • Json数据说明
state 0:ok 1:upgrading 2:fail 3:File check ok N
progress 0-100 N
Errno 0:normal 1:Net error 2:File error 255:Device internal error N
channel 通道号 N
  • 备注
    如果是通道上的设备升级,会有此字段(如果值为-1,表示SDK没有找到正确的通道号)
    如果是给基站升级,不会有channel这个字段

  1. 童谣状态改变

IVY_CTRL_MSG_MUSIC_STATE_CHG = 42044

  • 支持设备类型
FI
  • Json数据说明
state 状态 N
mode 模式 N
path 路径 N
minutes N

  1. 连接断开事件

NET_STATE_DISCONNECT = 88

  • 支持设备类型
FI II

  1. 重连事件

NET_STATE_RECONNECT = 89

  • 支持设备类型
FI
  • Json数据说明
ret 0:成功 其他值:失败 N

  1. 绑定B1过程状态

IVY_CTRL_MSG_BIND_DEVICE_STATE_CHG = 42045

  • 支持设备类型
FB
  • Json数据说明
state 状态 N
channel 通道 N
mac mac S
  • state
0 未知状态
1 进入WPS
2 WPS成功
3 WPS超时
4 WPS失败
5 认证成功
6 认证失败
7 绑定成功,配对结束
8 绑定失败

  1. 报警

IVY_CTRL_MSG_ALARM_CHG = 42047

  • 支持设备类型
FI FN
  • Json数据说明
alarmType 报警类型 N FI / FN
isEnableLocalAlarmRecod 是否启用本地报警 N FI
localAlarmRecordSecs 本地报警时长 N FI
channels 产生报警的通道,按位表示 N FN
  • alarmType类型
0 Motion Detect Alarm
1 Sound Alarm
2 IO Alarm
3 TEMPERATURE Alarm
4 HUMIDITY Alarm
8 BELLKEY Alarm (门铃,按下立即松开触发)
10 Leave Message Alarm (门铃,长按3s触发)
11 Face Alarm (检测到人脸,报警)
  • 备注

如果发生报警,FoscamIPC或者门铃会根据报警联动做操作,比如录像,发邮件,云录像等等, 报警联动参考命令 IVY_CTRL_MSG_SET_MOTION_DETECT_CONFIG = 24031 中的 linkage


  1. 本地PC报警

IVY_CTRL_MSG_PC_ALARM_CHG = 42049

  • 支持设备类型
FI
  • Json数据说明
isAlarming 是否在报警 0:否 1:是 N
alarmType 报警类型 N
isEnablePCAudioAlarm 0:关闭 1:开启 N
alarmSecs ? N
reserve 保留 N
  • alarmType类型
0 Motion Detect Alarm
1 Sound Alarm
2 IO Alarm
3 TEMPERATURE Alarm
4 HUMIDITY Alarm
8 BELLKEY Alarm (门铃,按下立即松开触发)
10 Leave Message Alarm (门铃,长按3s触发)
11 Face Alarm (检测到人脸,报警)

  1. 设备图像色彩改变

IVY_CTRL_MSG_IMAGE_COLOR_CHG = 42050

  • 支持设备类型
FI
  • Json数据说明
hue (0-100) N
brightness (0-100) N
contrast (0-100) N
saturation (0-100) N
sharpness (0-100) N

  1. WDR改变

IVY_CTRL_MSG_WDR_CHG = 42051

  • 支持设备类型
FI
  • Json数据说明
enable 0:off 1:on N

  1. 下载录像进度

IVY_CTRL_MSG_RECORD_DOWNLOAD_PROGRESS = 2063

  • 支持设备类型
II / FN / FI
  • Json数据说明
progress 0-100 N II / FN / FI
index NVR录像索引 N FN

  1. 白光状态变化

IVY_CTRL_MSG_WHITE_LIGHT_STATE_CHG = 42053

  • 支持设备类型
FI
  • Json数据说明
mode 0:auto 1:manual 2:schedule N
state 0:off 1:on N

  1. 视频码流类型改变(H264/H265之间的切换)

IVY_CTRL_MSG_STREAM_FMT_CHG = 42055

  • 支持设备类型
FI
  • Json数据说明
streamType 0:主码流 1:子码流 N
streamFmt 0:H264 1:H265 N

  1. SD卡状态发生变化,比如SD卡满了变成只读等等

IVY_CTRL_MSG_SDCARD_STATE_CHG = 42058

  • 支持设备
IVY
  • 输出
stat 状态值 N
  • stat 定义
0x00 SD卡正常
0x01 SD卡未插入
0x02 SD卡未挂载
0x03 SD卡只读
0x04 SD卡空间不足
0x05 SD卡未知状态
0x06 SD卡状态异常

  1. 电池电量发生变化

IVY_CTRL_MSG_BATTERY_QUANTITY_CHG = 42059

  • 支持设备
IVY
  • 输出
quantity 电量值(0-100,如果30就表示30%,以此类推) N
ischarge 0:未充电 1:充电中 N
chargeType 0:适配器充电 1:太阳能充电 (该字段可能不存在) N

  1. 自动/全彩/黑白夜视模式设置发生改变(V3 BIT8 或者 BIT29支持的设备才会有这个事件)

IVY_CTRL_MSG_LIGHT_VISION_CHG = 42060

  • 支持设备
II FI
  • 输出
字段 含义 类型 II FI
whiteLight 0:白光灯未开启 1:白光灯已开启 N ×
lightVisionState 夜视模式 bit0:自动模式,bit1:全彩夜视,bit2:红外夜视; 如果支持V3 BIT29,这个值为0,表示处于关闭 自动/全彩/红外 的模式 N

  1. 视频源发生改变

IVY_CTRL_MSG_VIDEO_STREAM_SOURCE_CHG = 42061

  • 支持设备
IVY
  • 输出
channel 设备通道号,如果是 IPC 可以忽略 N
src 当前视频源索引 N

  1. 双向视频状态发生改变

IVY_CTRL_MSG_VIDEO_CALL_STATUS_CHG = 42062

  • 支持设备
IVY
  • 输出
channel 设备通道号,如果是 IPC 可以忽略 N
stat 0-拨打通话,1-取消呼叫,2-接听,3-拒绝,4-挂断 N

  1. 格式化SD卡结果事件

IVY_CTRL_MSG_SDCARD_FORMAT_RESULT_CHG = 42063

  • 支持设备
IVY
  • 输出
formatResult 0: 格式化成功,-1: 格式化失败 N

  1. 打开双向视频事件

IVY_CTRL_MSG_OPEN_SEND_CALL_RESP = 2074

虽然这个值不在事件范围内,这个值是打开双向视频的结果,我们将结果以事件的方式给出。

  • 支持设备
IVY
  • 输出
ret 0: 成功,-13: 对讲被占用 N

文档更新时间: 2024-01-11 10:12   作者:庄小婵