大华网络SDK开发手册南京廖华答案网

大华网络SDK开发手册下载本文

文章发布时间 : 2024/5/11 13:51:11星期六

大华网络SDK编程手册

VERSION 3.1.8(Build 070321)

2007-3-21

网络客户端SDK编程手册

前言

非常感谢您使用我们公司的设备，我们将为您提供最好的服务。

本手册可能包含技术上不准确的地方或印刷错误，欢迎指正。我们将会定期更新手册的内容。

第 2 页共 93 页网络客户端SDK编程手册

修订记录

日期 2006-05-30 创建 2006-7-3 修订接口描述 2006-7-5 2006-7-26 2006-8-10 2006-8-21 2006-8-23 2006-8-28 2006-9-15 2006-9-21 2006-9-29 修订概要描述修订接口描述同步更新接口描述修订接口描述增加典型调用顺序描述 3.0.0整理修订修订内容林峰冯江华立高刘杰陈美英陈美英陈美英陈美英陈美英作者 3.0.5同步增加回调数据扩展接口,更新云台控制陈美英说明 3.0.7同步增加登录扩展接口陈美英 3.0.9同步增加带有配置结构的配置功能接口说陈美英明 2006-10-16 增加单独修改通道名称的接口赵均树 2006-10-21 增加打开实时图像的扩展接口赵均树 2006-10-28 1、增加按时间回放和下载接口 2、增加设备配置的第三方接入和获取设备的序列号功能 2006-11-8 1、带数据回调的按时间回放扩展接口 2、带数据回调的按文件回放扩展接口 3、远程重启接口 4、录像回放能够播放音频 2006-11-19 1、解决了反复修改第三方的IP地址时DVR比较容易死机的问题 2、增加485接口 3、通过网络修改IP配置时DVR重启 2006-11-27 1、增加DDNS查询IP的功能 2006-12-15 修正文档中接口描述的错误,并增加链接 2006-12-25 增加并修改语音对讲的接口 2006-12-29 增加用户管理接口 2007-1-17 赵均树赵均树、陈琼施赵均树、陈琼施赵均树、陈琼施赵均树、陈琼施、林坚彦叶浩、陈琼施林坚彦、陈琼施 2007-2-8 修改了CLIENT_Login的功能描述林坚彦、赵均树、陈增加了CLIENT_FindFile、琼施 CLIENT_FindNextFile、CLIENT_FindClose 林坚彦、陈琼施、增加了设备参数配置的两个接口：赵均树第 3 页共 93 页网络客户端SDK编程手册

CLIENT_GetDevConfig CLIENT_SetDevConfig 2007-3-7 修改了CLIENT_StopListen接口典型应用的笔误增加了个查询报警状态的接口。增加了语音对讲中的音频编码接口增加了扩展报警侦听接口赵均树 2007-03-19 2007-03-21 林坚彦、陈琼施叶浩、陈琼施、林坚彦第 4 页共 93 页网络客户端SDK编程手册

1 简介 ............................................................ 7 1.1 概述 ......................................................... 7 1.2 适用性 ....................................................... 7 1.3 特色功能 ...................................................... 7 2 设计原则 ......................................................... 9 2.1 编程说明 ...................................................... 9 2.2 典型调用顺序 ................................................. 10 3 数据结构定义 ..................................................... 13 3.1 客户端数据结构 ................................................ 13 3.1.1 设备信息结构 ............................................. 16 3.1.2 时间信息 ................................................. 17 3.1.3 录像文件信息 ............................................. 17 3.1.4 设备状态信息 ............................................. 17 3.1.5 系统配置信息结构 .......................................... 22 4 接口定义 ........................................................ 22 4.1 SDK初始化 ................................................... 22 4.2 状态侦听 ..................................................... 24 4.3 字符叠加 ..................................................... 26 4.4 设备注册 ..................................................... 27 4.5 实时监视 ..................................................... 29 4.6 音频控制 ..................................................... 32 4.7 数据保存 ..................................................... 33 4.8 视频抓图 ..................................................... 36 4.9 回放和下载 ................................................... 37 4.10 回放控制 .................................................... 47 4.11 云台控制 .................................................... 50 4.12 实时预览 .................................................... 52 4.13 系统配置 .................................................... 53 4.14 日志管理 .................................................... 57 4.15 透明串口 .................................................... 59 4.16 远程控制 .................................................... 61 4.17 录像控制 .................................................... 62 4.18 系统时间 .................................................... 63 4.19 用户管理 .................................................... 64

第 5 页共 93 页网络客户端SDK编程手册

4.20 语音对讲 .................................................... 66 4.21 码流统计 .................................................... 71 4.22 IO控制 .................................................... 72 4.23 强制I帧 ................................................... 73 4.24 设置限流 .................................................... 73 4.25 获取设备状态 ................................................ 74 4.26 修改通道名称 ................................................ 75 4.27 DDNS查询IP ................................................ 75 4.28 设备参数配置 ................................................ 76 5 示例功能实现 ..................................................... 90 5.1 连接设备 ..................................................... 90 5.2 报警信息获取 ................................................. 90 5.3 系统配置 ..................................................... 91 5.4 实时监视 ..................................................... 91 5.5 数据保存 ..................................................... 91 5.6 回放/下载和进度指示 ........................................... 92 5.7 播放控制 ..................................................... 92 5.8 预览 ........................................................ 92 5.9 字符叠加 ..................................................... 92

第 6 页共 93 页网络客户端SDK编程手册

1 简介

1.1 概述

欢迎使用大华网络SDK编程手册，网络客户端软件开发包（DVR客户端SDK）是大华网络硬盘录像机、网络视频服务器的配套产品，本文档详细描述了开发包中各个函数实现的功能、接口及其函数之间的调用关系和示例实现。

网络客户端软件开发包主要包括业务操作和设备管理两大部分：

业务操作：状态侦听、实时监视、实时预览、字符叠加、音频控制、录像回放和下

载、数据保存、云台控制、语音对讲、透明串口、码流统计等功能。

设备管理：远程升级、远程重启/关闭、设备参数配置（系统通用配置、报警布/撤防

设置、录像配置、串口配置、图像配置、日志管理、用户管理、设备校时、动态检测配置、网络配置）等功能。

开发包所包括的文件有：

网络库：dhnetsdk.lib、dhnetsdk.dll、dhnetsdk.h

解码库：decode.dll、render.dll、dllh264.dll、audiorecord.dll、AudioRecordEx.dll、

avcodec.dll

辅助库：dhdvr.dll、ParaTimer.dll、DetectAreaCtrl.ocx、SetDeviceConfigProj.ocx

1.2 适用性

? ? ? ?

支持所有大华网络硬盘录像机（DVR）、网络视频服务器（NVS）、网络报警服务器（NAS）

只支持TCP网络传输模式

客户端可以采用多种分辨率进行图像预览，支持的分辨率包括： QCIF、CIF、2CIF、、HalfD1、D1，VGA（640×480）等

客户端支持多种图像编码，包括MPEG4和H.264等

1.3 特色功能

支持设备的以下特色功能： ? 多路预览

在窄带条件下，同时多路实时监视对带宽的要求比较高，一般的处理情况有两种，其一，轮巡。其二，多路预览。所谓多路预览，就是在一个通道上把所有通道的数据组织在一起传输，等同于多路同时监视。必要的时候，可以转单路监视。大华DVR支持多路预览功能。 ? 支持标准的MP4数据

一般情况下，同一平台集成不同厂商的前端设备（如DVR），由于各厂商采用的视频压缩方法不同(包括算法、参数定义等)，导致解码端回放必须采用厂商特定的工

第 7 页共 93 页网络客户端SDK编程手册

具，造成平台开发商无法自定义播放标准。本SDK能够解决这个问题。通过特定接口，应用层可以通过本SDK获取标准媒体数据（FOURCC(‘D’、‘I’、‘V’、‘X’)视频数据），要支持用各种通用播放器播放，有了提供标准数据，应用层只须打包标准数据到播放器支持的容器类型(也就是文件格式,如AVI标准)就可以了。

第 8 页共 93 页网络客户端SDK编程手册

2 设计原则

2.1 编程说明

? 初始化和清除

1、使用网络客户端软件包首先调用CLIENT_Init()对系统进行初始化，应用程序

退出时调用CLIENT_Cleanup()释放所有占用的资源。

2、大多数函数调用均应该在CLIENT_Init()之后，CLIENT_Cleanup()之前，除了

少数函数，譬如CLIENT_SetConnectTime()在CLIENT_Init()之前调用，而CLIENT_GetSDKVersion()可以在任何时候调用等等。 ? 操作句柄

系统设计上多处使用了句柄概念，很多操作均针对句柄，如回放、下载以及语音对讲等。 ? 用户登录和注销

用户在访问前端设备之前必须通过调用CLIENT_Login ()登录到前端设备上，登录成功后返回一个全局唯一的句柄。此句柄就像一个会话通道，之后该用户可通过此句柄访问前端设备。退出该会话时则通过CLIENT_Logout ()函数在前端设备上注销此句柄以终止该会话通道的使用。建立连接与登录是同步的。 ? 心跳功能

在本开发包中提供自动心跳功能（20秒一次心跳）当设备断开能及时回调给客户端。 ? 同步与异步

异步以设置回调函数来响应网络数据，有些异步在设置后返回请求句柄，结束请求时将请求句柄提供给SDK以注销相关资源。 ? SDK提供协议探测和转换 ? 回调函数

一般都有dwUser参数, 由用户自定义需要的数据, 一般用来传入类对象指针, 方便回调处理在类中实现,回调应用都可以采取这种方式。

第 9 页共 93 页网络客户端SDK编程手册

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_SetupConfig() 获取设备状态 CLIENT_GetDEVWorkState() 获取协议信息 CLIENT_QueryComProtocol() 查询获取系统信息 CLIENT_QuerySystemInfo() 查询通道名称 CLIENT_QueryChannelName() 查询日志 CLIENT_QueryLogCallback() CLIENT_QueryLog() 用户管理 CLIENT_QueryUserInfo() CLIENT_OperateUserInfo() 云台控制 CLIENT_PTZControl() CLIENT_DHPTZControl() 语音对讲 CLIENT_StartTalk() CLIENT_SendTalkData_Custom() CLIENT_StopTalk() 设置限流 CLIENT_SetMaxFlux() 透明串口 CLIENT_CreateTransComChannel() CLIENT_SendTransComData() CLIENT_DestroyTransComChanne()

第 10 页共 93 页网络客户端SDK编程手册

E. 实时监视通道

打开监视通道 CLIENT_RealPlay() CLIENT_RealPlayEx() 保存监视图像数据 CLIENT_SaveRealData() 监视数据回调保存 CLIENT_SetRealDataCallBack() CLIENT_SetRealDataCallBackEx() 获取视频参数信息 CLIENT_ClientGetVideoEffect() 设置修改视频参数 CLIENT_ClientSetVideoEffect() 强制I帧 CLIENT_MakeKeyFrame()

F. 多画面预览通道

打开多画面预览 CLIENT_MultiPlay() 停止多画面预览 CLIENT_StopMultiPlay()

G. 回放/下载通道

查询录像 CLIENT_QueryRecordFile() 回放及控制 CLIENT_PlayBackByRecordFile() CLIENT_PlayBackByRecordFileEx() CLIENT_PlayBackByTime() CLIENT_PlayBackByTimeEx() CLIENT_GetPlayBackOsdTime() CLIENT_PausePlayBack() CLIENT_SeekPlayBack() CLIENT_StopPlayBack() CLIENT_StepPlayBack() CLIENT_FastPlayBack() CLIENT_SlowPlayBack() CLIENT_GetFramePlayBack() CLIENT_SetFramePlayBack() 下载 CLIENT_DownloadByRecordFile() CLIENT_DownloadByRecordFileEx() CLIENT_DownloadByTime() CLIENT_StopDownload() CLIENT_GetDownloadPos()

第 11 页共 93 页网络客户端SDK编程手册

H. 针对显示图像的操作(监视/回放/多画面预览)

抓图 CLIENT_CapturePicture() 码流统计 CLIENT_GetStatiscFlux() 打开音频 CLIENT_OpenSound() 设置音量 CLIENT_SetVolume()

I. 远程控制

远程升级 CLIENT_StartUpgrade CLIENT_SendUpgrade CLIENT_StopUpgrade 录像控制 CLIENT_QueryRecordState CLIENT_SetupRecordState 系统校时 CLIENT_QueryDeviceTime CLIENT_SetupDeviceTime IO控制 CLIENT_QueryIOControlState CLIENT_IOControl

J. 注销断开设备

停止侦听 CLIENT_StopListen() 断开连接 CLIENT_Logout()

K. 释放SDK资源

SDK退出 CLIENT_Cleanup()

对D、E、F、G、H、I中的功能大部分之间没有调用先后顺序,当然对同一个功能还是应该按先打开再操作最后关闭的顺序。

第 12 页共 93 页网络客户端SDK编程手册

3 数据结构定义

3.1 客户端数据结构

? 通用云台控制命令

typedef enum _PTZ_ControlType {

PTZ_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_SET_CONTROL, PTZ_POINT_DEL_CONTROL, PTZ_POINT_LOOP_CONTROL, PTZ_LAMP_CONTROL, }PTZ_ControlType;

//上 //下 //左 //右 //变倍+ //变倍- //调焦+ //调焦- //光圈+ //光圈-

//转至预置点 //设置 //删除 //点间轮循 //灯光雨刷

? 云台控制扩展命令

typedef enum _EXTPTZ_ControlType{ EXTPTZ_LEFTTOP = 0X20, EXTPTZ_RIGHTTOP , EXTPTZ_LEFTDOWN , EXTPTZ_RIGHTDOWN, EXTPTZ_ADDTOLOOP, EXTPTZ_DELFROMLOOP, EXTPTZ_CLOSELOOP, EXTPTZ_STARTPANCRUISE, EXTPTZ_STOPPANCRUISE, EXTPTZ_SETLEFTBORDER, EXTPTZ_RIGHTBORDER , EXTPTZ_STARTLINESCAN, EXTPTZ_CLOSELINESCAN,

// 左上 // 右上 // 左下 // 右下

// 加入预置点到巡航巡航线路 // 删除巡航中预置点巡航线路 // 清除巡航巡航线路 // 开始水平旋转 // 停止水平旋转 // 设置左边界 // 设置右边界 // 开始线扫 // 停止线扫

预置点值预置点值

第 13 页共 93 页网络客户端SDK编程手册

EXTPTZ_SETMODESTART, EXTPTZ_SETMODESTOP, EXTPTZ_RUNMODE, EXTPTZ_STOPMODE, EXTPTZ_DELETEMODE, EXTPTZ_REVERSECOMM, EXTPTZ_FASTGOTO, EXTPTZ_AUXIOPEN, EXTPTZ_AUXICLOSE, EXTPTZ_OPENMENU = 0X36, EXTPTZ_CLOSEMENU , EXTPTZ_MENUOK, EXTPTZ_MENUCANCEL, EXTPTZ_MENUUP, EXTPTZ_MENUDOWN, EXTPTZ_MENULEFT, EXTPTZ_MENURIGHT, EXTPTZ_TOTAL, }EXTPTZ_ControlType;

// 设置模式开始模式线路 // 设置模式结束模式线路 // 运行模式模式线路 // 停止模式模式线路 // 清除模式模式线路 // 翻转命令 // 快速定位水平坐标垂直坐标 // x34 辅助开关开辅助点 // 0x35辅助开关关辅助点 // 打开球机菜单 // 关闭菜单 //菜单确定 //菜单取消 //菜单上 //菜单下 //菜单左 //菜单右 //最大命令值

变倍

? IO控制命令

typedef enum _IOTYPE{ ALARMINPUT = 1, ALARMOUTPUT = 2, }IOTYPE;

//报警输入 //报警输出

? 查询状态类型

#define DH_DEVSTATE_COMM_ALARM #define DH_DEVSTATE_SHELTER_ALARM #define DH_DEVSTATE_RECORDING #define DH_DEVSTATE_DISK

0x0001 0x0002 0x0003 0x0004

//查询普通报警

//查询遮挡报警 //查询录象状态 //查询硬盘状态

? 错误类型代号，用于GetLastError函数的返回

#define _EC(x)

(0x80000000|x) 0 -1 _EC(1) _EC(2) _EC(3)

//没有错误 //未知错误

//Windows系统出错 //网络错误

//设备协议不匹配

#define NET_NOERROR #define NET_ERROR #define NET_SYSTEM_ERROR #define NET_NETWORK_ERROR #define NET_DEV_VER_NOMATCH

第 14 页共 93 页网络客户端SDK编程手册

#define NET_INVALID_HANDLE _EC(4) #define 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) #define NET_SDK_UNINIT_ERROR _EC(9) #define NET_RENDER_OPEN_ERROR _EC(10) #define NET_DEC_OPEN_ERROR _EC(11) #define NET_DEC_CLOSE_ERROR _EC(12) #define NET_MULTIPLAY_NOCHANNEL _EC(13) #define NET_TALK_INIT_ERROR _EC(14) #define NET_TALK_NOT_INIT _EC(15) #define NET_TALK_SENDDATA_ERROR _EC(16) #define NET_REAL_ALREADY_SAVING _EC(17) #define NET_NOT_SAVING _EC(18) #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) #define NET_NO_RECORD_FOUND _EC(24) #define NET_NOT_AUTHORIZED _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) #define 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_ERROR_NETWORK _EC(108) #define NET_RENDER_SOUND_ON_ERROR _EC(120) #define NET_RENDER_SOUND_OFF_ERROR _EC(121) #define NET_RENDER_SET_VOLUME_ERROR _EC(122) #define NET_RENDER_ADJUST_ERROR _EC(123) #define NET_RENDER_PAUSE_ERROR _EC(124) #define NET_RENDER_SNAP_ERROR _EC(125) #define NET_RENDER_STEP_ERROR _EC(126) //句柄无效 //打开通道失败 //关闭通道失败 //用户参数不合法 //SDK初始化出错 //SDK清理出错

//申请render资源出错 //打开解码库出错 //关闭解码库出错

//多画面预览中检测到通道数为0 //录音库初始化失败 //录音库未经初始化 //发送音频数据出错

//实时数据已经处于保存状态 //未保存实时数据 //打开文件出错

//启动云台控制定时器失败 //对返回数据的校验出错 //没有足够的缓存

//当前SDK未支持该功能 //查询不到录象 //无操作权限 //暂时无法执行 //未发现对讲通道 //未发现音频

//音频编码接口没有成功初始化 //数据过长 //密码不正确 //帐户不存在

//等待登录返回超时 //帐号已登录 //帐号已被锁定

//帐号已被列为黑名单 //资源不足，系统忙 //连接主机失败\//网络连接失败\

//Render库打开音频出错 //Render库关闭音频出错 //Render库控制音量出错 //Render库设置画面参数出错 //Render库暂停播放出错 //Render库抓图出错 //Render库步进出错

第 15 页共 93 页网络客户端SDK编程手册

#define NET_RENDER_FRAMERATE_ERROR _EC(127) //Render库设置帧率出错 #define NET_CONFIG_DEVBUSY _EC(999) //暂时无法设置 #define NET_CONFIG_DATAILLEGAL _EC(1000) //配置数据不合法

? 回调函数类型

#define COMM_ALARM #define SHELTER_ALARM #define DISK_FULL_ALARM #define DISK_ERROR_ALARM #define SOUND_DETECT_ALARM

0x1100 0x1101 0X1102 0x1103 0x1104

//常规报警信息

//视频遮挡报警 //硬盘满报警 //硬盘故障报警 //音频检测报警

? 设备型号(DVR类型)

enum NET_DEVICE_TYPE { NET_PRODUCT_NONE = 0, NET_DVR_NONREALTIME_MACE, NET_DVR_NONREALTIME, NET_NVS_MPEG1, NET_DVR_MPEG1_2, NET_DVR_MPEG1_8, NET_DVR_MPEG4_8, NET_DVR_MPEG4_16, NET_DVR_MPEG4_SX2, NET_DVR_MEPG4_ST2, NET_DVR_MEPG4_SH2, NET_DVR_MPEG4_GBE, NET_DVR_MPEG4_NVSII, NET_DVR_STD_NEW, NET_DVR_DDNS, };

// 非实时MACE // 非实时

// 网络视频服务器 // MPEG1二路录像机 // MPEG1八路录像机 // MPEG4八路录像机 // MPEG4十六路录像机 // MPEG4视新十六路录像机 // MPEG4视通录像机 // MPEG4视豪录像机

// MPEG4视通二代增强型录像机 // MPEG4网络视频服务器II代 // 新标准配置协议 // DDNS服务器

3.1.1 设备信息结构

? 设备结构定义如下

typedef struct {

BYTE sSerialNumber[SERIALNO_LEN];

BYTE byAlarmInPortNum; BYTE byAlarmOutPortNum; BYTE byDiskNum; BYTE byDVRType;

//序列号

//DVR报警输入个数 //DVR报警输出个数 //DVR硬盘个数 //DVR类型,

第 16 页共 93 页网络客户端SDK编程手册

BYTE byChanNum; } NET_DEVICEINFO, *LPNET_DEVICEINFO;

//DVR通道个数

3.1.2 时间信息

typedef struct {

DWORD dwYear; DWORD dwMonth; DWORD dwDay; DWORD dwHour; DWORD dwMinute; DWORD dwSecond; } NET_TIME,*LPNET_TIME;

//年 //月 //日 //时 //分 //秒

3.1.3 录像文件信息

typedef struct {

unsigned int ch; //通道号 char filename[128]; //文件名 unsigned int size; //文件长度 NET_TIME starttime; //开始时间 NET_TIME endtime; //结束时间 unsigned int driveno; //磁盘号 unsigned int startcluster; //起始簇号 } NET_RECORDFILE_INFO, *LPNET_RECORDFILE_INFO;

3.1.4 设备状态信息

? 设备端通过回调主动上传的设备状态结构

typedef struct {

int channelcount; int alarminputcount;

unsigned char diskerror[MAX_DISKNUM]; unsigned char *record; //size:channelcount unsigned char *alarm; //size:alarminputcount unsigned char *motiondection; //size:channelcount unsigned char *videolost; //size:channelcount } NET_CLIENT_STATE;

第 17 页共 93 页网络客户端SDK编程手册

? 以下为查询的设备工作状态的相关结构

typedef struct {

BYTE byRecordStatic; //通道是否在录像,0-不录像,1-录像 BYTE bySignalStatic; //连接的信号状态,0-正常,1-信号丢失

BYTE byHardwareStatic; //通道硬件状态,0-正常,1-异常,例如DSP死掉 char reserve; //暂时无效

DWORD dwBitRate; //实际码率,暂时无效

DWORD dwLinkNum; //客户端连接的个数, 暂时无效 DWORD dwClientIP[MAX_LINK]; //客户端的IP地址,暂时无效 }NET_DEV_CHANNELSTATE,*LPNET_DEV_CHANNELSTATE; typedef struct {

DWORD dwVolume; //硬盘的容量 DWORD dwFreeSpace; //硬盘的剩余空间

DWORD dwStatus; //硬盘的状态,休眠,活动,不正常等 }NET_DEV_DISKSTATE,*LPNET_DEV_DISKSTATE; typedef struct{

DWORD dwDeviceStatic; //设备状态0x00 正常,0x01 CPU占用过高, 0x02 硬件错误 NET_DEV_DISKSTATE stHardDiskStatic[MAX_DISKNUM]; //设备暂时不支持 NET_DEV_CHANNELSTATE stChanStatic[MAX_CHANNUM]; //通道的状态

BYTE byAlarmInStatic[MAX_ALARMIN]; //报警端口的状态0-无报警,1-有报警

BYTE byAlarmOutStatic[MAX_ALARMOUT];//报警输出端口的状态0-无输出,1-有输出 DWORD dwLocalDisplay; //本地显示状态0-正常,1-不正常 }NET_DEV_WORKSTATE,*LPNET_DEV_WORKSTATE;

? 录像文件信息

typedef struct {

第 18 页共 93 页网络客户端SDK编程手册

? 串口协议信息(232和485)

typedef struct {

char protocolname[12]; unsigned int baudbase; unsigned char databits; unsigned char stopbits; unsigned char parity; unsigned char reserve;

} PROTOCOL_INFO, *LPPROTOCOL_INFO;

//协议名 //波特率 //数据位 //停止位 //校验位

? 报警IO控制(报警输出和报警输入使能)

typedef struct {

unsigned short index; unsigned short state; }ALARM_CONTROL;

//端口序号 //端口状态

? 用户管理功能数据结构

#define MAX_RIGHT_NUM #define MAX_GROUP_NUM #define MAX_USER_NUM #define RIGHT_NAME_LENGTH #define USER_NAME_LENGTH #define USER_PSW_LENGTH #define MEMO_LENGTH

100 20 200 32 8 8 32

typedef struct { DWORD dwID;

char name[RIGHT_NAME_LENGTH]; char memo[MEMO_LENGTH]; }OPR_RIGHT;

typedef struct { DWORD dwID;

DWORD dwGroupID;

char name[USER_NAME_LENGTH]; char passWord[USER_PSW_LENGTH]; DWORD dwRightNum;

DWORD rights[MAX_RIGHT_NUM]; char memo[MEMO_LENGTH]; }USER_INFO;

第 19 页共 93 页网络客户端SDK编程手册

typedef struct { DWORD dwID;

char name[USER_NAME_LENGTH]; DWORD dwRightNum;

DWORD rights[MAX_RIGHT_NUM]; char memo[MEMO_LENGTH]; }USER_GROUP_INFO;

? SDK返回的用户信息结构

typedef struct { DWORD OPR_RIGHT DWORD USER_GROUP_INFO DWORD USER_INFO }USER_MANAGE_INFO;

dwRightNum;

rightList[MAX_RIGHT_NUM]; dwGroupNum;

groupList[MAX_GROUP_NUM]; dwUserNum;

userList[MAX_USER_NUM];

? 日志信息

1. 日志的结构形式 //时间结构

typedef struct _DHTIME {

DWORD second :6; DWORD minute :6; DWORD hour :5; DWORD day :5; DWORD month :4; DWORD year :6; }DHTIME,*pDHTIME;

//日志结构

struct LOG_ITEM {

DHTIME time; WORD BYTE BYTE BYTE };

//日期

接口文档数字视频录像机网络服务编程手册公开 //类型

//标记, 0x00 正常，0x01 扩展，0x02 数据 //数据 //内容

// 秒 // 分 // 时 // 日 // 月 // 年 1-60 1-60 1-24 1-31 1-12 2000-2063

type; flag; data; context[8];

第 20 页共 93 页网络客户端SDK编程手册

2. 日志的类型

enum dh_log_t {

LOG_REBOOT = 0x0000, LOG_SHUT,

LOG_CONFSAVE = 0x0100, LOG_CONFLOAD,

//system logs //config logs

LOG_FSERROR = 0x0200, //文件系统错误 LOG_HDD_WERR, //硬盘写错误 LOG_HDD_RERR, //硬盘读错误 LOG_HDD_TYPE, //设置硬盘类型 LOG_HDD_FORMAT, //格式化硬盘 LOG_ALM_IN = 0x0300, //alarm logs //record

LOG_MANUAL_RECORD_START = 0x0400, LOG_MANUAL_RECORD_STOP, //user manager

LOG_LOGIN = 0x0500, LOG_LOGOUT, LOG_ADD_USER, LOG_DELETE_USER, LOG_MODIFY_USER, LOG_ADD_GROUP, LOG_DELETE_GROUP, LOG_MODIFY_GROUP, //clear

LOG_CLEAR = 0x0600, //record operation LOG_DOWNLOAD, LOG_PLAYBACK, LOG_TYPE_NR = 8, };

//录像下载 //录像回放

3. 数据组织

向客户端传递所有日志信息，长度为N*日志结构长度，N为日志的条数。

? 查询硬盘信息的返回数据结构

typedef struct{

DWORD dwDiskNum; //硬盘个数

NET_DEV_DISKSTATE stDisks[DH_MAX_DISKNUM]; //各硬盘信息 }DH_HARDDISK_STATE,*LPDH_HARDDISK_STATE;

第 21 页共 93 页网络客户端SDK编程手册

? 音频数据的格式结构

Typedef struct{

BYTE byFormatTag; //编码类型，0-PCM WORD nChannels; //声道数 WORD wBitsPerSample; //采样深度 DWORD nSamplesPerSec; //采样率

} DH_AUDIO_FORMAT, *LPDH_AUDIO_FORMAT;

3.1.5 系统配置信息结构

目前提供了配置控件的方式配置设备

4 接口定义

4.1 SDK初始化

CLIENT_API DWORD CALL_METHOD CLIENT_GetLastError(void);

? 函数说明：返回函数执行失败代码，当调用下面的接口失败时，可以用该函

数获取失败的代码，具体错误代码参见错误类型代号说明 ? 参数说明： ? 返回值：返回 ? 相关函数：

? 典型应用：参加demo

typedef void (CALLBACK *fDisConnect)(LONG lLoginID, char *pchDVRIP, LONG nDVRPort, DWORD dwUser);

2. CLIENT_API BOOL CLIENT_Init(fDisConnect cbDisConnect,

DWORD dwUser); ? 函数说明：初始化SDK, 在所有的SDK函数之前调用 ? 参数说明：

cbDisConnect

断线回调函数，回调出当前网络已经断开的设备, 对主动断开的设备不回调; 设置为0时禁止回调

dwUser

用户数据

第 22 页共 93 页网络客户端SDK编程手册

? 回调函数参数说明：

lLoginID

CLIENT_Login的返回值

pchDVRIP

设备IP

nDVRPort

端口 dwUser

用户数据，就是上面输入的用户数据

? 返回值：成功返回TRUE，不成功返回FALSE ? 相关函数：CLIENT_Cleanup

? 典型应用：在应用程序初始化时调用

3. ? ? ? ? ?

CLIENT_API void CLIENT_SetConnectTime(int nWaitTime, int nTryTimes);

CLIENT_API void CLIENT_Cleanup();

函数说明：清空SDK, 释放占用的资源，在所有的SDK函数之后调用。参数：无返回值：无