中文简体    English


Definition

N Indicates that the current field is a number
S Indicates that the current field is a string
FI Support Foscam IPC
FN Supoort Foscam NVR
FB Support Foscam BPI
IN Support the use of embedded SDK NVR
II Support the use of embedded SDK IPC
A Amba platform
H Hisi platform

Remark

All event data is in Json format. The first column indicates the Json data Key value. If FI FN FB is not used … specially indicates that a certain type of device is supported, indicating that the device supports it.


  1. Night vision IRCUT state changed

IVY_CTRL_MSG_DAY_NIGHT_MODE_CHG = 42022

  • Support device type
FI FB FN
  • Json description
mode 0:Auto 1:Manual 2:Schedule N FI FB FN
onoff 0:off 1:on N FI FB FN
ch Channel number N FB FN

  1. Preset point changed

IVY_CTRL_MSG_PRESET_CHG = 42023

  • Support device type
FI FN
  • Json description
pointList Preset point name, An array of Json strings S
curPoint Current preset name S

  1. Cruise changed

IVY_CTRL_MSG_CRUISE_CHG = 42024

  • Support device type
FI FN
  • Json description
cruiseList Cruise name, An array of Json strings S
curCruise Current cruise name S

  1. Reach preset point

IVY_CTRL_MSG_PRESET_REACHED = 42025

  • Support device type
FI
  • Json description
name name S

  1. Current cruise state changed

IVY_CTRL_MSG_CURRENT_CRUISE_MAP_STATE_CHG = 42026

  • Support device type
FI
  • Json description
state state N
name name S

  1. Mirror flip

IVY_CTRL_MSG_MIRROR_FLIP_CHG = 42021

  • Support device type
FI
  • Json description
mirror 0:normal 1:mirror N
flip 0:normal 1:flip N

  1. Reach the edge

IVY_CTRL_MSG_EDGE_ARRIVED = 42027

  • Support device type
FI
  • Json description
orientation N

  1. Event of open playback

IVY_CTRL_MSG_START_PLAY_RESULT = 42028

  • Support device type
FI
  • Json description
result result N
totalTime Total time, unit is ms N
totalFrame Total video frame N
videoWidth width N
videoHeight height N

  1. Device information event

IVY_CTRL_MSG_GET_PRODUCT_ALL_INFO = 42029

  • Support device type
FI
  • Json description
model model number N
modelName name S
productAllVersion product version N
ambarellaFlag amba flag N
  • Remark

ambarellaFlag:
bit0:hdr
bit1: wdr
bit2:ept


  1. Device expansion status changed

IVY_CTRL_MSG_EXT_STATE_CHG = 42032

  • Support device type
FB
  • Json description
ch Channel number N
powerStatus power state N
batteryLv Battery level N
wifiLv Wifi signal level N
temperature temperature N

  1. The device plays the time up to the maximum event

IVY_CTRL_MSG_EXT_STATE_CHG = 42031

  • Support device type
FB
  • Json description
ch Channel number N

  1. Main stream parameter changed

IVY_CTRL_MSG_STREAM_PARAM_CHG = 42033

  • Support device type
FI
  • Json description
mainStreamType The current main stream uses parameter index N
subStreamType The current sub stream uses parameter index N
param Json array, The array content is an array of video parameters S
  • param json description
bitRate bitRate N
frameRate frameRate N
GOP GOP N
isVBR 0:No 1:Yes N
resolution resolution N

  1. Sub stream parameter changed

IVY_CTRL_MSG_SUB_STREAM_PARAM_CHG = 42034

  • Support device type
FI
  • Json description
mainStreamType The current main stream uses parameter index N
subStreamType The current sub stream uses parameter index N
param Json array, The array content is an array of video parameters S
  • param json description
bitRate bitRate N
frameRate frameRate N
GOP GOP N
isVBR 0:No 1:Yes N
resolution Resolution N

  1. Sub stream type changed

IVY_CTRL_MSG_SUB_STREAM_TYPE_CHG = 42036

  • Support device type
FI
  • Json description
streamType The mode used by the current stream(0-3)Corresponding to the video parameters used by the current device(13/14 event param) N

  1. Main stream type changed

IVY_CTRL_MSG_STREAM_TYPE_CHG = 42035

  • Support device type
FI
  • Json description
streamType The mode used by the current stream(0-3)Corresponding to the video parameters used by the current device(13/14 event param) N

  1. The volume changes

IVY_CTRL_MSG_VOLUME_CHG = 42038

  • Support device type
FI
  • Json description
vol volume value 0 - 99 N
mute 0:No mute 1:Mute N

  1. Channel device status changed

IVY_CTRL_MSG_IPCLIST_CHG = 42020

  • Support device type
FB FN IN
  • Json description
raws State data, json array S
  • raws Json description
channel Channel number N FB / FN / IN
isOnline 0:offline 1:online N FB / FN / IN
appVer application firmware version N FB / FN / IN
sysVer system firmware version N FB / FN / IN
name name(BASE64 encode) N FB / FN / IN
macAddr MAC N FB / FN / IN
workState 0:Normal 1:Stand by N FB / FN
powerStatus 0:Not charged 1:Charging 2:Full charge 3:Only adapter, no battery N FB / FN / IN
batteryLevel level 0:Power 10% 1:Power 20% 2:Power 50% 3:Power 80% 4:Power 100% N FB / FN
wifiLevel WIFI signal level (0-4) N FB / FN
temperature temperature 0:Low temperature warning 1:Low temperature 2:Normal temperature 3:high temperature 4:High temperature warning N FB / FN
protocol Protocol version N FN / FB

  1. Channel device capability changes

IVY_CTRL_MSG_ABILITY_CHG = 42037

  • Support device type
FB / FN
  • Json description
channel Channel number N
language language N
sensorType sensor type N
wifiType wifi type N
appVer Application firmware version N
sysVer System firmware version N
mcuVer MCU version N
modelName model name N
ability Bitwise 0:No support 1:Support N
model model number N
  • ability description
bit0 sd
bit1 outdoor
bit2 pt
bit3 zoom
bit4 rs485
bit5 ioAlarm
bit6 onvif
bit7 p2p
bit8 wps
bit9 audio
bit10 talk
bit11 amba motion

  1. Device state changed

IVY_CTRL_MSG_EXT_STATE_CHG = 42032

  • Support device type
FB
  • Json description
channel Channel number N
powerStatus Power state N
batteryLv Battery level N
wifiLv Wifi level N
temperature Temperature N
  • Remark

powerStatus / batteryLv / wifiLv / temperature reference IVY_CTRL_MSG_IPCLIST_CHG definition


  1. Upgrade event

IVY_CTRL_MSG_ONLINE_UPGRADE_STATE = 42019

  • Support device type
FB FI FN II IN
  • Json description
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 Channel number N
  • Remark
    If the device on the channel is upgraded, there will be this field (if the value is -1, it means that the SDK did not find the correct channel number)
    If you are upgrading the base station, there will be no channel field

  1. Play music state changed

IVY_CTRL_MSG_MUSIC_STATE_CHG = 42044

  • Support device type
FI
  • Json description
state state N
mode mode N
path Path N
minutes N

  1. Diconnect event

NET_STATE_DISCONNECT = 88

  • Support device type
FI II

  1. Reconnect event

NET_STATE_RECONNECT = 89

  • Support device type
FI
  • Json description
ret 0:Success Other:Fail N

  1. Binding B1 process state event

IVY_CTRL_MSG_BIND_DEVICE_STATE_CHG = 42045

  • Support device type
FB
  • Json description
state state N
channel Channel Number N
mac mac S
  • state
0 Unknown
1 Enter WPS
2 WPS success
3 WPS timeout
4 WPS fail
5 Successful authentication
6 Authentication failed
7 The binding is successful, the pairing ends
8 Binding failed

  1. Alarm

IVY_CTRL_MSG_ALARM_CHG = 42047

  • Support device type
FI FN
  • Json description
alarmType Alarm type N FI / FN
isEnableLocalAlarmRecod Local alarm enabled N FI
localAlarmRecordSecs Duration of local alarm recording N FI
channels The channel that generated the alarm, expressed in bits N FN
  • alarmType description
0 Motion Detect Alarm
1 Sound Alarm
2 IO Alarm
3 TEMPERATURE Alarm
4 HUMIDITY Alarm
8 BELLKEY Alarm (DoorBell,Press and release immediately to trigger)
10 Leave Message Alarm (DoorBell,Long press 3s)
11 Face Alarm (DoorBell, detect any face will trigger)
  • remark

If an alarm occurs, FoscamIPC or the doorbell will operate according to the alarm linkage, such as recording, emailing, cloud recording, etc. For the linkage of alarms, please refer to the linkage in IVY_CTRL_MSG_SET_MOTION_DETECT_CONFIG = 24031


  1. PC alaram

IVY_CTRL_MSG_PC_ALARM_CHG = 42049

  • Support device type
FI
  • Json description
isAlarming Is alarming 0:No 1:Yes N
alarmType type N
isEnablePCAudioAlarm 0:off 1:on N
alarmSecs N
reserve reserve N
  • alarmType description
0 Motion Detect Alarm
1 Sound Alarm
2 IO Alarm
3 TEMPERATURE Alarm
4 HUMIDITY Alarm
8 BELLKEY Alarm (DoorBell,Press and release immediately to trigger)
10 Leave Message Alarm (DoorBell,Long press 3s)
11 Face Alarm (DoorBell, detect any face will trigger)

  1. Device image color change

IVY_CTRL_MSG_IMAGE_COLOR_CHG = 42050

  • Support device type
FI
  • Json description
hue (0-100) N
brightness (0-100) N
contrast (0-100) N
saturation (0-100) N
sharpness (0-100) N

  1. WDR changed

IVY_CTRL_MSG_WDR_CHG = 42051

  • Support device type
FI
  • Json description
enable 0:off 1:on N

  1. Download video progress

IVY_CTRL_MSG_RECORD_DOWNLOAD_PROGRESS = 2063

  • Support device type
II
  • Json description
progress 0-100 N

  1. White light state changes

IVY_CTRL_MSG_WHITE_LIGHT_STATE_CHG = 42053

  • Supported device types
FI
  • Json data description
mode 0:auto 1:manual 2:schedule N
state 0:off 1:on N

  1. Change of video stream type (switching between H264/H265)

IVY_CTRL_MSG_STREAM_FMT_CHG = 42055

  • Supported device types
FI
  • Json data description
streamType 0: Main stream 1: Sub stream N
streamFmt 0:H264 1:H265 N

  1. The status of the SD card changes, such as the SD card becomes full and becomes read-only, etc.

IVY_CTRL_MSG_SDCARD_STATE_CHG = 42058

  • supporting device
IVY
  • output
stat status value N
  • stat definition
0x00 SD card normal
0x01 SD card not inserted
0x02 SD card not mounted
0x03 SD card read only
0x04 Insufficient SD card space
0x05 SD card unknown status
0x06 Abnormal SD card status

  1. Battery power changes

IVY_CTRL_MSG_BATTERY_QUANTITY_CHG = 42059

  • supporting device
IVY
  • output
quantity power value (0-100, if 30 means 30%, and so on) N
ischarge 0: Not charging 1: Charging N
chargeType 0: Adapter charging 1: Solar charging (this field may not exist) N

  1. Automatic/full color/black and white night vision mode settings change (this event will only occur on devices supported by V3 BIT8 or BIT29)

IVY_CTRL_MSG_LIGHT_VISION_CHG = 42060

  • supporting device
IIFI
  • output
Field Meaning Type II FI
whiteLight 0: The white light is not turned on 1: The white light is turned on N ×
lightVisionState Night vision mode bit0: automatic mode, bit1: full-color night vision, bit2: infrared night vision; if V3 BIT29 is supported, this value is 0, indicating that it is in the mode of turning off automatic/full-color/infrared N

  1. Video source changed

IVY_CTRL_MSG_VIDEO_STREAM_SOURCE_CHG = 42061

  • supporting device
IVY
  • output
channel Device channel number, if it is IPC, it can be ignored N
src Current video source index N

  1. Two-way video status changes

IVY_CTRL_MSG_VIDEO_CALL_STATUS_CHG = 42062

  • supporting device
IVY
  • output
channel Device channel number, if it is IPC, it can be ignored N
stat 0-make a call, 1-cancel the call, 2-answer, 3-reject, 4-hang up N

  1. Format SD card result event

IVY_CTRL_MSG_SDCARD_FORMAT_RESULT_CHG = 42063

  • supporting device
IVY
  • output
formatResult 0: formatting successful, -1: formatting failed N

  1. Turn on two-way video events

IVY_CTRL_MSG_OPEN_SEND_CALL_RESP = 2074

Although this value is not within the scope of the event, this value is the result of turning on two-way video, and we give the result as an event.

  • supporting device
IVY
  • output
ret 0: Success, -13: Intercom occupied N

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