网络SDK开发手册

网络SDK编程手册网络SDK开发手册2009-01-10版权所有侵权必究第1页共85页网络SDK编程手册前言非常感谢您使用我们公司的设备，我们将为您提供最好的服务。本手册可能包含技术上不准确的地方或印刷错误，欢迎指正。我们将会定期更新手册的 内容 财务内部控制制度的内容财务内部控制制度的内容人员招聘与配置的内容项目成本控制的内容消防安全演练内容 。第2页共85页网络SDK编程手册修订记录日期修订内容增加局域网内搜索设备接口H264_DVR_SearchDevice2009.02.18增加语音对讲相关接口H264_DVR_StartVoiceCom_MR，H264_DVR_VoiceComSendData，H264_DVR_StopVoiceCom，H264_DVR_SetTalkMode增加以下接口：H264_DVR_StartDVRRecord，H264_DVR_StopDVRRecord，H264_DVR_SetSystemDateTime，H264_DVR_GetDVRWorkState，H264_DVR_ClickKey2010．08．7增加以下接口：H264_DVR_StorageManage，H264_DVR_SendNetAlarmMsg，H264_DVR_StartAlarmCenterListen，H264_DVR_StopAlarmCenterListen，H264_DVR_APIboolH264_DVR_DelRealDataCallBack，H264_DVR_APIlongH264_DVR_PlayBackByTime，H264_DVR_APIlongH264_DVR_GetFileByTime，H264_DVR_APIboolH264_DVR_PTZControlEx，H264_DVR_APIlongH264_DVR_GetDevConfig，H264_DVR_APIlongH264_DVR_SetDevCon，H264_DVR_APIlongH264_DVR_SetConfigOverNet2011．06．27增加以下接口：H264_DVR_SetConnectTime,H264_DVR_APIlongCALL_METHODH264_DVR_SetConfigOverNet,H264_DVR_APIlongCALL_METHODH264_DVR_PauseRealPlay,H264_DVR_SetRealDataCallBack_V2,H264_DVR_FindFileByTime,H264_DVR_PlayBackByName_V2,H264_DVR_PlayBackByTime,H264_DVR_PlayBackByTimeEx,CALL_METHODH264_DVR_GetFileByTime,H264_DVR_CatchPic,H264_DVR_CatchPicInBuffer,H264_DVR_SerialWrite,H264_DVR_SerialRead,H264_DVR_GetDDNSInfo,H264_DVR_MakeKeyFrame第3页共85页网络SDK编程手册目录1.简介...........................................................................................................................61.1概述........................................................................................................................61.2适用性....................................................................................................................6设计原则.............................................................................................................................71.3编程说明................................................................................................................71.4典型调用顺序........................................................................................................82数据结构定义..............................................................................................................112.1客户端数据结构..................................................................................................112.1.1常量定义.....................................................................................................142.1.2设备信息结构.............................................................................................222.1.3时间信息.....................................................................................................222.1.4录像文件信息.............................................................................................242.1.5配置信息结构.............................................................................................292.1.6网络键盘键值定义.....................................................................................502.1.7网络报警信息.............................................................................................522.1.8存储设备控制信息.....................................................................................532.1.9RTSP信息...................................................................................................532.1.10互信互通..................................................................................................532.1.11新望平台..................................................................................................542.1.12视搜平台..................................................................................................542.1.13VVEYE平台............................................................................................552.1.14媒体包以及包信息..................................................................................553接口定义......................................................................................................................573.1SDK初始化..........................................................................................................573.2报警状态获取......................................................................................................583.3设备注册..............................................................................................................603.4实时监视..............................................................................................................613.5回放和下载..........................................................................................................643.6回放控制..............................................................................................................693.7云台控制..............................................................................................................703.8系统配置..............................................................................................................713.9日志管理..............................................................................................................733.10远程控制............................................................................................................733.11语音对讲............................................................................................................753.12录像模式设置....................................................................................................773.13设置系统时间....................................................................................................783.14获取设置运行状态信息...................................................................................783.15网络键盘............................................................................................................793.16网络报警............................................................................................................793.17报警中心............................................................................................................803.18磁盘管理............................................................................................................803.19抓图....................................................................................................................813.20透明232,485......................................................................................................823.21获取DDNS信息...............................................................................................833.22支持强迫I帧....................................................................................................833.23设置连接设备超时时间和尝试次数...............................................................84第4页共85页网络SDK编程手册4示例功能实现85第5页共85页网络SDK编程手册简介1.1概述欢迎使用我公司网络SDK编程手册，网络SDK是软件开发商在开发我司网络硬盘录像机监控联网应用时的开发套件。本文档详细描述了开发包中各个函数实现的功能、接口及其函数之间的调用关系和示例实现。开发包所包括的文件有：NetSDK网络库NetSDK.libNetSDK.dllDllDeinterlace.dll辅助库H264Play.dllhi_h264dec_w.dll头文件Lib文件接口库解码辅助库解码辅助库解码辅助库1.2适用性支持网络硬盘录像机的监视、回放、报警、远程配置、日志查询等功能。支持TCP传输模式，设备端同时支持10个TCP连接。可通过SDK回调接口开发流媒体转发、回放、报警等服务器程序。客户端可以采用多种分辨率进行图像预览，支持的分辨率包括：QCIF、CIF、2CIF、、HalfD1、D1，VGA（640×480）等SDK在录像回放/下载时,同一登陆ID对于同一通道在同一时间回放和下载不可同时进行操作。SDK性能与设备的运行情况和运行客户端的计算机CPU能力密切相关,理论上能同时支持2000个用户注册;同时支持2000路网络预览和网络回放;同时支持2000路报警上传;在图象显示方面同时支持300路。第6页共85页网络SDK编程手册设计原则1.3编程说明初始化和清除1、使用网络客户端软件包首先调用H264_DVR_Init()对系统进行初始化，应用程序退出时调用H264_DVR_Cleanup()释放所有占用的资源。2、大多数函数调用均应该在H264_DVR_Init()之后，H264_DVR_Cleanup()之前，而H264_DVR_GetLastError可以在任何时候调用等等。用户登录和注销用户在访问前端设备之前必须通过调用H264_DVR_Login()登录到前端设备上，如果登陆的软件是特殊的(不是web)可以调用H264_DVR_LoginEx()指定登陆的软件类型,登录成功后返回一个全局唯一的句柄。此句柄就像一个会话通道，之后该用户可通过此句柄访问前端设备。退出该会话时则通过H264_DVR_Logout()函数在前端设备上注销此句柄以终止该会话通道的使用。建立连接与登录是同步的。心跳功能在本开发包中提供自动心跳功能（20秒一次心跳）当设备断开能及时回调给客户端。同步与异步异步通过设置回调函数的方式实现，网络数据通过回调函数传达到应用程序,有些异步在设置后返回请求句柄，结束请求时将请求句柄提供给SDK以注销相关资源。回调函数一般都有dwUser 参数 转速和进给参数表a氧化沟运行参数高温蒸汽处理医疗废物pid参数自整定算法口腔医院集中消毒供应 ,由用户自定义需要的数据,一般用来传入类对象指针,方便回调处理在类中实现,回调应用都可以采取这种方式。第7页共85页网络SDK编程手册1.4典型调用顺序初始化SDK初始化SDK功能信息获取设置报警消息回调H264_DVR_Init()H264_DVR_SetDVRMessCallBack()C.登录连接设备登入设备H264_DVRLogin()H264_DVR_LoginEx()报警消息订阅H264_DVR_SetupAlarmChan()设备功能操作与信息获取系统参数配置H264_DVR_GetDevConfig()H264_DVR_SetDevConfig()查询日志H264_DVR_FindDVRLog()云台控制H264_DVR_PTZControl()H264_DVR_PTZControlEx()E.实时监视通道打开监视通道H264_DVR_RealPlay()H264_DVR_StopRealPlay()监视数据回调保存H264_DVR_SetRealDataCallBack()F.回放/下载通道查询录像H264_DVR_FindFile()H264_DVR_FindFileByTime()回放及控制H264_DVR_PlayBackByNameH264_DVR_PlayBackByName_V2()H264_DVR_PlayBackByTime()H264_DVR_PlayBackByTimeEx()H264_DVR_PlayBackControl()H264_DVR_StopPlayBack()第8页共85页网络SDK编程手册下载H264_DVR_GetFileByName()H264_DVR_GetFileByTime()H264_DVR_GetDownloadPos()H264_DVR_StopGetFile()第9页共85页网络SDK编程手册G.远程控制远程升级H264_DVR_Upgrade()H264_DVR_GetUpgradeState()H264_DVR_CloseUpgradeHandle()重启/清除日志H264_DVR_ControlDVR（）注销断开设备停止报警消息订阅断开连接H264_DVR_CloseAlarmChan()H264_DVR_Logout()释放SDK资源SDK退出H264_DVR_Cleanup()第10页共85页网络SDK编程手册数据结构定义2.1客户端数据结构云台操作类型typedefenumPTZ_ControlType{TILT_UP=0,//上TILT_DOWN,//下PAN_LEFT,//左PAN_RIGHT,//右PAN_LEFTTOP,//左上PAN_LEFTDOWN,//左下PAN_RIGTHTOP,//右上PAN_RIGTHDOWN,//右下ZOOM_IN,//变倍大ZOOM_OUT,//变倍小FOCUS_FAR,//焦点后调FOCUS_NEAR,//焦点前调IRIS_OPEN,//光圈扩大IRIS_CLOSE,//光圈缩小EXTPTZ_OPERATION_ALARM,///<报警功能EXTPTZ_LAMP_ON,///<灯光开EXTPTZ_LAMP_OFF,//灯光关EXTPTZ_POINT_SET_CONTROL,//设置预置点EXTPTZ_POINT_DEL_CONTROL,//清除预置点EXTPTZ_POINT_MOVE_CONTROL,//转预置点EXTPTZ_STARTPANCRUISE,//开始水平旋转EXTPTZ_STOPPANCRUISE,//停止水平旋转EXTPTZ_SETLEFTBORDER,//设置左边界EXTPTZ_SETRIGHTBORDER,//设置右边界EXTPTZ_STARTLINESCAN,//自动扫描开始EXTPTZ_CLOSELINESCAN,//自动扫描开停止EXTPTZ_ADDTOLOOP,//加入预置点到巡航p1巡航线路p2预置点值EXTPTZ_DELFROMLOOP,//删除巡航中预置点p1巡航线路p2预置点值EXTPTZ_POINT_LOOP_CONTROL,//开始巡航EXTPTZ_POINT_STOP_LOOP_CONTROL,//停止巡航EXTPTZ_CLOSELOOP,//清除巡航p1巡航线路EXTPTZ_FASTGOTO,//快速定位EXTPTZ_AUXIOPEN,//辅助开关，关闭在子命令中第11页共85页网络SDK编程手册EXTPTZ_OPERATION_MENU,//球机菜单操作，其中包括开，关，确定等等EXTPTZ_REVERSECOMM,//镜头翻转EXTPTZ_OPERATION_RESET,///<云台复位EXTPTZ_TOTAL,};错误类型代号，用于GetLastError函数的返回typedefenumSDK_RET_CODE{H264_DVR_NOERROR=0,//没有错误H264_DVR_SUCCESS=1,//返回成功H264_DVR_SDK_NOTVALID=-10000,//非法请求H264_DVR_NO_INIT=-10001,//SDK未经初始化H264_DVR_ILLEGAL_PARAM=-10002,//用户参数不合法H264_DVR_INVALID_HANDLE=-10003,//句柄无效H264_DVR_SDK_UNINIT_ERROR=-10004,//SDK清理出错H264_DVR_SDK_TIMEOUT=-10005,//等待超时H264_DVR_SDK_MEMORY_ERROR=-10006,//内存错误，创建内存失败H264_DVR_SDK_NET_ERROR=-10007,//网络错误H264_DVR_SDK_OPEN_FILE_ERROR=-10008,//打开文件失败H264_DVR_SDK_UNKNOWNERROR=-10009,//未知错误H264_DVR_DEV_VER_NOMATCH=-11000,//收到数据不正确，可能版本不匹配H264_DVR_SDK_NOTSUPPORT=-11001,//版本不支持H264_DVR_OPEN_CHANNEL_ERROR=-11200,//打开通道失败H264_DVR_CLOSE_CHANNEL_ERROR=-11201,//关闭通道失败H264_DVR_SUB_CONNECT_ERROR=-11202,//建立媒体子连接失败H264_DVR_SUB_CONNECT_SEND_ERROR=-11203,//媒体子连接通讯失败///用户管理部分错误码H264_DVR_NOPOWER=-11300,//无权限H264_DVR_PASSWORD_NOT_VALID=-11301,//账号密码不对H264_DVR_LOGIN_USER_NOEXIST=-11302,//用户不存在H264_DVR_USER_LOCKED=-11303,//该用户被锁定H264_DVR_USER_IN_BLACKLIST=-11304,//该用户不允许访问(在黑名单中)H264_DVR_USER_HAS_USED=-11305,//该用户以登陆H264_DVR_USER_NOT_LOGIN=-11306,//该用户没有登陆H264_DVR_CONNECT_DEVICE_ERROR=-11307,//可能设备不存在H264_DVR_ACCOUNT_INPUT_NOT_VALID=-11308,//用户管理输入不合法H264_DVR_ACCOUNT_OVERLAP=-11309,//索引重复H264_DVR_ACCOUNT_OBJECT_NONE=-11310,//不存在对象,用于查询时第12页共85页网络SDK编程手册H264_DVR_ACCOUNT_OBJECT_NOT_VALID=-11311,//不存在对象H264_DVR_ACCOUNT_OBJECT_IN_USE=-11312,//对象正在使用H264_DVR_ACCOUNT_SUBSET_OVERLAP=-11313,//子集超范围(如组的权限超过权限 表 关于同志近三年现实表现材料材料类招标技术评分表图表与交易pdf视力表打印pdf用图表说话 pdf ，用户权限超出组的权限范围等等)H264_DVR_ACCOUNT_PWD_NOT_VALID=-11314,//密码不正确H264_DVR_ACCOUNT_PWD_NOT_MATCH=-11315,//密码不匹配H264_DVR_ACCOUNT_RESERVED=-11316,//保留帐号///配置管理相关错误码H264_DVR_OPT_RESTART=-11400,//保存配置后需要重启应用程序H264_DVR_OPT_REBOOT=-11401,//需要重启系统H264_DVR_OPT_FILE_ERROR=-11402,//写文件出错H264_DVR_OPT_CAPS_ERROR=-11403,//配置特性不支持H264_DVR_OPT_VALIDATE_ERROR=-11404,//配置校验失败H264_DVR_OPT_CONFIG_NOT_EXIST=-11405,//请求或者设置的配置不存在H264_DVR_CTRL_PAUSE_ERROR=-11500,//暂停失败H264_DVR_SDK_NOTFOUND=-11501,//查找失败，没有找到对应文件H264_DVR_CFG_NOT_ENABLE=-11502,//配置未启用};报警事件类型enumSDK_EventCodeTypes{SDK_EVENT_CODE_INIT=0,SDK_EVENT_CODE_LOCAL_ALARM=1,SDK_EVENT_CODE_NET_ALARM,SDK_EVENT_CODE_MANUAL_ALARM,SDK_EVENT_CODE_VIDEO_MOTION,SDK_EVENT_CODE_VIDEO_LOSS,SDK_EVENT_CODE_VIDEO_BLIND,SDK_EVENT_CODE_VIDEO_TITLE,SDK_EVENT_CODE_VIDEO_SPLIT,SDK_EVENT_CODE_VIDEO_TOUR,SDK_EVENT_CODE_STORAGE_NOT_EXIST,SDK_EVENT_CODE_STORAGE_FAILURE,SDK_EVENT_CODE_LOW_SPACE,SDK_EVENT_CODE_NET_ABORT,SDK_EVENT_CODE_COMM,本地报警网络报警手动报警动态检测视频丢失视频遮挡第13页共85页网络SDK编程手册SDK_EVENT_CODE_STORAGE_READ_ERROR,SDK_EVENT_CODE_STORAGE_WRITE_ERROR,SDK_EVENT_CODE_NET_IPCONFLICT,SDK_EVENT_CODE_ALARM_EMERGENCY,SDK_EVENT_CODE_DEC_CONNECT,SDK_EVENT_CODE_ILLEGALLY_ENTERED,//入侵报警SDK_EVENT_CODE_REMAINORMOVE,//滞留或盗移报警SDK_EVENT_CODE_ILLEGALLY_BEHAVIOR,//异常行为报警SDK_EVENT_CODE_FACE_RECOGNITION,//人脸识别SDK_EVENT_CODE_LICENSE_RECOGNITION,//车牌识别SDK_EVENT_CODE_NR,};报警信息typedefstructSDK_ALARM_INFO{intnChannel;intiEvent;intiStatus;SDK_SYSTEM_TIMESysTime;}SDK_AlarmInfo;常量定义#definePAN_AUTO29/*云台以SS的速度左右自动扫描*/#defineEXTPTZ_FASTGOTO30//三维定位#defineNET_MAX_CHANNUM32//最大通道个数#defineNET_DECORDR_CH16//最大解码通道个数#defineNET_MAX_USER_NUM128//最多用户数#defineNET_MAX_RIGTH_NUM128//最多权限数#defineNET_MAX_GROUP_NUM50//最多组数#defineNET_MAX_USER_LENGTH32//用户名密码最大长度#defineNET_MAX_COMBINE_NUM2//最大组合编码通道数#defineNET_MAX_DECORDR_CH16//最大解码通道个数#defineNET_MAX_DDNS_TYPE5//支持的DDNS种类#defineNET_MAX_ARSP_TYPE5#defineNET_MAX_ALARMSERVER_TYPE5//支持报警中心种类#defineNET_MAX_SYSFUNC20//最多系统功能个数#defineNET_MAX_PTZ_PROTOCOL_LENGTH32//云台协议名称最大长度#defineNET_N_WEEKS7//星期数第14页共85页网络SDK编程手册#defineNET_N_TSECT6//时间段数#defineNET_MD_REGION_ROW32//动态检测区域行数#defineNET_COVERNUM8//覆盖区域数#defineNET_MAX_FILTERIP_NUM64//IP地址最大过滤数#defineNET_NAME_PASSWORD_LEN64//用户名密码最大长度#defineNET_MAX_PATH_LENGTH260//路径长度#defineNET_N_MIN_TSECT2#defineNET_MAX_RETURNED_LOGLIST128//最多日志条数#defineNET_MAX_MAC_LEN32//MAC地址字符最大长度#defineNET_IW_ENCODING_TOKEN_MAX128#defineNET_MAX_AP_NUMBER10#defineNET_MAX_INFO_LEN128#defineNET_MAX_USERNAME_LENGTH128#defineNET_MAX_SERIALNO_LENGTH128//最大解码通道个数#defineNET_CAPTURE_SIZE_NUM9//DDNS参数#defineDDNS_MAX_DDNS_NAMELEN64//主机名长度#defineDDNS_MAX_DDNS_PWDLEN32//密码长度#defineDDNS_MAX_DDNS_IPSIZE64//IP地址长度//DDNS服务器设备的信息typedefstruct_DDNS_INFO{std::stringID;//设备标识charIP[DDNS_MAX_DDNS_IPSIZE];//内网IPintWebPort;//Web端口,默认为80intMediaPort;//媒体端口,默认为34567intMobilePort;//手机监控端口，默认为34599intUPNPWebPort;//UPNP启动下Web端口,UPNP不开启为0intUPNPMediaPort;//UPNP启动下媒体端口,UPNP不开启为0intUPNPMobilePort;//UPNP启动下手机监控端口,UPNP不开启为0charUsername[DDNS_MAX_DDNS_NAMELEN];//用户名charPassword[DDNS_MAX_DDNS_PWDLEN];//密码}DDNS_INFO,*pDDNS_INFO;实时预览扩展接口增加的参数：预览类型typedefenum_H264_DVR_RealPlayType{NET_RType_Realplay=0,//实时预览第15页共85页网络SDK编程手册NET_RType_Main_Realplay2,//实时监视-主码流，等同于NET_RType_RealplayNET_RType_Main_Realplay3,NET_RType_Sub_Realplay_1,//实时监视-从码流NET_RType_Sub_Realplay_2,//实时监视-从码流NET_RType_Sub_Realplay_3,//实时监视-从码流NET_RType_Multiplay_1,//多画面预览－画面NET_RType_Multiplay_4,//多画面预览－画面NET_RType_Multiplay_6,//多画面预览－画面NET_RType_Multiplay_8,//多画面预览－画面NET_RType_Multiplay_9,//多画面预览－画面NET_RType_Multiplay_12,//多画面预览－画面NET_RType_Multiplay_16,//多画面预览－画面}NET_RealPlayType;组合编码模式enumNetCombinType{NET_COMBIN_NONE,NET_COMBIN_1,NET_COMBIN_2,NET_COMBIN_3,NET_COMBIN_4,NET_COMBIN_5,NET_COMBIN_6,NET_COMBIN_7,NET_COMBIN_8,NET_COMBIN_9,NET_COMBIN_10,NET_COMBIN_11,NET_COMBIN_12,NET_COMBIN_13,NET_COMBIN_14,NET_COMBIN_15,NET_COMBIN_16,NET_COMBIN_1_4,NET_COMBIN_5_8,NET_COMBIN_9_12,NET_COMBIN_13_16,NET_COMBIN_1_8,NET_COMBIN_9_16,NET_COMBIN_1_9,NET_COMBIN_8_16,第16页共85页网络SDK编程手册NET_COMBIN_1_16};//这些结构体和枚举是提供给外部使用，所有可能会和设备那边定义了次,所以都在前面加了SDK_enumSDK_CAPTURE_SIZE_t{SDK_CAPTURE_SIZE_D1,///<720*576(PAL)720*480(NTSC)SDK_CAPTURE_SIZE_HD1,///<352*576(PAL)352*480(NTSC)SDK_CAPTURE_SIZE_BCIF,///<720*288(PAL)720*240(NTSC)SDK_CAPTURE_SIZE_CIF,///<352*288(PAL)352*240(NTSC)SDK_CAPTURE_SIZE_QCIF,///<176*144(PAL)176*120(NTSC)SDK_CAPTURE_SIZE_VGA,///<640*480(PAL)640*480(NTSC)SDK_CAPTURE_SIZE_QVGA,///<320*240(PAL)320*240(NTSC)SDK_CAPTURE_SIZE_SVCD,///<480*480(PAL)480*480(NTSC)SDK_CAPTURE_SIZE_QQVGA,///<160*128(PAL)160*128(NTSC)SDK_CAPTURE_SIZE_NR///<枚举的图形大小种类的数目。};///捕获码流控制模式类型enumSDK_capture_brc_t{SDK_CAPTURE_BRC_CBR,///<固定码流。SDK_CAPTURE_BRC_VBR,///<可变码流。SDK_CAPTURE_BRC_MBR,///<混合码流。SDK_CAPTURE_BRC_NR///<枚举的码流控制模式数目。};///捕获压缩格式类型enumSDK_CAPTURE_COMP_t{SDK_CAPTURE_COMP_DIVX_MPEG4,///