[信息与通信]大华网络SDK开发手册.doc
《[信息与通信]大华网络SDK开发手册.doc》由会员分享,可在线阅读,更多相关《[信息与通信]大华网络SDK开发手册.doc(94页珍藏版)》请在三一文库上搜索。
1、大华网络大华网络 SDK 编程手册编程手册 VERSION 3.1.8(Build 070321) 2007-3-21 版权所有 侵权必究 网络客户端 SDK 编程手册 第 2 页 共 94 页 前前 言言 非常感谢您使用我们公司的设备,我们将为您提供最好的服务。 本手册可能包含技术上不准确的地方或印刷错误,欢迎指正。我们将会定期更新手 册的内容。 网络客户端 SDK 编程手册 第 3 页 共 94 页 修订记录修订记录 日期日期修订内容修订内容作者作者 2006-05-30创建林峰 2006-7-3修订接口描述冯江 2006-7-5修订概要描述华立高 2006-7-26修订接口描述刘杰 陈美
2、英 2006-8-10同步更新接口描述陈美英 2006-8-21修订接口描述陈美英 2006-8-23增加典型调用顺序描述陈美英 2006-8-283.0.0 整理修订陈美英 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、增加设备配置的第三方接入和获取设备的序
3、列号功能 赵均树 2006-11-81、带数据回调的按时间回放扩展接口 2、带数据回调的按文件回放扩展接口 3、远程重启接口 4、录像回放能够播放音频 赵均树、陈琼施 2006-11-191、解决了反复修改第三方的 IP 地址时 DVR 比 较容易死机的问题 2、增加 485 接口 3、通过网络修改 IP 配置时 DVR 重启 赵均树、陈琼施 2006-11-271、增加 DDNS 查询 IP 的功能赵均树、陈琼施 2006-12-15修正文档中接口描述的错误,并增加链接赵均树、陈琼施、 林坚彦 2006-12-25增加并修改语音对讲的接口叶浩、陈琼施 2006-12-29增加用户管理接口林坚
4、彦、陈琼施 2007-1-17修改了 CLIENT_Login 的功能描述 增加了 CLIENT_FindFile、CLIENT_FindNextFile、CLI ENT_FindClose 林坚彦、赵均树、 陈琼施 网络客户端 SDK 编程手册 第 4 页 共 94 页 2007-2-8 增加了设备参数配置的两个接口: CLIENT_GetDevConfig CLIENT_SetDevConfig 林坚彦、陈琼施、 赵均树 2007-3-7 修改了 CLIENT_StopListen 接口典型应用的笔 误 赵均树 2007-03-19 增加了个查询报警状态的接口。 林坚彦、陈琼施 2007-
5、03-21 增加了语音对讲中的音频编码接口 增加了扩展报警侦听接口 叶浩、陈琼施、林 坚彦 网络客户端 SDK 编程手册 第 5 页 共 94 页 目目 录录 1 简简 介介 .7 1.1 概述概述 7 1.2 适用性适用性 7 1.3 特色功能特色功能.8 2 设计原则设计原则.9 2.1 编程说明编程说明.9 2.2 典型调用顺序典型调用顺序 10 3 数据结构定义数据结构定义 13 3.1 客户端数据结构客户端数据结构.13 3.1.1 设备信息结构设备信息结构 16 3.1.2 时间信息时间信息16 3.1.3 录像文件信息录像文件信息 17 3.1.4 设备状态信息设备状态信息 17
6、 3.1.5 系统配置信息结构系统配置信息结构 .21 4 接口定义接口定义21 4.1 SDK 初始化初始化 21 4.2 状态侦听状态侦听23 4.3 字符叠加字符叠加25 4.4 设备注册设备注册26 4.5 实时监视实时监视27 4.6 音频控制音频控制31 4.7 数据保存数据保存32 4.8 视频抓图视频抓图35 4.9 回放和下载回放和下载 36 4.10 回放控制回放控制.46 4.11 云台控制云台控制.49 4.12 实时预览实时预览.51 4.13 系统配置系统配置.52 4.14 日志管理日志管理.57 4.15 透明串口透明串口.58 4.16 远程控制远程控制.60
7、 4.17 录像控制录像控制.62 4.18 系统时间系统时间.63 4.19 用户管理用户管理.63 网络客户端 SDK 编程手册 第 6 页 共 94 页 4.20 语音语音对对讲讲.65 4.21 码流统计码流统计.69 4.22 IO 控制控制70 4.23 强制强制 I 帧帧.71 4.24 设置限流设置限流.71 4.25 获取设备状态获取设备状态 .72 4.26 修改通道名称修改通道名称 .72 4.27 DDNS 查询查询 IP .73 4.28 设备参数设备参数配配置置 .73 5 示例功能实现示例功能实现 87 5.1 连接设备连接设备88 5.2 报警信息获取报警信息获
8、取 88 5.3 系统配置系统配置88 5.4 实时监视实时监视88 5.5 数据保存数据保存89 5.6 回放回放/下载和进度指示下载和进度指示 89 5.7 播放控制播放控制89 5.8 预览预览 .89 5.9 字符叠加字符叠加89 网络客户端 SDK 编程手册 第 7 页 共 94 页 1 简简 介介 1.1 概述概述 欢迎使用大华网络 SDK 编程手册,网络客户端软件开发包(DVR 客户端 SDK)是 大华网络硬盘录像机、网络视频服务器的配套产品,本文档详细描述了开发包中各个函 数实现的功能、接口及其函数之间的调用关系和示例实现。 网络客户端软件开发包主要包括业务操作和设备管理两大部
9、分: 业务操作业务操作:状态侦听、实时监视、实时预览、字符叠加、音频控制、录像回放和下 载、数据保存、云台控制、语音对讲、透明串口、码流统计等功能。 设备管理设备管理:远程升级、远程重启/关闭、设备参数配置(系统通用配置、报警布/撤 防设置、录像配置、串口配置、图像配置、日志管理、用户管理、设备 校时、动态检测配置、网络配置)等功能。 开发包所包括的文件有: 网络库:dhnetsdk.lib、dhnetsdk.dll、dhnetsdk.h 解码库: decode.dll、render.dll、dllh264.dll、audiorecord.dll、AudioRecordEx.dll 、avco
10、dec.dll 辅助库:dhdvr.dll、ParaTimer.dll、DetectAreaCtrl.ocx、SetDeviceConfigProj.ocx 1.2 适用性适用性 支持所有大华网络硬盘录像机(DVR) 、网络视频服务器(NVS) 、网络报 警 服务器(NAS) 只支持 TCP 网络传输模式 客户端可以采用多种分辨率进行图像预览,支持的分辨率包括: QCIF、CIF、2CIF、 、HalfD1、D1,VGA(640480)等 客户端支持多种图像编码,包括 MPEG4 和 H.264 等 1.3 特色功能特色功能 支持设备的以下特色功能: 多路预览 在窄带条件下,同时多路实时监视对
11、带宽的要求比较高,一般的处理情况有两 种,其一,轮巡。其二,多路预览。所谓多路预览,就是在一个通道上把所有通道 的数据组织在一起传输,等同于多路同时监视。必要的时候,可以转单路监视。大 华 DVR 支持多路预览功能。 支持标准的 MP4 数据 一般情况下,同一平台集成不同厂商的前端设备(如 DVR) ,由于各厂商采用 网络客户端 SDK 编程手册 第 8 页 共 94 页 的视频压缩方法不同(包括算法、参数定义等),导致解码端回放必须采用厂商特定 的工具,造成平台开发商无法自定义播放标准。本 SDK 能够解决这个问题。通过 特定接口,应用层可以通过本 SDK 获取标准媒体数据(FOURCC(D
12、、 I、 V、 X) 视频数据) ,要支持用各种通用播放器播放,有了提供标准数据,应用层只须打包 标准数据到播放器支持的容器类型(也就是文件格式,如 AVI 标准)就可以了。 网络客户端 SDK 编程手册 第 9 页 共 94 页 2 设计原则设计原则 2.1 编程说明编程说明 初始化和清除初始化和清除 1、 使用网络客户端软件包首先调用CLIENT_Init()对系统进行初始化,应用程序 退出时调用CLIENT_Cleanup()释放所有占用的资源。 2、 大多数函数调用均应该在CLIENT_Init()之后,CLIENT_Cleanup()之前,除 了少数函数,譬如CLIENT_SetCo
13、nnectTime()在CLIENT_Init()之前调用, 而CLIENT_GetSDKVersion()可以在任何时候调用等等。 操作句柄操作句柄 系统设计上多处使用了句柄概念,很多操作均针对句柄,如回放、下载以及语 音对讲等。 用户登录和注销用户登录和注销 用户在访问前端设备之前必须通过调用CLIENT_Login ()登录到前端设备上, 登录成功后返回一个全局唯一的句柄。此句柄就像一个会话通道,之后该用户可通 过此句柄访问前端设备。退出该会话时则通过CLIENT_Logout ()函数在前端设备 上注销此句柄以终止该会话通道的使用。建立连接与登录是同步的。 心跳功能心跳功能 在本开发包
14、中提供自动心跳功能(20 秒一次心跳)当设备断开能及时回调给客户端。 同步与异步同步与异步 异步以设置回调函数来响应网络数据,有些异步在设置后返回请求句柄,结束 请求时将请求句柄提供给 SDK 以注销相关资源。 SDK提供协议探测和转换提供协议探测和转换 回调函数回调函数 一般都有 dwUser 参数, 由用户自定义需要的数据, 一般用来传入类对象指针, 方便回调处理在类中实现,回调应用都可以采取这种方式。 网络客户端 SDK 编程手册 第 10 页 共 94 页 2.2 典型调用顺序典型调用顺序 A. 初始化 SDK 初始化 CLIENT_Init() B. SDK 功能设置或信息获取 设置
15、连接等待时间 CLIENT_SetConnectTime() 获取 SDK 版本 CLIENT_GetSDKVersion() 设置消息回调 CLIENT_SetDVRMessCallBack() 设置自定义叠加画板 CLIENT_RigisterDrawFun() C. 登录连接设备 登录设备 CLIENT_Login() 开始侦听 CLIENT_StartListen() D. 设备功能操作与信息获取 系统配置 CLIENT_QueryConfig() CLIENT_SetupConfig() 获取设备状态 CLIENT_GetDEVWorkState() 获取协议信息 CLIENT_Qu
16、eryComProtocol() 查询获取系统信息 CLIENT_QuerySystemInfo() 查询通道名称 CLIENT_QueryChannelName() 查询日志 CLIENT_QueryLogCallback() CLIENT_QueryLog() 用户管理 CLIENT_QueryUserInfo() CLIENT_OperateUserInfo() 云台控制 CLIENT_PTZControl() CLIENT_DHPTZControl() 语音对讲 CLIENT_StartTalk() CLIENT_SendTalkData_Custom() CLIENT_StopTal
17、k() 设置限流 CLIENT_SetMaxFlux() 透明串口 CLIENT_CreateTransComChannel() CLIENT_SendTransComData() CLIENT_DestroyTransComChanne() 网络客户端 SDK 编程手册 第 11 页 共 94 页 E. 实时监视通道 打开监视通道 CLIENT_RealPlay() CLIENT_RealPlayEx() 保存监视图像数据 CLIENT_SaveRealData() 监视数据回调保存 CLIENT_SetRealDataCallBack() CLIENT_SetRealDataCallBac
18、kEx() 获取视频参数信息 CLIENT_ClientGetVideoEffect() 设置修改视频参数 CLIENT_ClientSetVideoEffect() 强制 I 帧 CLIENT_MakeKeyFrame() F. 多画面预览通道 打开多画面预览 CLIENT_MultiPlay() 停止多画面预览 CLIENT_StopMultiPlay() G. 回放/下载通道 查询录像 CLIENT_QueryRecordFile() 回放及控制 CLIENT_PlayBackByRecordFile() CLIENT_PlayBackByRecordFileEx() CLIENT_Pl
19、ayBackByTime() CLIENT_PlayBackByTimeEx() CLIENT_GetPlayBackOsdTime() CLIENT_PausePlayBack() CLIENT_SeekPlayBack() CLIENT_StopPlayBack() CLIENT_StepPlayBack() CLIENT_FastPlayBack() CLIENT_SlowPlayBack() CLIENT_GetFramePlayBack() CLIENT_SetFramePlayBack() 下载 CLIENT_DownloadByRecordFile() CLIENT_Downlo
20、adByRecordFileEx() CLIENT_DownloadByTime() CLIENT_StopDownload() CLIENT_GetDownloadPos() 网络客户端 SDK 编程手册 第 12 页 共 94 页 H. 针对显示图像的操作(监视/回放/多画面预览) 抓图 CLIENT_CapturePicture() 码流统计 CLIENT_GetStatiscFlux() 打开音频 CLIENT_OpenSound() 设置音量 CLIENT_SetVolume() I. 远程控制 远程升级 CLIENT_StartUpgrade CLIENT_SendUpgrade
21、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 中的功能大部分之间没有调用先后顺序,当然对
22、同一个功能还 是应该按先打开再操作最后关闭的顺序。 网络客户端 SDK 编程手册 第 13 页 共 94 页 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_
23、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,/ 左上 EX
24、TPTZ_RIGHTTOP ,/ 右上 EXTPTZ_LEFTDOWN ,/ 左下 EXTPTZ_RIGHTDOWN,/ 右下 EXTPTZ_ADDTOLOOP, / 加入预置点到巡航 巡航线路预置点值 EXTPTZ_DELFROMLOOP,/ 删除巡航中预置点 巡航线路预置点值 EXTPTZ_CLOSELOOP,/ 清除巡航 巡航线路 EXTPTZ_STARTPANCRUISE,/ 开始水平旋转 EXTPTZ_STOPPANCRUISE,/ 停止水平旋转 EXTPTZ_SETLEFTBORDER,/ 设置左边界 EXTPTZ_RIGHTBORDER , / 设置右边界 EXTPTZ_STAR
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 信息与通信 信息 通信 大华 网络 SDK 开发 手册
链接地址:https://www.31doc.com/p-1970500.html