SDK使用手册.doc

SDK编程手册 SDK编程手册 SDK版本修改记录： 版本编号 简要说明 日日期 目录 第一章 简 介 4 1.1 组成 4 第二章 编程指南 5 2.1 编程说明 5 2.2 函数调用顺序 5 第三章 数据结构 14 3.1 客户端数据结构 14 3.1.1 发送模式 14 3.1.2 设备信息结构 14 3.1.3 图像预览参数 16 3.1.4 文字叠加参数 16 3.1.5 文件信息结构 16 3.1.6 上传报警信息 17 3.1.7 报警输出状态 22 3.1.8 设备的状态信息 22 3.1.9 预览编码格式 23 3.1.10 设备通道信息 26 3.1.11 权限配置信息 30 3.1.12 SDK参数类型 32 3.1.13 用户状态信息 32 3.1.14 日志信息 33 3.1.15 互联平台参数 34 3.1.16 旋转与镜像参数类型 34 3.1.17 串口云台控制参数 35 3.1.17 智能分析参数 35 3.2 设备端参数数据结构 41 3.2.1 设备系统配置结构 42 3.2.2 网络配置结构 43 3.2.3 通道图象配置结构 44 3.2.4 压缩参数配置结构 50 3.2.5 录像参数配置结构 52 3.2.6 解码器参数配置结构 54 3.2.7 串口配置结构 55 3.2.8 报警输入配置结构 56 3.2.9 报警输出配置结构 57 3.2.10 本地预览参数配置结构 58 3.2.11 用户参数配置结构 58 3.2.12 异常参数配置结构 60 3.2.14 设备日志 61 3.2.15 图像分辨率 63 3.2.16 直连设备通道信息 64 第四章 函数说明 64 4.1 客户端函数 64 4.1.1 初始化 64 4.1.2 获取错误代码 65 4.1.3 用户注册 66 4.1.4 通道、设备信息 67 4.1.6 云台控制 98 4.1.7 回放/倒放与下载 103 4.1.8 报警 120 4.1.9 语音对讲 150 4.1.10 录像 151 4.1.11 用户、用户组、角色、权限 175 4.1.12 组织机构 189 4.1.13 电子地图 193 4.1.14 区域限制 199 4.1.15 移动侦测 202 4.1.16 主备参数配置 203 4.1.17 数据库 206 4.1.18 日志 208 4.1.19 获取设备状态 212 4.1.20 获取视频编码参数 212 4.1.21 事件历史日志查询 213 4.1.22 设置普通文件通道录像路径 214 4.1.23 获取普通文件通道录像路径 214 4.1.24 获取普通文件通道录像路径 214 4.1.25 获取服务器系统路径 215 4.1.26 SDK参数配置 215 4.1.29修改服务器配置 216 4.1.30列举IPSAN服务IQN 216 4.1.31 IPSAN挂载 216 4.1.32 IPSAN卸载 217 4.1.33 IPSAN状态 217 4.1.34列举IPSAN服务上磁盘 217 4.1.35列举IPSAN服务 218 4.1.36客户端参数配置 218 4.1.37 视频旋转与镜像 219 4.1.38 串口对象添加 220 4.1.39 串口对象删除 220 4.1.40 串口对象信息查询 220 4.1.41上传文件进度回调 221 4.1.42上传文件 221 4.1.43配置RTSP服务器 221 4.1.44获取RTSP服务信息 221 4.1.45启动RTSP服务器 222 4.1.46停止RTSP服务器 222 4.1.47列举所有设备RTSP信息 222 4.1.48获取设备RTSP信息 222 4.1.49获取录像的流传输策略 223 4.1.50设置录像的流传输策略 223 4.1.51设置通道录像的流传输策略 223 4.1.52获取通道录像的流传输策略 224 4.1.53获取设备的组播地址 224 4.1.54打开设备的组播功能并设置组播地址 224 4.1.55是否支持设备组播功能 224 4.1.56 参数备份 225 4.1.57 报警中心 225 4.1.58 设备搜索 226 4.2 设备端配置函数 227 4.2.1 重启/关闭设备 227 4.2.2 锁定、共享 228 4.2.3 心跳 229 4.3 服务器相关函数 230 4.3.1 对象操作 230 4.3.2 数据传输 231 4.3.3 获取/设置前端设备信息 233 4.3.4 服务器管理 236 4.3.5启动Heartbeat 249 4.3.6停止Heartbeat 249 4.3.7获取Heartbeat状态 249 4.3.7获取主备网卡名与IP对应关系 250 4.4 智能分析参数配置 250 4.4.1 视频遮挡参数配置 250 4.4.2 垂直人数统计参数配置 251 4.4.3 周界防范参数配置 251 4.4.4 人脸识别参数配置 252 4.4.5 资产保全定时时间区域参数配置 253 4.5 其它 255 4.5.1 系统参数 255 4.5.2 时间切片 255 4.5.3 释放内存 256 4.5.4 对象序列号 257 4.5.5 yuv解码回调 258 4.5.6 上海技防 259 4.5.7 磁盘信息 261 4.5.8 对象标签 261 4.5.9 Email相关参数设置 262 4.5.10 客户端事件规则属性信息设置 263 4.5.11 高清主机子ID参数配置 264 4.5.12 通过平台升级高清主机 264 3 / 267 第一章 简 介 1.1 组成 l 客户端软件开发包是IAVS服务器的配套产品，本手册详细介绍了此软件开发包中各个函数所实现的功能以及使用方法、各个函数之间的调用关系。 l 客户端软件开发包主要由客户端操作和设备端操作两大部分组成： 客户端操作：图像预览、文件回放和下载、云台控制、布防/撤防、语音对讲、日志管理、解码卡等功能。 l 设备端操作：远程升级、远程重启/关闭、参数配置（系统配置、通道配置、串口配置、报警配置、用户配置）等功能。 第二章 编程指南 2.1 编程说明 l 初始化：使用客户端软件包首先对系统进行初始化ZNET_Init()，退出该软件包则调用ZNET_Cleanup()释放资源,初始化和逆初始化只能执行一次。 l 用户注册：用户在访问设备之前必须通过ZNET_Login()函数到设备上注册，注册成功后返回该用户的ID值。此ID值就像一把钥匙一样，之后该用户都必须通过此ID号访问该设备。退出对设备的操作则通过ZNET_Logout()函数在设备上注销此ID号，该用户就无权访问设备了。 l 主动上传：软件包中所有需主动上传的信息（异常除外）都通过ZNET_EventSubscribe()、ZNET_SpectLevelEventSubscribe()函数设置的回调函数上传（具体回调内容参见函数说明）。 l 云台控制：云台控制分为两种模式，一种是通过图像预览返回的句柄进行控制，一种是没有预览限制，通过用户ID号进行云台控制。在控制云台之前，须先获取云台的控制权，返回该用户当前是否有权限控制云台，这样做的目的是为了防止优先级不同的用户同时控制云台造成的混乱。（具体参见后面的函数说明） l 回放和下载：在调用回放和下载命令后，回放和下载并没有立即执行，要调用开始播放(ZNET_PLAYSTART)来启动当前操作，用ZNET_PlayBackControl()函数实现。在调用开始播放之前，可以设置保存数据ZNET_PlayBackSaveData()和回调函数ZNET_SetPlayDataCallBack()。 2.2 函数调用顺序 A. 初始化软件包 ZNET_Init() B. 用户在设备上注册 ZNET_Login() C. 事件订阅 ZNET_EventSubscribe() D. 启动图像预览 ZNET_RealPlay() ZNET_RealPlayEx() ZNET_GetRealSrcUrl() ZNET_GetStreamStatus() ZNET_GetStreamStatusEx() 设置/获取视频参数 ZNET_ClientSetVideoEffect() ZNET_ClientGetVideoEffect() ZNET_SetVideoEffect() ZNET_GetVideoEffect() ZNET_ClientGetVideoRes() ZNET_ClientGetVideoEncoderEx() ZNET_GetStreamCodeAndRate() 叠加字符和图像 ZNET_AddOsdText() ZNET_ModifyOsdText() ZNET_DelOsdText() ZNET_ClearOsdText() 获取流状态 ZNET_GetStreamStatus() 动态产生关键帧 ZNET_MakeKeyFrame() ZNET_MakeKeyFrameEx() 声音控制 ZNET_OpenSound() ZNET_CloseSound() ZNET_OpenSoundShare() ZNET_CloseSoundShare() ZNET_SetAudioMode() ZNET_SetVolume() ZNET_GetVolume() 数据捕获 ZNET_SetRealDataCallBack() ZNET_SetRealDataCallBackEx() ZNET_SaveRealData() ZNET_StopSaveRealData() ZNET_SetRawDataCallBack() 抓图 ZNET_CapturePicture() ZNET_CapturePictureEx() ZNET_CapturePictureWithoutViewEx() ZNET_CapturePictureWithoutView() 数字放大 ZNET_DigitalZoom() ZNET_GetZoomRect() 云台控制 ZNET_PTZControl() ZNET_TransPTZ() ZNET_PTZPreset() ZNET_PTZControl_Other() ZNET_PTZPreset_Other() ZNET_PTZControlWithSpeed() ZNET_PTZControlWithSpeed_Other() ZNET_PTZControlCruise() ZNET_PTZControlScan() ZNET_PTZControlAreaZoomIn() 停止预览 ZNET_StopRealPlay() E. 查找文件 ZNET_FindFile() ZNET_FindFileEx() ZNET_FindNextFile() ZNET_FindFileExByNum() ZNET_FindClose() ZNET_FindDevFile() ZNET_FindDevFileEx() ZNET_FindDevFileByUrl() ZNET_QueryTags() ZNET_QueryNextTags() ZNET_QueryTagsClose() 回放　　 ZNET_PlayBackByName() ZNET_PlayBackByRtsp() ZNET_PlayBackByTime() ZNET_PlayBackByTimeJump() ZNET_PlayBackControl() ZNET_StopPlayBack() ZNET_FindGetVodUrl() ZNET_PlayBackByTimeEx() ZNET_PlayBackDevByTime() ZNET_PlayBackDevByTimeEx() ZNET_PlayBackDevByTimeByUrl() ZNET_RefreshPlay() ZNET_StopPlayBackSave() ZNET_ReplayLimitSet() ZNET_ReplayLimitGet() ZNET_ReqStartReplay() ZNET_StartServerReplay() ZNET_RewindByTimeEx() ZNET_RewindByTimeAndStreamNum() 捕获 ZNET_PlayBackSaveData() ZNET_StopPlayBackSave() ZNET_SetPlayDataCallBack() 抓图 ZNET_PlayBackCaptureFile() 下载 ZNET_GetFileByName() ZNET_GetFileByTime() ZNET_GetOriginalFileByName() ZNET_GetOriginalFileByTime() ZNET_GetDownloadPos() ZNET_StopGetFile() F. 报警 ZNET_SetupAlarmChan() ZNET_CloseAlarmChan() ZNET_SetAlarmOut() ZNET_GetAlarmOut() ZNET_AlarmSubscribe() ZNET_AlarmUnsubscribe() G. 录像 ZNET_StartDVRRecord() ZNET_StartDVRRecordEx() ZNET_StopDVRRecord() ZNET_StopDVRRecordEx() ZNET_GetRecordStatus() ZNET_GetRecordStatusEx() ZNET_GetRecordMode() ZNET_StartServerRecord() ZNET_AddAutoRecord() ZNET_DelAutoRecord() ZNET_GetAutoRecord() ZNET_GetChanRecordNum() ZNET_SetChanRecordNum() ZNET_SearchRecordStatus() ZNET_StartFrontEndRecord() ZNET_StopFrontEndRecord() ZNET_AddRcdTag() ZNET_ListRcdTags() ZNET_QueryRcdTag()s ZNET_GetSIFSInfo() ZNET_SetSIFSInfo() ZNET_SIFSSwitch() ZNET_Set_Defualt_Record_Path() ZNET_Get_Defualt_Record_Path() ZNET_Set_Chan_Record_Path() ZNET_Get_Chan_Record_Path() ZNET_SafeguardRcdFile() ZNET_ListSafeguardRcdFile() ZNET_GetSIFSMetaDataConfig() ZNET_SetSIFSMetaDataConfig() ZNET_DelSIFSMetaDataConfig() ZNET_GetNRURecordType() ZNET_SetNRURecordType() H. 监视器 ZNET_StartTransfer() ZNET_StopTransferByName() ZNET_StopTransferByHandle() ZNET_GetTransfer() 前端设备能力信息 ZNET_GetSDKSoftWareVersion() ZNET_GetChanName() ZNET_GetChanNO() ZNET_GetChanStatusByPaging() ZNET_GetChanStatusEx() ZNET_GetChanStreamNum() ZNET_GetChanStreamNumEx() ZNET_GetHostInfo() ZNET_SetDevTimeSync() ZNET_GetDevTimeSync() ZNET_SetObjParam() ZNET_GetObjParam() ZNET_GetObjConfig() ZNET_SetObjConfig() 重启/关闭 ZNET_RebootDVR() ZNET_ShutDownDVR() 远程升级 ZNET_Upgrade() ZNET_GetUpgradeState() ZNET_CloseUpgradeHandle() 远程格式化硬盘 ZNET_FormatDisk() ZNET_GetFormatProgress() ZNET_CloseFormatHandle() 语音对讲 ZNET_StartVoiceCom() ZNET_SetVoiceComClientVolume() ZNET_StopVoiceCom() ZNET_GetTalkChanNum() ZNET_GetTalkChanName() 远程控制本地显示 ZNET_ClickKey() 远程手动录像 ZNET_StartDVRRecord() ZNET_StopDVRRecord() 日志 ZNET_FindDevLog() ZNET_FindNextDevLog() ZNET_FindDevLogClose() I. 数据库 ZNET_UpgradeDatabase() ZNET_RestoreDatabase() ZNET_BackupDatabase() ZNET_GetDBConf() ZNET_SetDBConf() J. 注销用户 ZNET_Logout() K. 释放软件包资源 ZNET_Cleanup() 以上为软件解码的函数调用流程，其中C、D、E、F、G、H、I部分内容是没有先后调用顺序的。 第三章 数据结构 3.1 客户端数据结构 3.1.1 发送模式 //网络模式 enum LINK_MODE { LM_TCP, // 0：TCP方式 LM_UDP, // 1：UDP方式 LM_MULTI, // 2：多播方式 LM_RTP, // 3 - RTP方式 LM_AUDIODETACH, // 4-音视频分开(TCP) LM_UDP_MEDIA, // 5: 针对上海地标添加的UDP媒体流传输协议 LM_DDRM, // 6: 直连设备RTSP组播 LM_DDUC, // 7: 直连设备单播 LM_COUNT, // 计数用，最大支持数 }; 3.1.2 设备信息结构 // 对象类型定义 enum OBJ_TYPE { OBJ_TYPE_UNKNOWN = 0, OBJ_TYPE_HOST = 1, //DVR OBJ_TYPE_VIDEO, OBJ_TYPE_TALK, }; typedef struct { BYTE sSerialNumber[SERIALNO_LEN]; /* 序列号 */ BYTE byAlarmInPortNum; /* DVR报警输入个数 */ BYTE byAlarmOutPortNum; /* DVR报警输出个数 */ BYTE byDiskNum; /* DVR 硬盘个数 */ BYTE byDVRType; /* DVR类型*/ LONG byChanNum; /* DVR 通道个数 */ BYTE byStartChan; /* 起始通道号,例如DVS-1,DVR – 1 */ }ZNET_DEVICEINFO, *LPZNET_DEVICEINFO; typedef struct { char szType[32]; //字符串形式的类型前缀，如"vsphost" char szIP[IP_LEN]; int nPort; char szUser[NAME_LEN]; char szPswd[PASSWD_LEN]; char szName[64]; char szTitle[192]; } ZNET_HOST_INFO, *LPZNET_HOST_INFO; const INT PO_FILE_MODE_MBF_BY_FILE = 0x00000001;//置位:支持MBF按文件下载 const INT PO_FILE_MODE_MBF_BY_TIME = 0x00000002;//置位:支持MBF按时间下载 const INT PO_FILE_MODE_ORIGINAL_FILE = 0x00000004;//置位:支持原厂格式按文件下载 const INT PO_FILE_MODE_ORIGINAL_TIME = 0x00000008;//置位:支持原厂格式按时间下载 const INT PO_FILE_MODE_ALL = PO_FILE_MODE_MBF_BY_FILE | PO_FILE_MODE_MBF_BY_TIME | PO_FILE_MODE_ORIGINAL_FILE | PO_FILE_MODE_ORIGINAL_TIME;//支持所有文件类型 //搜索主机参数 typedef struct stSEARCH_DEV_INFO { char devIp[16]; //主机ip unsigned int devPort; //主机端口号 char devModel[64]; //主机型号 }SEARCH_DEV_INFO; 3.1.3 图像预览参数 typedef struct{ LONG lChannel; //通道号 WORD wStreamNO; //码流号，为表示主码流，其它为子码流，码流从开始编号 WORD wLinkType; //连接方式（见enum LINK_MODE）- 0：TCP方式，1：UDP 方式，2：多播方式,3 - RTP方式，-音视频分开(TCP) HWND hPlayWnd; //播放窗口的句柄,为NULL表示不播放图象 char* sMultiCastIP; //多播组地址 }ZNET_CLIENTINFO,*LPZNET_CLIENTINFO; 如果将hPlayWnd参数设置为NULL，则客户端收到数据后不解码，但是可以录像。 3.1.4 文字叠加参数 enum OSD_POS { POS_NOTSHOW, //不显示 POS_LEFTTOP, //上左 POS_TOPCENTER, //上中 POS_RIGHTTOP, //上右 POS_LEFTCENTER, //中左 POS_RIGHTCENTER, //中右 POS_LEFTBOTTOM, //下左 POS_BOTTOMCENTER, //下中 POS_RIGHTBOTTOM, //下右 }; 3.1.5 文件信息结构 typedef struct{ DWORD dwYear; /* 年 */ DWORD dwMonth; /* 月 */ DWORD dwDay; /* 日 */ DWORD dwHour; /* 时 */ DWORD dwMinute; /* 分 */ DWORD dwSecond; /* 秒 */ } ZNET_TIME,*LPZNET_TIME; // 存储类型定义 enum STG_TYPE { STG_TYPE_UNKNOWN = -1, STG_TYPE_IAVS = 0, // 存储在IAVS服务器 STG_TYPE_DEVICE = 1, // 存储在前端设备 }; typedef struct { char sFileName[MAX_PATH_LEN]; /* 文件名 MAX_PATH_LEN = 2048 */ STG_TYPE stgType; /*存储在服务器上还是前端设 备上(见上方定义)*/ ZNET_TIME struStartTime; /* 文件的开始时间 */ ZNET_TIME struStoptime; /* 文件的结束时间 */ INT64 dwFileSize; /* 文件的大小 */ }ZNET_FIND_DATA,*LPZNET_FIND_DATA; 3.1.6 上传报警信息 enum EVT_TYPE { EVT_TYPE_UNKNOWN = -1, //未知事件 EVT_TYPE_IO, //开关量 EVT_TYPE_NET, //网络断线/恢复 EVT_TYPE_VLOST, //视频丢失/恢复 EVT_TYPE_MOTION, //移动侦测 EVT_TYPE_MASK, //视频遮挡 EVT_TYPE_CAMERA_LOCK, //摄像机锁定 EVT_TYPE_MONITOR_LOCK, //监视器锁定 EVT_TYPE_DIGITAL, //数字码流传输 EVT_TYPE_RECORD, //手动录像 EVT_TYPE_SYSTEM_INIT, //系统初始化 EVT_TYPE_USER_LOGIN, //用户登入 EVT_TYPE_USER_LOGOUT, //用户注销 EVT_TYPE_MONITOR_SWITCH, //监视器切换 EVT_TYPE_PTZ, //云台控制 EVT_TYPE_OPEN_VIDEO_FILE, //打开视频文件 EVT_TYPE_CLOSE_VIDEO_FILE, //关闭视频文件 EVT_TYPE_ALARM_INFO, //报警设备报告信息 EVT_TYPE_VA_ALARM, //智能报警事件 EVT_TYPE_OSD_CHANGE, //OSD改变 EVT_TYPE_CPU_TOO_BUSY, // CPU使用率过高报警 EVT_TYPE_MEMORY_TOO_HIGH, // 内存使用率过高报警 EVT_TYPE_DISK_ARRAY_WRITE_FAILED, // 磁盘阵列不能写 EVT_TYPE_DISK_ARRAY_ERROR, // 磁盘阵列不能读写 EVENT_INSERT_CARD, //插卡事件 EVENT_PLATE, // 监测到车牌号码 EVT_TYPE_SERVER_STATUS, //服务器上线/下线 EVT_TYPE_SERVER_STATUS_C, //服务器下线 EVT_TYPE_MDU_STATUS, //MDU上线/下线 EVT_TYPE_MDU_STATUS_C, //MDU下线 EVT_TYPE_PAU_STATUS, //PAU上线/下线 EVT_TYPE_PAU_STATUS_C, //PAU下线 EVT_TYPE_NRU_STATUS, //NRU上线/下线 EVT_TYPE_NRU_STATUS_C, //NRU下线 EVT_TYPE_GB_PHONE, //电话报警 EVT_TYPE_GB_PHONE_C, //电话报警停止 EVT_TYPE_GB_DEV, //设备报警 EVT_TYPE_GB_DEV_C, //设备报警停止 EVT_TYPE_GB_SMS, //短信报警 EVT_TYPE_GB_SMS_C, //短信报警停止 EVT_TYPE_GB_GPS, //GPS报警 EVT_TYPE_GB_GPS_C, //GPS报警停止 EVT_TYPE_GB_VOIDE, //视频报警 EVT_TYPE_GB_VOIDE_C, //视频报警停止 EVT_TYPE_GB_DEVERROR, //设备故障报警 EVT_TYPE_GB_DEVERROR_C, //设备故障报警停止 EVT_TYPE_SUBSERVER_STATUS, EVT_TYPE_SUBSERVER_STATUS_C, EVT_TYPE_GB_OTHER, //其它报警 EVT_TYPE_GB_OTHER_C, //其它报警停止 /* 国家电网告警事件*/ EVT_TYPE_GDW_VLOST_R, // 视频丢失告警 EVT_TYPE_GDW_VLOST_C, // 视频丢失告警消失 EVT_TYPE_GDW_MOTION_R, // 移动侦测告警 EVT_TYPE_GDW_MOTION_C, // 移动侦测告警消失 EVT_TYPE_GDW_MASK_R, // 视频遮挡告警 EVT_TYPE_GDW_MASK_C, // 视频遮挡告警消失 EVT_TYPE_GDW_HOT_R, // 设备高温告警 EVT_TYPE_GDW_HOT_C, // 设备高温告警消失 EVT_TYPE_GDW_COLD_R, // 设备低温告警 EVT_TYPE_GDW_COLD_C, // 设备低温告警消失 EVT_TYPE_GDW_FAN_R, // 风扇故障告警 EVT_TYPE_GDW_FAN_C, // 风扇故障告警消失 EVT_TYPE_GDW_DISK_R, // 磁盘故障告警 EVT_TYPE_GDW_DISK_C, // 磁盘故障告警消失 EVT_TYPE_GDW_STATUS_R, // 状态事件告警 EVT_TYPE_GDW_STATUS_C, // 状态事件告警消失 //三星智能分析相关报警 EVT_TYPE_AUDIO_DETECT, //音频检测 EVT_TYPE_FACE_DETECT, //人脸检测 EVT_TYPE_SMART_ANALYSIS_OBJ_PASS, //视频分析(物体通过) EVT_TYPE_SMART_ANALYSIS_OBJ_IN, //视频分析(物体进入/退出) EVT_TYPE_SMART_ANALYSIS_OBJ_DISAPPEAR,//视频分析(物体出现/消失) EVT_TYPE_SMART_ANALYSIS_SCENE_CHANGE, //视频分析(场景改变) EVT_TYPE_SDWDEV_DATACAP_R, //数据越上限告警产生 EVT_TYPE_SDWDEV_DATACAP_C, //数据越上限告警停止 EVT_TYPE_SDWDEV_DATALIMIT_R, //数据越下限告警产生 EVT_TYPE_SDWDEV_DATALIMIT_C, //数据越下限告警停止 EVT_TYPE_SDWDEV_DATAMORECAP_R, //数据越上上限告警产生 EVT_TYPE_SDWDEV_DATAMORECAP_C, //数据越上上限告警停止 EVT_TYPE_SDWDEV_DATALOWERLIMIT_R, //数据越下下限告警产生 EVT_T