[信息与通信]大华网络SDK开发手册.doc

《[信息与通信]大华网络SDK开发手册.doc》由会员分享，可在线阅读，更多相关《[信息与通信]大华网络SDK开发手册.doc（93页珍藏版）》请在三一办公上搜索。

1、 网络客户端SDK编程手册大华网络SDK编程手册VERSION 3.1.8(Build 070321)2007-3-21版权所有 侵权必究前 言非常感谢您使用我们公司的设备，我们将为您提供最好的服务。本手册可能包含技术上不准确的地方或印刷错误，欢迎指正。我们将会定期更新手册的内容。 修订记录日期修订内容作者2006-05-30创建林峰2006-7-3修订接口描述冯江2006-7-5修订概要描述华立高2006-7-26修订接口描述刘杰 陈美英2006-8-10同步更新接口描述陈美英2006-8-21修订接口描述陈美英2006-8-23增加典型调用顺序描述陈美英2006-8-283.0.0整理修订

2、陈美英2006-9-153.0.5同步增加回调数据扩展接口,更新云台控制说明陈美英2006-9-213.0.7同步增加登录扩展接口陈美英2006-9-293.0.9同步增加带有配置结构的配置功能接口说明陈美英2006-10-16增加单独修改通道名称的接口赵均树2006-10-21增加打开实时图像的扩展接口赵均树2006-10-281、增加按时间回放和下载接口2、增加设备配置的第三方接入和获取设备的序列号功能赵均树2006-11-81、带数据回调的按时间回放扩展接口2、带数据回调的按文件回放扩展接口3、远程重启接口4、录像回放能够播放音频赵均树、陈琼施2006-11-191、 解决了反复修改第三

3、方的IP地址时DVR比较容易死机的问题2、 增加485接口3、 通过网络修改IP配置时DVR重启赵均树、陈琼施2006-11-271、 增加DDNS查询IP的功能赵均树、陈琼施2006-12-15修正文档中接口描述的错误,并增加链接赵均树、陈琼施、林坚彦2006-12-25增加并修改语音对讲的接口叶浩、陈琼施2006-12-29增加用户管理接口林坚彦、陈琼施2007-1-17修改了CLIENT_Login的功能描述增加了CLIENT_FindFile、CLIENT_FindNextFile、CLIENT_FindClose林坚彦、赵均树、陈琼施2007-2-8增加了设备参数配置的两个接口：CL

4、IENT_GetDevConfig CLIENT_SetDevConfig林坚彦、陈琼施、赵均树2007-3-7修改了CLIENT_StopListen接口典型应用的笔误赵均树2007-03-19增加了个查询报警状态的接口。林坚彦、陈琼施2007-03-21增加了语音对讲中的音频编码接口增加了扩展报警侦听接口叶浩、陈琼施、林坚彦目 录1 简 介71.1 概述71.2 适用性71.3 特色功能82 设计原则92.1 编程说明92.2 典型调用顺序103 数据结构定义133.1 客户端数据结构133.1.1 设备信息结构163.1.2 时间信息163.1.3 录像文件信息173.1.4 设备状态信

5、息173.1.5 系统配置信息结构214 接口定义214.1 SDK初始化214.2 状态侦听234.3 字符叠加254.4 设备注册264.5 实时监视274.6 音频控制314.7 数据保存324.8 视频抓图354.9 回放和下载364.10 回放控制464.11 云台控制494.12 实时预览514.13 系统配置524.14 日志管理574.15 透明串口584.16 远程控制604.17 录像控制624.18 系统时间634.19 用户管理634.20 语音对讲654.21 码流统计694.22 IO控制704.23 强制I帧714.24 设置限流714.25 获取设备状态724.

6、26 修改通道名称724.27 DDNS查询IP734.28 设备参数配置735 示例功能实现875.1 连接设备885.2 报警信息获取885.3 系统配置885.4 实时监视885.5 数据保存895.6 回放/下载和进度指示895.7 播放控制895.8 预览895.9 字符叠加891 简 介1.1 概述欢迎使用大华网络SDK编程手册，网络客户端软件开发包（DVR客户端SDK）是大华网络硬盘录像机、网络视频服务器的配套产品，本文档详细描述了开发包中各个函数实现的功能、接口及其函数之间的调用关系和示例实现。 网络客户端软件开发包主要包括业务操作和设备管理两大部分： 业务操作：状态侦听、实时

7、监视、实时预览、字符叠加、音频控制、录像回放和下载、数据保存、云台控制、语音对讲、透明串口、码流统计等功能。设备管理：远程升级、远程重启/关闭、设备参数配置（系统通用配置、报警布/撤防设置、录像配置、串口配置、图像配置、日志管理、用户管理、设备校时、动态检测配置、网络配置）等功能。 开发包所包括的文件有：网络库：dhnetsdk.lib、dhnetsdk.dll、dhnetsdk.h解码库：decode.dll、render.dll、dllh264.dll、audiorecord.dll、AudioRecordEx.dll、avcodec.dll辅助库：dhdvr.dll、ParaTimer.

8、dll、DetectAreaCtrl.ocx、SetDeviceConfigProj.ocx1.2 适用性 n 支持所有大华网络硬盘录像机（DVR）、网络视频服务器（NVS）、网络报警 服务器（NAS） n 只支持TCP网络传输模式 n 客户端可以采用多种分辨率进行图像预览，支持的分辨率包括： QCIF、CIF、2CIF、HalfD1、D1，VGA（640480）等n 客户端支持多种图像编码，包括MPEG4和H.264等1.3 特色功能支持设备的以下特色功能：n 多路预览在窄带条件下，同时多路实时监视对带宽的要求比较高，一般的处理情况有两种，其一，轮巡。其二，多路预览。所谓多路预览，就是在一个

9、通道上把所有通道的数据组织在一起传输，等同于多路同时监视。必要的时候，可以转单路监视。大华DVR支持多路预览功能。n 支持标准的MP4数据一般情况下，同一平台集成不同厂商的前端设备（如DVR），由于各厂商采用的视频压缩方法不同(包括算法、参数定义等)，导致解码端回放必须采用厂商特定的工具，造成平台开发商无法自定义播放标准。本SDK能够解决这个问题。通过特定接口，应用层可以通过本SDK获取标准媒体数据（FOURCC(D、I、V、X)视频数据），要支持用各种通用播放器播放，有了提供标准数据，应用层只须打包标准数据到播放器支持的容器类型(也就是文件格式,如AVI标准)就可以了。2 设计原则2.1 编

10、程说明n 初始化和清除1、 使用网络客户端软件包首先调用CLIENT_Init()对系统进行初始化，应用程序退出时调用CLIENT_Cleanup()释放所有占用的资源。 2、 大多数函数调用均应该在CLIENT_Init()之后，CLIENT_Cleanup()之前，除了少数函数，譬如CLIENT_SetConnectTime()在CLIENT_Init()之前调用，而CLIENT_GetSDKVersion()可以在任何时候调用等等。n 操作句柄系统设计上多处使用了句柄概念，很多操作均针对句柄，如回放、下载以及语音对讲等。n 用户登录和注销用户在访问前端设备之前必须通过调用CLIENT_L

11、ogin ()登录到前端设备上，登录成功后返回一个全局唯一的句柄。此句柄就像一个会话通道，之后该用户可通过此句柄访问前端设备。退出该会话时则通过CLIENT_Logout ()函数在前端设备上注销此句柄以终止该会话通道的使用。建立连接与登录是同步的。 n 心跳功能在本开发包中提供自动心跳功能（20秒一次心跳）当设备断开能及时回调给客户端。n 同步与异步异步以设置回调函数来响应网络数据，有些异步在设置后返回请求句柄，结束请求时将请求句柄提供给SDK以注销相关资源。n SDK提供协议探测和转换n 回调函数一般都有dwUser参数, 由用户自定义需要的数据, 一般用来传入类对象指针, 方便回调处理在

12、类中实现,回调应用都可以采取这种方式。2.2 典型调用顺序A. 初始化 SDK初始化 CLIENT_Init()B. SDK功能设置或信息获取设置连接等待时间 CLIENT_SetConnectTime()获取SDK版本 CLIENT_GetSDKVersion()设置消息回调 CLIENT_SetDVRMessCallBack()设置自定义叠加画板 CLIENT_RigisterDrawFun()C. 登录连接设备登录设备 CLIENT_Login()开始侦听 CLIENT_StartListen()D. 设备功能操作与信息获取系统配置 CLIENT_QueryConfig() CLIENT

13、_SetupConfig()获取设备状态 CLIENT_GetDEVWorkState()获取协议信息 CLIENT_QueryComProtocol()查询获取系统信息 CLIENT_QuerySystemInfo()查询通道名称 CLIENT_QueryChannelName()查询日志 CLIENT_QueryLogCallback() CLIENT_QueryLog()用户管理 CLIENT_QueryUserInfo()CLIENT_OperateUserInfo()云台控制 CLIENT_PTZControl() CLIENT_DHPTZControl()语音对讲 CLIENT_S

14、tartTalk() CLIENT_SendTalkData_Custom() CLIENT_StopTalk()设置限流 CLIENT_SetMaxFlux()透明串口 CLIENT_CreateTransComChannel() CLIENT_SendTransComData() CLIENT_DestroyTransComChanne()E. 实时监视通道打开监视通道 CLIENT_RealPlay() CLIENT_RealPlayEx()保存监视图像数据 CLIENT_SaveRealData()监视数据回调保存 CLIENT_SetRealDataCallBack()CLIENT_

15、SetRealDataCallBackEx()获取视频参数信息 CLIENT_ClientGetVideoEffect()设置修改视频参数 CLIENT_ClientSetVideoEffect()强制I帧 CLIENT_MakeKeyFrame()F. 多画面预览通道打开多画面预览 CLIENT_MultiPlay()停止多画面预览 CLIENT_StopMultiPlay()G. 回放/下载通道查询录像 CLIENT_QueryRecordFile()回放及控制 CLIENT_PlayBackByRecordFile() CLIENT_PlayBackByRecordFileEx()CLI

16、ENT_PlayBackByTime()CLIENT_PlayBackByTimeEx()CLIENT_GetPlayBackOsdTime()CLIENT_PausePlayBack()CLIENT_SeekPlayBack()CLIENT_StopPlayBack()CLIENT_StepPlayBack()CLIENT_FastPlayBack()CLIENT_SlowPlayBack()CLIENT_GetFramePlayBack()CLIENT_SetFramePlayBack()下载 CLIENT_DownloadByRecordFile()CLIENT_DownloadByRe

17、cordFileEx()CLIENT_DownloadByTime()CLIENT_StopDownload()CLIENT_GetDownloadPos()H. 针对显示图像的操作(监视/回放/多画面预览)抓图 CLIENT_CapturePicture()码流统计 CLIENT_GetStatiscFlux()打开音频 CLIENT_OpenSound()设置音量 CLIENT_SetVolume()I. 远程控制远程升级 CLIENT_StartUpgradeCLIENT_SendUpgradeCLIENT_StopUpgrade录像控制 CLIENT_QueryRecordStateC

18、LIENT_SetupRecordState系统校时 CLIENT_QueryDeviceTimeCLIENT_SetupDeviceTimeIO控制 CLIENT_QueryIOControlStateCLIENT_IOControlJ. 注销断开设备停止侦听 CLIENT_StopListen()断开连接 CLIENT_Logout()K. 释放SDK资源SDK退出 CLIENT_Cleanup()对D、E、F、G、H、I中的功能大部分之间没有调用先后顺序,当然对同一个功能还是应该按先打开再操作最后关闭的顺序。3 数据结构定义3.1 客户端数据结构F 通用云台控制命令typedef enu

19、m _PTZ_ControlTypePTZ_UP_CONTROL = 0,/上PTZ_DOWN_CONTROL,/下PTZ_LEFT_CONTROL,/左PTZ_RIGHT_CONTROL,/右PTZ_ZOOM_ADD_CONTROL,/变倍+PTZ_ZOOM_DEC_CONTROL,/变倍-PTZ_FOCUS_ADD_CONTROL,/调焦+PTZ_FOCUS_DEC_CONTROL,/调焦-PTZ_APERTURE_ADD_CONTROL,/光圈+PTZ_APERTURE_DEC_CONTROL,/光圈- PTZ_POINT_MOVE_CONTROL,/转至预置点 PTZ_POINT_SE

20、T_CONTROL,/设置 PTZ_POINT_DEL_CONTROL,/删除 PTZ_POINT_LOOP_CONTROL, /点间轮循 PTZ_LAMP_CONTROL,/灯光雨刷PTZ_ControlType;F 云台控制扩展命令typedef enum _EXTPTZ_ControlTypeEXTPTZ_LEFTTOP = 0X20,/ 左上EXTPTZ_RIGHTTOP ,/ 右上EXTPTZ_LEFTDOWN ,/ 左下EXTPTZ_RIGHTDOWN,/ 右下EXTPTZ_ADDTOLOOP, / 加入预置点到巡航巡航线路预置点值EXTPTZ_DELFROMLOOP,/ 删除巡航

21、中预置点巡航线路预置点值 EXTPTZ_CLOSELOOP,/ 清除巡航巡航线路EXTPTZ_STARTPANCRUISE,/开始水平旋转EXTPTZ_STOPPANCRUISE,/ 停止水平旋转EXTPTZ_SETLEFTBORDER,/ 设置左边界EXTPTZ_RIGHTBORDER , /设置右边界EXTPTZ_STARTLINESCAN,/开始线扫 EXTPTZ_CLOSELINESCAN, /停止线扫 EXTPTZ_SETMODESTART, / 设置模式开始模式线路 EXTPTZ_SETMODESTOP,/ 设置模式结束模式线路EXTPTZ_RUNMODE,/运行模式模式线路EXT

22、PTZ_STOPMODE,/停止模式模式线路EXTPTZ_DELETEMODE,/清除模式模式线路EXTPTZ_REVERSECOMM,/翻转命令EXTPTZ_FASTGOTO,/ 快速定位水平坐标垂直坐标变倍EXTPTZ_AUXIOPEN,/ x34辅助开关开辅助点EXTPTZ_AUXICLOSE,/ 0x35辅助开关关辅助点EXTPTZ_OPENMENU = 0X36,/ 打开球机菜单EXTPTZ_CLOSEMENU ,/ 关闭菜单EXTPTZ_MENUOK,/菜单确定EXTPTZ_MENUCANCEL,/菜单取消EXTPTZ_MENUUP,/菜单上EXTPTZ_MENUDOWN,/菜单下

23、EXTPTZ_MENULEFT,/菜单左EXTPTZ_MENURIGHT, /菜单右EXTPTZ_TOTAL,/最大命令值EXTPTZ_ControlType;F IO控制命令typedef enum _IOTYPEALARMINPUT = 1,/报警输入ALARMOUTPUT = 2,/报警输出IOTYPE;F 查询状态类型#define DH_DEVSTATE_COMM_ALARM0x0001/查询普通报警#define DH_DEVSTATE_SHELTER_ALARM0x0002/查询遮挡报警#define DH_DEVSTATE_RECORDING0x0003/查询录象状态#defi

24、ne DH_DEVSTATE_DISK0x0004/查询硬盘状态F 错误类型代号，用于GetLastError函数的返回#define _EC(x)(0x80000000|x)#define NET_NOERROR 0/没有错误#define NET_ERROR-1/未知错误#define NET_SYSTEM_ERROR_EC(1)/Windows系统出错#define NET_NETWORK_ERROR_EC(2)/网络错误#define NET_DEV_VER_NOMATCH_EC(3)/设备协议不匹配#define NET_INVALID_HANDLE_EC(4)/句柄无效#defin

25、e NET_OPEN_CHANNEL_ERROR_EC(5)/打开通道失败#define NET_CLOSE_CHANNEL_ERROR_EC(6)/关闭通道失败#define NET_ILLEGAL_PARAM_EC(7)/用户参数不合法#define NET_SDK_INIT_ERROR_EC(8)/SDK初始化出错#define NET_SDK_UNINIT_ERROR_EC(9)/SDK清理出错#define NET_RENDER_OPEN_ERROR_EC(10)/申请render资源出错#define NET_DEC_OPEN_ERROR_EC(11)/打开解码库出错#define

26、 NET_DEC_CLOSE_ERROR_EC(12)/关闭解码库出错#define NET_MULTIPLAY_NOCHANNEL_EC(13)/多画面预览中检测到通道数为0#define NET_TALK_INIT_ERROR_EC(14)/录音库初始化失败#define NET_TALK_NOT_INIT_EC(15)/录音库未经初始化#defineNET_TALK_SENDDATA_ERROR_EC(16)/发送音频数据出错#define NET_REAL_ALREADY_SAVING_EC(17)/实时数据已经处于保存状态#define NET_NOT_SAVING_EC(18)/未

27、保存实时数据#define NET_OPEN_FILE_ERROR_EC(19)/打开文件出错#define NET_PTZ_SET_TIMER_ERROR_EC(20)/启动云台控制定时器失败#define NET_RETURN_DATA_ERROR_EC(21)/对返回数据的校验出错#define NET_INSUFFICIENT_BUFFER_EC(22)/没有足够的缓存#define NET_NOT_SUPPORTED_EC(23)/当前SDK未支持该功能#define NET_NO_RECORD_FOUND_EC(24)/查询不到录象#define NET_NOT_AUTHORIZE

28、D_EC(25)/无操作权限#define NET_NOT_NOW_EC(26)/暂时无法执行#define NET_NO_TALK_CHANNEL_EC(27)/未发现对讲通道#define NET_NO_AUDIO_EC(28)/未发现音频#define NET_AUDIOENCODE_NOTINI_EC(59)/音频编码接口没有成功初始化#define NET_DATA_TOOLONGH_EC(60)/数据过长#define NET_LOGIN_ERROR_PASSWORD_EC(100)/密码不正确#define NET_LOGIN_ERROR_USER_EC(101)/帐户不存在#d

29、efine NET_LOGIN_ERROR_TIMEOUT_EC(102)/等待登录返回超时#define NET_LOGIN_ERROR_RELOGGIN_EC(103)/帐号已登录#define NET_LOGIN_ERROR_LOCKED_EC(104)/帐号已被锁定#define NET_LOGIN_ERROR_BLACKLIST_EC(105)/帐号已被列为黑名单#define NET_LOGIN_ERROR_BUSY_EC(106)/资源不足，系统忙#define NET_LOGIN_ERROR_CONNECT_EC(107)/连接主机失败#define NET_LOGIN_ERR

30、OR_NETWORK_EC(108)/网络连接失败#define NET_RENDER_SOUND_ON_ERROR_EC(120)/Render库打开音频出错#define NET_RENDER_SOUND_OFF_ERROR_EC(121)/Render库关闭音频出错#define NET_RENDER_SET_VOLUME_ERROR_EC(122)/Render库控制音量出错#define NET_RENDER_ADJUST_ERROR_EC(123)/Render库设置画面参数出错#define NET_RENDER_PAUSE_ERROR_EC(124)/Render库暂停播放出错

31、#define NET_RENDER_SNAP_ERROR_EC(125)/Render库抓图出错#define NET_RENDER_STEP_ERROR_EC(126)/Render库步进出错#define NET_RENDER_FRAMERATE_ERROR_EC(127)/Render库设置帧率出错#define NET_CONFIG_DEVBUSY_EC(999)/暂时无法设置#define NET_CONFIG_DATAILLEGAL_EC(1000)/配置数据不合法F 回调函数类型#define COMM_ALARM0x1100/常规报警信息#define SHELTER_ALA

32、RM0x1101/视频遮挡报警#define DISK_FULL_ALARM0X1102/硬盘满报警#define DISK_ERROR_ALARM0x1103/硬盘故障报警#define SOUND_DETECT_ALARM0x1104/音频检测报警F 设备型号(DVR类型)enum NET_DEVICE_TYPE NET_PRODUCT_NONE = 0,NET_DVR_NONREALTIME_MACE, / 非实时MACE NET_DVR_NONREALTIME, / 非实时 NET_NVS_MPEG1, / 网络视频服务器 NET_DVR_MPEG1_2, / MPEG1二路录像机 N

33、ET_DVR_MPEG1_8, / MPEG1八路录像机 NET_DVR_MPEG4_8, / MPEG4八路录像机 NET_DVR_MPEG4_16, / MPEG4十六路录像机 NET_DVR_MPEG4_SX2, / MPEG4视新十六路录像机 NET_DVR_MEPG4_ST2, / MPEG4视通录像机 NET_DVR_MEPG4_SH2, / MPEG4视豪录像机 NET_DVR_MPEG4_GBE, / MPEG4视通二代增强型录像机 NET_DVR_MPEG4_NVSII, / MPEG4网络视频服务器II代 NET_DVR_STD_NEW, / 新标准配置协议 NET_DVR

34、_DDNS, /DDNS服务器 ;3.1.1 设备信息结构 F 设备结构定义如下 typedef struct BYTE sSerialNumberSERIALNO_LEN;/序列号BYTE byAlarmInPortNum;/DVR报警输入个数BYTE byAlarmOutPortNum;/DVR报警输出个数BYTE byDiskNum;/DVR硬盘个数BYTE byDVRType;/DVR类型, BYTE byChanNum;/DVR通道个数 NET_DEVICEINFO, *LPNET_DEVICEINFO;3.1.2 时间信息typedef struct DWORD dwYear;/年

35、DWORD dwMonth;/月DWORD dwDay;/日DWORD dwHour;/时DWORD dwMinute;/分DWORD dwSecond;/秒 NET_TIME,*LPNET_TIME;3.1.3 录像文件信息typedef struct unsigned intch; /通道号 charfilename128;/文件名 unsigned intsize;/文件长度 NET_TIMEstarttime;/开始时间 NET_TIMEendtime;/结束时间 unsigned intdriveno;/磁盘号 unsigned intstartcluster;/起始簇号 NET_R

36、ECORDFILE_INFO, *LPNET_RECORDFILE_INFO;3.1.4 设备状态信息F 设备端通过回调主动上传的设备状态结构typedef struct intchannelcount;intalarminputcount;unsigned char diskerrorMAX_DISKNUM; unsigned char *record; /size:channelcount unsigned char *alarm; /size:alarminputcount unsigned char *motiondection; /size:channelcount unsigned

37、 char *videolost; /size:channelcount NET_CLIENT_STATE;F 以下为查询的设备工作状态的相关结构typedef struct BYTE byRecordStatic;/通道是否在录像,0-不录像,1-录像BYTE bySignalStatic;/连接的信号状态,0-正常,1-信号丢失BYTE byHardwareStatic;/通道硬件状态,0-正常,1-异常,例如DSP死掉char reserve; /暂时无效DWORD dwBitRate;/实际码率,暂时无效DWORD dwLinkNum;/客户端连接的个数, 暂时无效DWORD dwCl

38、ientIPMAX_LINK;/客户端的IP地址,暂时无效NET_DEV_CHANNELSTATE,*LPNET_DEV_CHANNELSTATE;typedef struct DWORD dwVolume;/硬盘的容量DWORD dwFreeSpace;/硬盘的剩余空间DWORD dwStatus; /硬盘的状态,休眠,活动,不正常等NET_DEV_DISKSTATE,*LPNET_DEV_DISKSTATE;typedef structDWORD dwDeviceStatic; /设备状态0x00 正常,0x01 CPU占用过高, 0x02 硬件错误NET_DEV_DISKSTATE st

39、HardDiskStaticMAX_DISKNUM;/设备暂时不支持NET_DEV_CHANNELSTATE stChanStaticMAX_CHANNUM;/通道的状态BYTE byAlarmInStaticMAX_ALARMIN; /报警端口的状态0-无报警,1-有报警BYTE byAlarmOutStaticMAX_ALARMOUT;/报警输出端口的状态0-无输出,1-有输出DWORD dwLocalDisplay; /本地显示状态0-正常,1-不正常NET_DEV_WORKSTATE,*LPNET_DEV_WORKSTATE;F 录像文件信息typedef struct unsigne

40、d intch;/通道号 charfilename128;/文件名 unsigned intsize;/文件长度 NET_TIME starttime; /开始时间 NET_TIME endtime;/结束时间 unsigned int driveno;/磁盘号 unsigned int startcluster; /起始簇号 NET_RECORDFILE_INFO, *LPNET_RECORDFILE_INFO;F 串口协议信息(232和485)typedef struct charprotocolname12; /协议名unsigned intbaudbase;/波特率unsigned chardatabits; /数据位unsigned charstopbits;