I
NetSDK_JAVA编程指导手册
（智能楼宇分册）
V2.0.1
I
前言
概述
欢迎使用 NetSDK_JAVA（以下简称 SDK）编程指导手册。
SDK 是软件开发者在开发网络硬盘录像机、网络视频服务器、网络摄像机、网络球机和智能设备
等产品监控联网应用时的开发套件。
本文档描述了智能楼宇产品的通用业务涉及的 SDK 接口以及调用流程。
基础核心业务流程（例如初始化、登录、普通报警和智能报警等）详见《NetSDK 编程指导手册》。
本文档提供的示例代码仅为演示接口调用方法，不保证能直接拷贝编译。
读者对象
使用 SDK 的软件开发工程师、项目经理和产品经理。
符号约定
在本文档中可能出现下列标志，代表的含义如下。
符号 说明
表示能帮助您解决某个问题或节省您的时间。
表示是正文的附加信息，是对正文的强调和补充。
修订记录
版本号 修订内容 发布日期
V2.0.1 新增智能报警事件 2025.07
V2.0.0 前言补充 2025.02
V1.0.0 首次发布。 2023.12
II
名词解释
以下对本文档中使用的专业名词分别说明，帮助您更好的理解各个业务功能。
名词 说明
防区
报警输入通道可接收外部探测的信号，每一路报警输入通道即成为一个防
区。
布防和撤防
布防：设备已布防的防区处于警戒状态，接收外部信号、处理、记录和
转发。
撤防：设备已撤防的防区不会接收外部报警信号、也不会处理、记录和
转发。
旁路
在设备处于布防时，某个防区对外部探测器仍然监听，也会做记录，但不会
转发给用户。在设备撤防后，原来旁路的防区会转变成正常状态，当再次布
防时，该防区布防成功。
消警
设备发出报警后，通常会执行一些联动操作，比如蜂鸣、报警键盘提示等，
这些操作往往会持续一段时间，消警是使这些联动操作提前结束。
即时防区 在设备布防状态下，该防区触发报警时，立刻记录并转发报警信号。
延时防区
防区类型为延时防区时，可设置进入延时或者退出延时。
进入延时，即用户在延时时间内从非布防区域进入布防区域时产生报警，但
不联动报警，延时时间结束后，如果没撤防，此时会联动报警；如果撤防了，
就不会联动报警。设置退出延时后，设备会在退出延时结束后再进入布防状
态。
24 小时防区
一经配置成 24 小时防区，立即生效，且布撤防动作对其无效，可应用于火
警等场景。
情景模式
报警主机现有情景模式两种，分别为“外出模式”和“在家模式”，个模式
会有相关的配置，用户选择哪种情景模式，即可使相应配置生效。
在家模式 /外出
模式
当情景模式切换到“在家模式”或“外出模式”时，会使该情景模式下预设
的防区布防，其余防区变为旁路状态。
隔离
一种对入侵报警探测回路的设置，处于此状态的入侵报警探测回路不能通告
报警。此状态一直保持到人为复位。
模拟量报警通
道(模拟量防区)
设备有多个报警输入通道，接收外部探测的信号。通道类型为模拟量时，则
称为模拟量报警通道，可连接模拟量探测器，用于采集模拟量数据。
胁迫卡
门禁卡的一种，用户被胁迫时使用胁迫卡开门，门禁系统识别出是胁迫卡刷
卡，并发出报警信号。
III
目录
前言.............................................................................................................................................................. I
名词解释 ..................................................................................................................................................... II
第 1 章 产品概述 ...................................................................................................................................... 1
1.1 概述 .............................................................................................................................................. 1
1.2 适用性 ........................................................................................................................................... 1
1.2.1 适用系统 ............................................................................................................................. 1
1.2.2 支持设备 ............................................................................................................................. 2
1.3 应用场景 ....................................................................................................................................... 3
第 2 章 主要功能 ...................................................................................................................................... 7
2.1 通用 .............................................................................................................................................. 7
2.1.1 SDK 初始化 ......................................................................................................................... 7
2.1.2 设备登录 ........................................................................................................................... 10
2.2 门禁控制器/指纹一体机（一代） ................................................................................................ 13
2.2.1 门禁控制 ........................................................................................................................... 14
2.2.2 报警事件 ........................................................................................................................... 16
2.2.3 智能报警带图事件 ............................................................................................................ 21
2.2.4 设备信息查看 ................................................................................................................... 26
2.2.5 网络配置 ........................................................................................................................... 31
2.2.6 设备时间设置 ................................................................................................................... 35
2.2.7 人员管理 ........................................................................................................................... 38
2.2.8 门配置 .............................................................................................................................. 44
2.2.9 门时间配置 ....................................................................................................................... 47
2.2.10 门高级配置 ..................................................................................................................... 52
2.2.11 记录查询 ......................................................................................................................... 63
2.2.12 门禁事件 ......................................................................................................................... 70
2.2.13 人证比对事件 ................................................................................................................. 72
2.3 门禁控制器/人脸一体机（二代） ................................................................................................ 76
2.3.1 门禁控制 ........................................................................................................................... 76
2.3.2 报警事件 ........................................................................................................................... 76
2.3.3 智能报警带图事件 ............................................................................................................ 76
2.3.4 设备信息查看 ................................................................................................................... 76
2.3.5 网络配置 ........................................................................................................................... 83
2.3.6 设备时间设置 ................................................................................................................... 83
2.3.7 人员管理 ........................................................................................................................... 83
2.3.8 门配置 ............................................................................................................................ 104
2.3.9 门时间管理 ..................................................................................................................... 105
2.3.10 门高级配置 ................................................................................................................... 109
2.3.11 记录查询 ........................................................................................................................110
2.3.12 门禁事件 ........................................................................................................................ 111
2.3.13 人证比对事件 ................................................................................................................ 111
第 3 章 接口函数 ................................................................................................................................... 111
3.1 通用接口 .................................................................................................................................... 111
3.1.1 SDK 初始化 ...................................................................................................................... 111
IV
3.1.2 设备登录 ..........................................................................................................................112
3.1.3 设备控制 ..........................................................................................................................113
3.2 智能订阅 ....................................................................................................................................114
3.2.1 开始智能事件订阅 CLIENT_RealLoadPictureEx ............................................................114
3.2.2 停止智能事件订阅 CLIENT_StopLoadPic .......................................................................115
3.3 门禁控制器/指纹一体机（一代） ...............................................................................................116
3.3.1 门禁控制 ..........................................................................................................................116
3.3.2 设备信息查看 ..................................................................................................................116
3.3.3 网络配置 ..........................................................................................................................119
3.3.4 时间设置 ......................................................................................................................... 122
3.3.5 人员管理 ......................................................................................................................... 123
3.3.6 门配置 ............................................................................................................................ 123
3.3.7 门时间配置 ..................................................................................................................... 124
3.3.8 门高级配置 ..................................................................................................................... 125
3.3.9 记录查询 ......................................................................................................................... 128
3.4 门禁控制器/人脸一体机（二代） .............................................................................................. 129
3.4.1 门禁控制 ......................................................................................................................... 129
3.4.2 设备信息查看 ................................................................................................................. 130
3.4.3 网络配置 ......................................................................................................................... 130
3.4.4 时间设置 ......................................................................................................................... 130
3.4.5 人员管理 ......................................................................................................................... 131
3.4.6 门配置 ............................................................................................................................ 136
3.4.7 门时间配置 ..................................................................................................................... 137
3.4.8 门高级配置 ..................................................................................................................... 140
3.4.9 记录查询 ......................................................................................................................... 140
第 4 章 回调函数 .................................................................................................................................. 142
4.1 断线回调函数 fDisConnect ....................................................................................................... 142
4.2 断线重连回调函数 fHaveReConnect ........................................................................................ 142
4.3 实时预览数据回调函数 fRealDataCallBackEx2 ....................................................................... 143
4.4 音频数据回调函数 pfAudioDataCallBack ................................................................................. 143
4.5 报警回调函数 fMessCallBack ................................................................................................... 144
4.6 升级进度回调函数 fUpgradeCallBackEx .................................................................................. 147
4.7 智能事件回调函数 fAnalyzerDataCallBack ............................................................................. 148
法律声明 ..................................................................................................................................... 148
网络安全建议 .............................................................................................................................. 150
1
第 1 章 产品概述
1.1 概述
本文档主要介绍 SDK 接口参考信息，包括主要功能、接口函数和回调函数。
主要功能包括：通用功能、报警主机、门禁等功能。
根据环境不同，开发包包含的文件会不同，具体如下所示。
⚫ Windows 开发包所包含的文件如下：
表1-1 开发包包括的文件
库类型 库文件名称 库文件说明
功能库
dhnetsdk.h 头文件
dhnetsdk.dll 库文件
avnetsdk.dll 库文件
dhconfigsdk.h 头文件
dhconfigsdk.dll 库文件
播放（编码解码）辅助库
dhplay.dll 播放库
StreamConvertor.dll 转码库
⚫ Linux 开发包所包含的文件如下：
表1-2 开发包包括的文件
库类型 库文件名称 库文件说明
功能库
dhnetsdk.h 头文件
libdhnetsdk.so 库文件
libavnetsdk.so 库文件
dhconfigsdk.h 头文件
libdhconfigsdk.so 库文件
⚫ SDK 的功能库和配置库是必备库。
⚫ 功能库是设备网络 SDK 的主体，主要用于网络客户端与各类产品之间的通讯交互，负责远
程控制、查询、配置及码流数据的获取和处理等。
⚫ 配置库针对配置功能的结构体进行打包和解析。
⚫ 推荐使用播放库进行码流解析和播放。
⚫ 辅助库用于预览、回放、对讲等功能的音视频码流解码以及本地音频采集。
1.2 适用性
1.2.1 适用系统
⚫ 推荐内存：不低于 512 MB。
⚫ SDK 支持的系统：
Windows
Windows 10/Windows 8.1/Windows 7/vista/XP/2000 以及 Windows Server 2008/2003。
2
Linux
Red Hat/SUSE 等通用 Linux 系统。
1.2.2 支持设备
⚫ 门禁设备（一代设备）
DH-ASC1201C-D
DH-ASC1202B-D、DH-ASC1202B-S、DH-ASC1202C-D、DH-ASC1202C-S
DH-ASC1204B-S、DH-ASC1204C-D、DH-ASC1204C-S
DH-ASC1208C-S
DH-ASI1201A、DH-ASI1201A-D、DH-ASI1201E-D、DH-ASI1201E
DH-ASI1212A(V2)、DH-ASI1212A-C(V2)、DH-ASI1212A-D(V2)、DH-ASI1212D、
DH-ASI1212D-D
DHI-ASC1201B-D、DHI-ASC1201C-D
DHI-ASC1202B-D、DHI-ASC1202B-S、DHI-ASC1202C-D、DHI-ASC1202C-S
DHI-ASC1204B-S、DHI-ASC1204C-D、DHI-ASC1204C-S
DHI-ASC1208C-S
DHI-ASI1201A、DHI-ASI1201A-D、DHI-ASI1201E-D、DHI-ASI1201E
DHI-ASI1212A(V2)、DHI-ASI1212A-D(V2)、DHI-ASI1212D、DHI-ASI1212D-D
ASC1201B-D、ASC1201C-D
ASC1202B-S、ASC1202B-D、ASC1202C-S、ASC1202C-D
ASC1204B-S、ASC1204C-S、ASC1204C-D
ASC1208C-S
ASI1201A、ASI1201A-D、ASI1201E、ASI1201E-D
ASI1212A(V2)、ASI1212A-D(V2)、ASI1212D、ASI1212D-D
⚫ 门禁设备（二代设备）
DH-ASI4213Y
DH-ASI4214Y
DH-ASI7213X、DH-ASI7213X-C、DH-ASI7213Y、DH-ASI7213Y-V3
DH-ASI7214X、DH-ASI7214X-C、DH-ASI7214Y、DH-ASI7214Y-V3
DH-ASI7223X-A、DH-ASI7223Y-A、DH-ASI7223Y-A-V3
DH-ASI8213Y(V2)、DH-ASI8213Y-C(V2)、DH-ASI8213Y-V3
DH-ASI8214Y、DH-ASI8214Y(V2)、DH-ASI8214Y-C(V2)、DH-ASI8214Y-V3
DH-ASI8215Y、DH-ASI8215Y(V2)、DH-ASI8215Y-V3
DH-ASI8223Y(V2)、DH-ASI8223Y-A(V2)、DH-ASI8223Y、DH-ASI8233Y-A-V3
DHI-ASI1202M、DHI-ASI1202M-D
DHI-ASI4213Y、DHI-ASI4214Y
DHI-ASI7213X、DHI-ASI7213Y、DHI-ASI7213Y-D、DHI-ASI7213Y-V3
DHI-ASI7214X、DHI-ASI7214Y、DHI-ASI7214Y-D、DHI-ASI7214Y-V3
DHI-ASI7223X-A、DHI-ASI7223Y-A、DHI-ASI7223Y-A-V3
DHI-ASI8213Y-V3
DHI-ASI8214Y、DHI-ASI8214Y(V2)、DHI-ASI8214Y-V3
DHI-ASI8223Y、ASI8223Y(V2)、DHI-ASI8223Y-A(V2)、DHI-ASI8223Y-A-V3
ASI1202M、ASI1202M-D
ASI7213X、ASI7213Y-D、ASI7213Y-V3
ASI7214X、ASI7214Y、ASI7214Y-D、ASI7214Y-V3
ASI7223X-A、ASI7223Y-A、ASI7223Y-A-V3
3
ASI8213Y-V3
ASI8214Y、ASI8214Y(V2)、ASI8214Y-V3
ASI8223Y、ASI8223Y(V2)、ASI8223Y-A(V2)、ASI8223Y-A-V3
⚫ 可视对讲设备
VTA8111A
VTO1210B-X、VTO1210C-X
VTO1220B
VTO2000A、VTO2111D
VTO6210B、VTO6100C
VTO9231D、VTO9241D
VTH1510CH、VTH1510A、VTH1550CH
VTH5221D、VTH5241D
VTS1500A、VTS5420B、VTS8240B、VTS8420B
VTT201、VTT2610C
⚫ 报警主机
ARC2008C、ARC2008C-G、ARC2016C、ARC2016C-G、ARC5408C、ARC5408C-C、
ARC5808C、ARC5808C-C、ARC9016C、ARC9016C-G
DH-ARC2008C、DH-ARC2008C-G、DH-ARC2016C、DH-ARC2016C-G、
DH-ARC5408C、DH-ARC5408C-C、DH-ARC5408C-E、DH-ARC5808C、
DH-ARC5808C-C、DH-ARC5808C-E、DH-ARC9016C、DH-ARC9016C-G、
DHI-ARC2008C、DHI-ARC2008C-G、DHI-ARC2016C、DHI-ARC2016C-G、
DHI-ARC5808C、DHI-ARC5808C-C、DHI-ARC5408C、DHI-ARC5408C-C、
DHI-ARC9016C、DHI-ARC9016C-G、
ARC2008C、ARC2008C-G、ARC2016C、ARC2016C-G、ARC5408C、ARC5408C-C、
ARC5408C-E、ARC5808C-C、ARC5808C、ARC5808C-E、ARC9016C、ARC9016C-G
1.3 应用场景
⚫ 典型场景。
4
典型场景
⚫ 微型门禁适用于小型办公。
微型门禁
5
⚫ 网络型门禁适用于中小型以上智能楼宇项目及金库和监所项目。
网络型门禁
⚫ 增强型门禁。
6
增强型门禁
7
第 2 章 主要功能
2.1 通用
2.1.1 SDK 初始化
2.1.1.1 简介
初始化是 SDK 进行各种业务的第一步。初始化本身不包含监控业务，但会设置一些影响全局业
务的参数。
⚫ SDK 的初始化将会占用一定的内存。
⚫ 同一个进程内，只有第一次初始化有效。
⚫ 使用完毕后需要调用 CLIENT_Cleanup 释放资源。
2.1.1.2 接口总览
表2-1 SDK 初始化接口说明
接口 说明
CLIENT_Init SDK 初始化接口
CLIENT_Cleanup SDK 清理接口
CLIENT_SetAutoReconnect 设置断线重连回调接口
CLIENT_SetNetworkParam 设置登录网络环境接口
2.1.1.3 流程说明
SDK 初始化业务流程
8
流程说明
调用 CLIENT_Init 完成 SDK 初始化流程。
（可选）调用 CLIENT_SetAutoReconnect 设置断线重连回调函数，设置后 SDK 内部断
线自动重连。
（可选）调用 CLIENT_SetNetworkParam 设置网络登录参数，参数中包含登录设备超时
时间和尝试次数。
SDK 所有功能使用完后，调用 CLIENT_Cleanup 释放 SDK 资源。
注意事项
⚫ SDK 的 CLIENT_Init 和 CLIENT_Cleanup 接口需成对调用，支持单线程多次成对调用，但
建议全局调用一次。
⚫ 初始化：CLIENT_Init 接口内部多次调用时，仅在内部用做计数，不会重复申请资源。
⚫ 清理：CLIENT_Cleanup 接口内会清理所有已开启的业务，如登录、实时预览和报警订阅等。
⚫ 断线重连：SDK 可以设置断线重连功能，当遇到一些特殊情况（例如断网、断电等）设备断
线时，在 SDK 内部会定时持续不断地进行登录操作，直至成功登录设备。断线重连后可以
恢复实时预览和录像回放业务，其他业务无法恢复。
⚫ 加载动态库：如果加载动态库遇到报错如“Unable to load library
'./wrongpath/libs/win64/dhnetsdk': 找不到指定的模块”，通常是路径不匹配，需要根据报错
信息调整动态库的位置或者修改代码。此问题多见于打包整个工程为 jar 包提供给其他项目
时。由于此问题跟平台和工程使用方式相关，不能一概而论，需要具体分析。比如在 linux
平台下直接使用工程可以通过以下方式将动态库路径加载到动态库搜索路径中。
1.在终端输入：export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/XXX 当前终端生效。
2.修改~/.bashrc 或~/.bash_profile，最后一行添加 export
LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/XXX，保存之后，使用 source .bashrc 执行该
文件，当前用户生效。
3.修改/etc/profile，添加内容如第 2 条，同样保存后用 source 执行该文件，所有用户生效。
2.1.1.4 示例代码
/**
* 登录接口实现
* 主要有 ：初始化、登录、登出功能
*/
public class LoginModule {
public static NetSDKLib netsdk = NetSDKLib.NETSDK_INSTANCE;
public static NetSDKLib configsdk = NetSDKLib.CONFIG_INSTANCE;
// 登录句柄
public static LLong m_hLoginHandle = new LLong(0);
private static boolean bInit = false;
9
private static boolean bLogopen = false;
//初始化
public static boolean init(NetSDKLib.fDisConnect disConnect,
NetSDKLib.fHaveReConnect haveReConnect) {
bInit = netsdk.CLIENT_Init(disConnect, null);
if(!bInit) {
System.out.println("Initialize SDK failed");
return false;
}
//打开日志，可选
NetSDKLib.LOG_SET_PRINT_INFO setLog = new
NetSDKLib.LOG_SET_PRINT_INFO();
File path = new File("./sdklog/");
if (!path.exists()) {
path.mkdir();
}
String logPath = path.getAbsoluteFile().getParent() + "\\sdklog\\" + ToolKits.getDate()
+ ".log";
setLog.nPrintStrategy = 0;
setLog.bSetFilePath = 1;
System.arraycopy(logPath.getBytes(), 0, setLog.szLogFilePath, 0,
logPath.getBytes().length);
System.out.println(logPath);
setLog.bSetPrintStrategy = 1;
bLogopen = netsdk.CLIENT_LogOpen(setLog);
if(!bLogopen ) {
System.err.println("Failed to open NetSDK log");
}
// 设置断线重连回调接口，设置过断线重连成功回调函数后，当设备出现断线情况，SDK
内部会自动进行重连操作
// 此操作为可选操作，但建议用户进行设置
netsdk.CLIENT_SetAutoReconnect(haveReConnect, null);
//设置登录超时时间和尝试次数，可选
int waitTime = 5000; //登录请求响应超时时间设置为 5S
int tryTimes = 1; //登录时尝试建立链接 1 次
netsdk.CLIENT_SetConnectTime(waitTime, tryTimes);
10
// 设置更多网络参数，NET_PARAM 的 nWaittime， nConnectTryNum 成员与
CLIENT_SetConnectTime
// 接口设置的登录设备超时时间和尝试次数意义相同,可选
NetSDKLib.NET_PARAM netParam = new NetSDKLib.NET_PARAM();
netParam.nConnectTime = 10000; // 登录时尝试建立链接的超时时间
netParam.nGetConnInfoTime = 3000; // 设置子连接的超时时间
netsdk.CLIENT_SetNetworkParam(netParam);
return true;
}
//清除环境
public static void cleanup() {
if(bLogopen) {
netsdk.CLIENT_LogClose();
}
if(bInit) {
netsdk.CLIENT_Cleanup();
}
}
}
2.1.2 设备登录
2.1.2.1 简介
设备登录，即用户鉴权，是进行其他业务的前提。
用户登录设备产生唯一的登录 ID，其他功能的SDK接口需要传入登录 ID才可执行。登出设备后，
登录 ID 失效。
2.1.2.2 接口总览
表2-2 设备登录接口说明
接口 说明
CLIENT_LoginWithHig
hLevelSecurity
高安全级别登录接口。
CLINET_LoginEx2 仍然可以使用，但存在安全风险，所以强烈推荐
使用最新接口 CLIENT_LoginWithHighLevelSecurity 登录设备。
CLIENT_Logout 登出接口。
11
2.1.2.3 流程说明
登录业务流程
开始
SDK初始化
CLIENT_Init
登录设备
CLIENT_LoginWithHighLevelSecurity
具体业务
注销用户
CLIENT_Logout
释放SDK资源
CLIENT_Cleanup
结束
流程说明
调用 CLIENT_Init 完成 SDK 初始化流程。
调用 CLIENT_LoginWithHighLevelSecurity 登录设备。
登录成功后，用户可以实现需要的业务功能。
业务使用完后，调用 CLIENT_Logout 登出设备。
SDK 功能使用完后，调用 CLIENT_Cleanup 释放 SDK 资源。
注意事项
⚫ 登录句柄：登录成功时接口返回值非 0（即句柄可能小于 0，也属于登录成功）；同一设备登
录多次，每次的登录句柄不一样。如果无特殊业务，建议只登录一次，登录的句柄可以重复
用于其他各种业务。
⚫ 登出：接口内部会释放登录会话中已打开的业务，但建议用户不要依赖登出接口的清理功能。
例如打开预览后，在不需要使用预览时，用户应该调用结束预览的接口。
⚫ 登录与登出配对使用，登录会消耗一定的内存和 socket 信息，在登出后释放资源。
⚫ 登录失败：建议通过登录接口的 error 参数（登录错误码）初步排查。常见错误码如表 2-3
所示。
⚫ 多设备登录：SDK 初始化后，可以登录多台设备，但是相应的登录句柄、登录信息需要调整。
12
表2-3 常见错误码
error 错误码 对应的含义
1 密码不正确。
2 用户名不存在。
3 登录超时。
4 账号已登录。
5 账号已被锁定。
6 账号被列为禁止名单。
7 资源不足，设备系统忙。
8 子连接失败。
9 主连接失败。
10 超过最大用户连接数。
11 缺少 avnetsdk 或 avnetsdk 的依赖库。
12 设备未插入 U 盘或 U 盘信息错误。
13 客户端 IP 地址没有登录权限。
2.1.2.4 示例代码
public class LoginModule {
public static NetSDKLib netsdk = NetSDKLib.NETSDK_INSTANCE;
public static NetSDKLib configsdk = NetSDKLib.CONFIG_INSTANCE;
//SDK 初始化，SDK 清理省略
// 设备信息
public static NetSDKLib.NET_DEVICEINFO_Ex m_stDeviceInfo = new
NetSDKLib.NET_DEVICEINFO_Ex();
//登录句柄
public static LLong m_hLoginHandle = new LLong(0);
//登录设备
public static boolean login(String m_strIp, int m_nPort, String m_strUser, String
m_strPassword) {
//入参
NET_IN_LOGIN_WITH_HIGHLEVEL_SECURITY pstInParam=
new NET_IN_LOGIN_WITH_HIGHLEVEL_SECURITY();
pstInParam. szIP= m_strIp;
pstInParam.nport= m_nPort;
pstInParam.szUserName= m_strUser;
pstInParam.szPassword= m_strPassword;
13
//出参
NET_OUT_LOGIN_WITH_HIGHLEVEL_SECURITY pstOutParam=
new NET_OUT_LOGIN_WITH_HIGHLEVEL_SECURITY();
m_hLoginHandle =
netsdk.CLIENT_LoginWithHighLevelSecurity(NET_IN_LOGIN_WITH_HIGHLEVEL_SECURIT
Y pstInParam, NET_OUT_LOGIN_WITH_HIGHLEVEL_SECURITY pstOutParam);
if(m_hLoginHandle.longValue() == 0) {
System.err.printf("Login Device[%s] Port[%d]Failed. %s\n", m_strIp, m_nPort,
ToolKits.getErrorCodePrint());
} else {
System.out.println("Login Success ");
}
return m_hLoginHandle.longValue() == 0? false:true;
}
//登出设备
public static boolean logout() {
if(m_hLoginHandle.longValue() == 0) {
return false;
}
boolean bRet = netsdk.CLIENT_Logout(m_hLoginHandle);
if(bRet) {
m_hLoginHandle.setValue(0);
}
return bRet;
}
}
2.2 门禁控制器/指纹一体机（一代）
门禁控制器/指纹一体机（一代）功能调用关系
14
功能调用关系
添加人员
卡号
卡状态
卡密码
门
时间段
可用次数
有效开始日
有效结束日
是否首卡
时间段
假期记录集
常开时间段
常闭时间段
远程验证
门基础配置
门序
开门方式
门锁保持
关门超时
闯入报警
门超时报警
胁迫报警
胁迫
首卡开门
多人组合开门
多门互锁
防反潜
开门密码
门高级配置
门磁
开门时间段
门时间配置
引用
维护配置通用配置 记录查询
开门记录
日志
恢复出厂
设置
设备信息
网络
设备时间
修改密码
重启
配置重置
设备升级
自动维护
人员管理 门控配置
关联
引用
引用
引用
功能调用关系中引用和关联的含义如下：
⚫ 引用：箭头终点指向的功能引用箭头起点指向的功能。
⚫ 关联：箭头起始的功能是否能够正常使用，与箭头终点指向的功能配置相关。
2.2.1 门禁控制
2.2.1.1 简介
控制门禁的打开和关闭，获取门磁状态。不需要人员信息，直接远程控制门进行打开和关闭。
2.2.1.2 接口总览
表2-4 门禁控制接口说明
接口 说明
CLIENT_ControlDeviceEx 设备控制扩展接口。
CLIENT_QueryDevState 状态查询接口。
15
2.2.1.3 流程说明
门禁控制业务流程
开始
登录设备
CLIENT_LoginWithHighLevelSecurity
注销用户
CLIENT_Logout
释放SDK资源
CLIENT_Cleanup
结束
调用初始化接口
CLIENT_Init
门禁控制
CLIENT_ControlDeviceEx
emType为
CTRLTYPE_CTRL_ACCESS_OPEN/CTRLTYPE_CTRL_
ACCESS_CLOSE
门磁查询
CLIENT_QueryDevState
type为CTRLTYPE_DEVSTATE_DOOR_STATE
流程说明
调用 CLIENT_Init 函数，完成 SDK 初始化流程。
调用 CLIENT_LoginWithHighLevelSecurity 函数登录设备。
调用 CLIENT_ControlDeviceEx 函数来控制门禁。
⚫ 打开门禁：emType 值为 CTRLTYPE _CTRL_ACCESS_OPEN。
⚫ 关闭门禁：emType 值为 CTRLTYPE _CTRL_ACCESS_CLOSE。
业务实现，调用 CLIENT_QueryDevState 来实现门磁查询。
⚫ Type：CTRLTYPE _DEVSTATE_DOOR_STATE
⚫ pBuf：NET_DOOR_STATUS_INFO
业务执行完成之后，调用 CLIENT_Logout 函数登出设备。
SDK 功能使用完后，调用 CLIENT_Cleanup 函数释放 SDK 资源。
2.2.1.4 示例代码
/**
* 关门
*/
public void closeDoor() {
final NetSDKLib.NET_CTRL_ACCESS_CLOSE close = new
NetSDKLib.NET_CTRL_ACCESS_CLOSE();
close.nChannelID = 0; // 对应的门编号 - 如何开全部的门
close.write();
16
boolean result = netsdkApi.CLIENT_ControlDeviceEx(loginHandle,
NetSDKLib.CtrlType.CTRLTYPE_CTRL_ACCESS_CLOSE,
close.getPointer(),
null,
5000);
close.read();
if (!result) {
System.err.println("close error: 0x" + Long.toHexString(netsdkApi.CLIENT_GetLastError()));
}
}
/**
* 查询门（开、关）状态
*/
public void queryDoorStatus() {
int cmd = NetSDKLib.NET_DEVSTATE_DOOR_STATE;
NetSDKLib.NET_DOOR_STATUS_INFO doorStatus = new
NetSDKLib.NET_DOOR_STATUS_INFO();
IntByReference retLenByReference = new IntByReference(0);
doorStatus.write();
boolean bRet = netsdkApi.CLIENT_QueryDevState(loginHandle,
cmd,
doorStatus.getPointer(),
doorStatus.size(),
retLenByReference,
3000);
doorStatus.read();
if (!bRet) {
System.err.println("Failed to queryDoorStatus. Error Code 0x"
+ Integer.toHexString(netsdkApi.CLIENT_GetLastError()));
return;
}
String stateType[] = {"未知", "门打开", "门关闭", "门异常打开"};
System.out.println("doorStatus -> Channel: " + doorStatus.nChannel
+ " type: " + stateType[doorStatus.emStateType]);
}
2.2.2 报警事件
2.2.2.1 简介
事件获取，即用户调用 SDK 接口，SDK 主动连接设备，并向设备订阅事件，包括开门事件、报
警事件，设备发生事件立即发送给 SDK。若要停止接收设备事件，则需要停止订阅。
17
2.2.2.2 接口总览
表2-5 报警事件接口说明
接口 说明
CLIENT_StartListenEx 向设备订阅报警。
CLIENT_SetDVRMessCallBack
设置设备消息回调函数, 用来得到设备当前状态信息，与调
用顺序无关，SDK 默认不回调，此回调函数必须先调用报
警消息订阅接口 CLIENT_StartListen 或
CLIENT_StartListenEx 才有效。
CLIENT_StopListen 停止订阅。
2.2.2.3 流程说明
报警事件业务流程
开始
登录设备
CLIENT_LoginWithHighLevelSecurity
注销用户
CLIENT_Logout
释放SDK资源
CLIENT_Cleanup
结束
调用初始化接口
CLIENT_Init
向设备订阅事件信息
CLIENT_StartListenEx
停止订阅事件信息
CLIENT_StopListen
设置事件订阅回调函数
CLIENT_SetDVRMessCallBack
配置报警信息
18
流程说明
调用 CLIENT_Init 函数，完成 SDK 初始化流程。
调用 CLIENT_LoginWithHighLevelSecurity 函数登录设备。
进行报警布防配置（如果报警布防已经配置完成，则可省略）。
设置报警回调函数 CLIENT_SetDVRMessCallBack。
调用 CLIENT_StartListenEx 函数向设备订阅报警信息。
整个报警上传过程结束后还需要停止订阅报警接口 CLIENT_StopListen。
业务执行完成之后，调用 CLIENT_Logout 函数登出设备。
SDK 功能使用完后，调用 CLIENT_Cleanup 函数释放 SDK 资源。
2.2.2.4 示例代码
/**
* 订阅报警信息
*/
public void startListen() {
// 设置报警回调函数
netsdk.CLIENT_SetDVRMessCallBack(fAlarmDataCB.getCallBack(), null);
// 订阅报警
boolean bRet = netsdk.CLIENT_StartListenEx(m_hLoginHandle);
if (!bRet) {
System.err.println("订阅报警失败! LastError = 0x%x\n" + netsdk.CLIENT_GetLastError());
}
else {
System.out.println("订阅报警成功.");
}
}
/**
* 取消订阅报警信息
*/
public void stopListen() {
// 停止订阅报警
boolean bRet = netsdk.CLIENT_StopListen(m_hLoginHandle);
if (bRet) {
System.out.println("取消订阅报警信息.");
}
}
/**
* 报警信息回调函数原形,建议写成单例模式
*/
private static class fAlarmDataCB implements NetSDKLib.fMessCallBack{
private fAlarmDataCB(){}
19
private static class fAlarmDataCBHolder {
private static fAlarmDataCB callback = new fAlarmDataCB();
}
public static fAlarmDataCB getCallBack() {
return fAlarmDataCB.fAlarmDataCBHolder.callback;
}
public boolean invoke(int lCommand, NetSDKLib.LLong lLoginID, Pointer pStuEvent, int dwBufLen,
String strDeviceIP, NativeLong nDevicePort, Pointer dwUser){
switch (lCommand)
{
case NetSDKLib.NET_ALARM_TALKING_INVITE: { // 设备请求对方发起对讲事件(对
应结构体 ALARM_TALKING_INVITE_INFO)
System.out.println("设备请求对方发起对讲事件");
NetSDKLib.ALARM_TALKING_INVITE_INFO msg = new
NetSDKLib.ALARM_TALKING_INVITE_INFO();
ToolKits.GetPointerData(pStuEvent, msg);
System.out.println("emCaller :" + msg.emCaller);
System.out.println("szCallID :" + new String(msg.szCallID).trim());
System.out.println("nLevel :" + msg.nLevel);
/**
RealUTC 是否有效，bRealUTC 为 TRUE 时，用 RealUTC，否则用 stuTime 字段
*/
int bRealUTC
= msg.bRealUTC;
System.out.println("bRealUTC :" + bRealUTC);
if(bRealUTC==1){
System.out.println("RealUTC :" + msg.RealUTC.toStringTime());
}else {
System.out.println("stuTime :" + msg.stuTime.toStringTime());
}
NetSDKLib.TALKINGINVITE_REMOTEDEVICEINFO stuRemoteDeviceInfo
= msg.stuRemoteDeviceInfo;
int emProtocol = stuRemoteDeviceInfo.emProtocol;
System.out.println("emProtocol:" + emProtocol);
try {
System.out.println("szIP:" + new String(stuRemoteDeviceInfo.szIP,encode));
System.out.println("nPort:" + stuRemoteDeviceInfo.nPort);
20
System.out.println("szUser:" + new
String(stuRemoteDeviceInfo.szUser,encode));
System.out.println("szPassword:" + new
String(stuRemoteDeviceInfo.szPassword,encode));
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
break;
}
case NetSDKLib.NET_ALARM_TALKING_HANGUP :{ // 设备主动挂断对讲事件(对应结
构体 ALARM_TALKING_HANGUP_INFO)
System.out.println("设备主动挂断对讲事件");
ALARM_TALKING_HANGUP_INFO msg=new ALARM_TALKING_HANGUP_INFO();
ToolKits.GetPointerData(pStuEvent, msg);
try {
System.out.println("szRoomNo :" + new String(msg.szRoomNo,encode));
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
/**
RealUTC 是否有效，bRealUTC 为 TRUE 时，用 RealUTC，否则用 stuTime 字段
*/
int bRealUTC
= msg.bRealUTC;
System.out.println("bRealUTC :" + bRealUTC);
if(bRealUTC==1){
System.out.println("RealUTC :" + msg.RealUTC.toStringTime());
}else {
System.out.println("stuTime :" + msg.stuTime.toStringTime());
}
byte[] szCaller = msg.szCaller;
try {
System.out.println("szCaller :" + new String(szCaller,encode));
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
break;
21
}
default:
System.out.println("事件："+lCommand);
break;
}
return true;
}
}
2.2.3 智能报警带图事件
2.2.3.1 简介
智能订阅，即智能设备对实时码流进行分析，当检测到预先设定好的事件时，将事件发送给用户。
智能事件有交通违章、停车场有无车位等事件。
智能订阅实现方式为 SDK 主动连接设备，并向设备订阅智能事件功能，设备检测到智能事件立
即发送给 SDK。
当前支持的智能订阅事件参见 NetSDKLib.java 中以 EVENT_IVS_开头的常量，包含了常规的交
通占道、车辆违规等事件。
2.2.3.2 接口总览
表2-6 智能交通时间上报的接口信息
接口 说明
CLIENT_RealLoadPictureEx 订阅智能事件
CLIENT_StopLoadPic 取消订阅智能事件
fAnalyzerDataCallBack 用于回调获取智能事件的信息
2.2.3.3 流程说明
智能订阅事件上报流程如图 2-6 所示。
22
智能订阅事件上报业务流程
开始
调用初始化接口
CLIENT_Init
登录设备
CLIENT_LoginWithHighLevelSecurity
结束
释放SDK资源
CLIENT_Cleanup
注销用户
CLIENT_Logout
向设备订阅智能图片报警
CLIENT_RealLoadPictureEx
停止向设备订阅智能图片报警
CLIENT_StopLoadPic
fAnalyzerDataCallBack回调
获取智能事件信息
流程说明
调用 CLIENT_Init 函数完成 SDK 初始化流程。
初始化成功后，调用 CLIENT_LoginWithHighLevelSecurity 函数登录设备。
调用 CLIENT_RealLoadPictureEx 函数向设备订阅智能事件。
订阅成功后设备上报的智能交通事件通过 fAnalyzerDataCallBack 回调函数获取智能事
件并通知用户。
智能事件上报功能使用完毕后，调用 CLIENT_StopLoadPic 函数停止订阅智能事件。
业务使用完后，调用 CLIENT_Logout 函数登出设备。
SDK 功能使用完后，调用 CLIENT_Cleanup 函数释放 SDK 资源。
注意事项
⚫ 订阅事件类型：如果需要同时上报不同智能事件时，支持订阅所有智能事件
（EVENT_IVS_ALL）；也支持订阅单个智能事件。
⚫ 设置是否接收图片：由于某些设备所在网络环境是 3G 或 4G 网络，当 SDK 连接设备时，如
不需要接收图片可以把 CLIENT_ RealLoadPictureEx 接口中 bNeedPicFile 参数设置为
False，只接收智能交通事件信息，不带图片。
⚫ 通过通道号传-1 进行全通道订阅。部分智能交通类产品不支持全通道订阅。若传-1 订阅失败，
请尝试单通道订阅。
2.2.3.4 示例代码
//本实例将用门禁事件举例
//省略 SDK 初始化以及门禁设备登录
23
// 登录句柄
private NetSDKLib.LLong loginHandle = new NetSDKLib.LLong(0);
// 智能事件订阅句柄
private NetSDKLib.LLong m_attachHandle = new NetSDKLib.LLong(0);
// 监听
/**
* 订阅智能任务
*/
public void AttachEventRealLoadPic() {
// 先退订，设备不会对重复订阅作校验，重复订阅后会有重复的事件返回
this.DetachEventRealLoadPic();
// 需要图片
int bNeedPicture = 1;
//EVENT_IVS_ALL 表示订阅所有智能事件
m_attachHandle = netsdk.CLIENT_RealLoadPictureEx(loginHandle, channelId,
EVENT_IVS_ALL, bNeedPicture, AnalyzerDataCB.getInstance(), null, null);
/**
* // EVENT_IVS_WORKCLOTHES_DETECT 安全帽检测事件
* // EVENT_IVS_SMOKING_DETECT 吸烟检测事件
**/
if (m_attachHandle.longValue() != 0) {
System.out.printf("Chn[%d] CLIENT_RealLoadPictureEx Success\n", channelId);
} else {
System.out.printf("Ch[%d] CLIENT_RealLoadPictureEx Failed!LastError = %s\n",
channelId,
ToolKits.getErrorCode());
}
}
/**
* 报警事件（智能）回调
*/
private static class AnalyzerDataCB implements NetSDKLib.fAnalyzerDataCallBack {
private final File picturePath;
private static AnalyzerDataCB instance;
private AnalyzerDataCB() {
picturePath = new File("./AnalyzerPicture/");
if (!picturePath.exists()) {
24
picturePath.mkdirs();
}
}
public static AnalyzerDataCB getInstance() {
if (instance == null) {
synchronized (AnalyzerDataCB.class) {
if (instance == null) {
instance = new AnalyzerDataCB();
}
}
}
return instance;
}
@Override
public int invoke(NetSDKLib.LLong lAnalyzerHandle, int dwAlarmType, Pointer
pAlarmInfo, Pointer pBuffer, int dwBufSize,
Pointer dwUser, int nSequence, Pointer reserved) {
if (lAnalyzerHandle == null || lAnalyzerHandle.longValue() == 0) {
return -1;
}
switch (dwAlarmType) {
case EVENT_IVS_WORKCLOTHES_DETECT: // 安全帽检测事件
{
NetSDKLib.DEV_EVENT_WORKCLOTHES_DETECT_INFO msg =
new NetSDKLib.DEV_EVENT_WORKCLOTHES_DETECT_INFO();
ToolKits.GetPointerData(pAlarmInfo, msg);
if (msg.stuSceneImage != null && msg.stuSceneImage.nLength > 0) {
String bigPicture = picturePath + "\\" + System.currentTimeMillis() +
".jpg";
ToolKits.savePicture(pBuffer, msg.stuSceneImage.nOffSet,
msg.stuSceneImage.nLength, bigPicture);
if (msg.stuHumanImage != null && msg.stuHumanImage.nLength >
0) {
String smallPicture = picturePath + "\\" +
System.currentTimeMillis() + "small.jpg";
ToolKits.savePicture(pBuffer, msg.stuHumanImage.nOffSet,
msg.stuHumanImage.nLength, smallPicture);
}
25
}
System.out.println(" 安全帽检测事件(UTC)：" + msg.UTC + " 通道号:" +
msg.nChannelID);
break;
}
case NetSDKLib.EVENT_IVS_SMOKING_DETECT : { // 吸烟检测事件
(对应 DEV_EVENT_SMOKING_DETECT_INFO)
System.out.printf("吸烟检测事件");
DEV_EVENT_SMOKING_DETECT_INFO msg = new
DEV_EVENT_SMOKING_DETECT_INFO();
ToolKits.GetPointerData(pAlarmInfo, msg);
String Picture = picturePath + "\\" + "smoking_" +
System.currentTimeMillis() + ".jpg";
if (dwBufSize > 0) {
ToolKits.savePicture(pBuffer, msg.stuImageInfo[0].nOffset,
msg.stuImageInfo[0].nLength, Picture);
}
System.out.println("吸烟检测事件 时间(UTC)：" + msg.UTC + " 开始时
间:" + msg.stuObject.stuStartTime + " 结束时间:"
+ msg.stuObject.stuEndTime);
break;
}
case EVENT_IVS_GRANARY_TRANS_ACTION_DETECTION:{ //粮面异动
检测事件上报(对应 NET_DEV_EVENT_GRANARY_TRANS_ACTION_DETECTION_INFO)
System.out.println("粮面异动检测事件上报");
NET_DEV_EVENT_GRANARY_TRANS_ACTION_DETECTION_INFO
msg = new NET_DEV_EVENT_GRANARY_TRANS_ACTION_DETECTION_INFO();
ToolKits.GetPointerData(pAlarmInfo, msg);
System.out.println(" 粮面异动检测事件上报 时间 (stuUTC) ： " +
msg.stuUTC);
System.out.println("物体列表消息实际数量（nObjectsCount）： " +
msg.nObjectsCount);
break;
}
case EVENT_IVS_REGION_PROPORTION_DETECTION:{ // 区域占比检测
事件(对应 NET_DEV_EVENT_REGION_PROPORTION_DETECTION_INFO)
System.out.println("区域占比检测事件");
NET_DEV_EVENT_REGION_PROPORTION_DETECTION_INFO msg
= new NET_DEV_EVENT_REGION_PROPORTION_DETECTION_INFO();
ToolKits.GetPointerData(pAlarmInfo, msg);
System.out.println(" 区域占比检测事件上报 时间 (stuUTC) ： " +
26
msg.stuUTC);
System.out.println("物体列表消息实际数量（nObjectsCount）： " +
msg.nObjectsCount);
break;
}
default:
System.out.println("其他事件--------------------"+ dwAlarmType);
break;
}
return 0;
}
}
/**
* 停止侦听智能事件
*/
public void DetachEventRealLoadPic() {
if (m_attachHandle.longValue() != 0) {
netsdk.CLIENT_StopLoadPic(m_attachHandle);
System.out.println("CLIENT_StopLoadPic Success");
}
}
2.2.4 设备信息查看
2.2.4.1 能力集查询
2.2.4.1.1 简介
设备信息查看，即用户通过 SDK 下发命令给门禁设备，来获取设备的能力集。
2.2.4.1.2 接口总览
表2-7 能力集查询接口说明
接口 说明
CLIENT_QueryNewSystemInfo 查询系统能力信息（日志、记录集、门控能力等）。
CLIENT_ParseData 解析查询到的配置信息。
27
2.2.4.1.3 流程说明
设备信息查看流程
开始
登录设备
CLIENT_LoginWithHighLevelSecurity
注销用户
CLIENT_Logout
释放SDK资源
CLIENT_Cleanup
结束
调用初始化接口
CLIENT_Init
能力集查询
CLIENT_QueryNewSystemInfo
结合CLIENT_ParseData使用
门禁能力szCommand对应CFG_CAP_CMD_ACCESSCONTROLMANAGER
日志服务能力szCommand对应CFG_CAP_CMD_LOG
查询记录集能力szCommand对应CFG_CAP_CMD_RECORDFINDER
流程说明
调用 CLIENT_Init 函数，完成 SDK 初始化流程。
调用 CLIENT_LoginWithHighLevelSecurity 函数登录设备。
调用 CLIENT_QueryNewSystemInfo 函数，结合 CLIENT_ParseData，来查询门禁能力
集。
表2-8 szCommand 取值对应含义和结构体
szCommand 对应含义 szOutBuffer
CFG_CAP_CMD_ACCESSCONTR
OLMANAGER
门禁能力
CFG_CAP_ACCESSCON
TROL
CFG_CAP_CMD_LOG 获取日志服务能力 CFG_CAP_LOG
CFG_CAP_CMD_RECORDFINDER 获取查询记录集能力
CFG_CAP_RECORDFIN
DER_INFO
业务执行完成之后，调用 CLIENT_Logout 函数登出设备。
SDK 功能使用完后，调用 CLIENT_Cleanup 函数释放 SDK 资源。
2.2.4.1.4 示例代码
/**
* 优化 CLIENT_QueryNewSystemInfo 接口获取视频分析能力集
* 1. 结构体 CFG_CAP_ANALYSE_INFO 的字节长度 54874632,结构体构建对象和解析时非常耗时,采取
计算字节和偏移方式，获取对应字段信息
28
*/
public void queryNewSystemInfoOpt() {
//结构体 CFG_CAP_ANALYSE_INFO 的字节长度 54874632,结构体构建对象和解析时非常耗时，采
取计算字节和偏移方式，获取对应字段信息
//long len = new CFG_CAP_ANALYSE_INFO().size(); len = 54874632
byte[] data = new byte[54874632];
IntByReference error = new IntByReference(0);
boolean result = netsdk.CLIENT_QueryNewSystemInfo(m_hLoginHandle,
EM_NEW_QUERY_SYSTEM_INFO.CFG_CAP_CMD_VIDEOANALYSE.getValue(), 0, data,
data.length, error, 5000);
if (!result) {
System.out.println("query system info failed.error is" + ENUMERROR.getErrorMessage());
}
//解析能力信息
Pointer pointer = new Memory(data.length);
result =
configsdk.CLIENT_ParseData(EM_NEW_QUERY_SYSTEM_INFO.CFG_CAP_CMD_VIDEOANALYSE
.getValue(), data, pointer, data.length, null);
if (!result) {
System.out.println("parse system info failed.error is " + ENUMERROR.getErrorMessage());
}
CFG_CAP_ANALYSE_INFO_OPT info = new CFG_CAP_ANALYSE_INFO_OPT();
//结构体 CFG_CAP_ANALYSE_INFO 字段 nSupportedData 之前字节偏移 0,到字段 szSceneName
字节偏移 4100
info.getPointer().write(0, pointer.getByteArray(0, 4100), 0, info.size());
info.read();
System.out.println("支持场景个数:"+info.nSupportedSceneNum);
System.out.println("支持的场景列表:");// 枚举，参考@{ @link EM_SCENE_TYPE}
MaxNameByteArrInfo[] szSceneName = info.szSceneName;//判断是否具有枚举的值 FaceAnalysis
人脸分析
String value = EM_SCENE_TYPE.getNoteByValue(27);//value = FaceAnalysis 人脸分析
for (int i = 0; i < info.nSupportedSceneNum; i++) {
//System.out.println(new String(szSceneName[i].name).trim());
if(value.trim().equals(new String(szSceneName[i].name).trim())) {
System.out.println("IPC 有目标识别能");
}
}
}
2.2.4.2 设备版本、MAC 查看
2.2.4.2.1 简介
设备版本、MAC 查看，即用户通过 SDK 下发命令给门禁设备，来获取设备的序列号、版本号、
Mac 地址等内容。
29
2.2.4.2.2 接口总览
表2-9 设备版本和 MAC 查看接口说明
接口 说明
CLIENT_QueryDevState
查询设备状态（查询序列号、软件版本、编译时
间、Mac 地址）。
2.2.4.2.3 流程说明
设备信息查看业务流程
开始
登录设备
CLIENT_LoginWithHighLevelSecurity
注销用户
CLIENT_Logout
释放SDK资源
CLIENT_Cleanup
结束
调用初始化接口
CLIENT_Init
设备序列号、版本和mac
CLIENT_QueryDevState
序列号、版本nType：NET_DEVSTATE_SOFTWARE
Mac查看nType：NET_DEVSTATE_NETINTERFACE
流程说明
调用 CLIENT_Init 函数，完成 SDK 初始化流程。
调用 CLIENT_LoginWithHighLevelSecurity 函数登录设备。
调用 CLIENT_QueryDevState 函数，来查询门禁设备的序列号、版本和 mac 信息。
业务执行完成之后，调用 CLIENT_Logout 函数登出设备。
SDK 功能使用完后，调用 CLIENT_Cleanup 函数释放 SDK 资源。
2.2.4.2.4 示例代码
/**
* 获取设备软件版本
*
*/
public void QueryDevDeviceVersionStateTest() {
NetSDKLib.NETDEV_VERSION_INFO info = new NetSDKLib.NETDEV_VERSION_INFO();
info.write();
boolean bRet = netSdk.CLIENT_QueryDevState(loginHandle, NET_DEVSTATE_SOFTWARE,
info.getPointer(), info.size(), new IntByReference(0), 3000);
30
if (!bRet) {
System.err.println("QueryDevState DEV STATE of SOFTWARE failed: " +
ToolKits.getErrorCode());
return;
}
info.read();
System.out.println("QueryDevState DEV STATE of SOFTWARE succeed");
System.out.println("szSoftWareVersion 软件版本: " + new String(info.szSoftWareVersion).trim());
System.out.println("szDevSerialNo 序列号: " + new String(info.szDevSerialNo).trim());
int buildData = info.dwSoftwareBuildDate;
int day = buildData & 0xff;
buildData >>= 8;
int month = buildData & 0xff;
int year = buildData >> 8;
System.out.println("BuildData 编译日期: " + year + "-" + month + "-" + day);
}
/**
* 获取所有移动网络接口
*/
public void getNetAppMobileInterface() {
// 入参
NET_IN_NETAPP_GET_MOBILE_INTERFACE pstuIn = new
NET_IN_NETAPP_GET_MOBILE_INTERFACE();
// 出参
NET_OUT_NETAPP_GET_MOBILE_INTERFACE pstuOut = new
NET_OUT_NETAPP_GET_MOBILE_INTERFACE();
pstuIn.write();
pstuOut.write();
boolean bRet = netsdk.CLIENT_RPC_NetApp(m_hLoginHandle,
EM_RPC_NETAPP_TYPE.EM_PRC_NETAPP_TYPE_GET_MOBILE_INTERFACE.getId(),
pstuIn.getPointer(), pstuOut.getPointer(), 3000);
if(bRet) {
pstuOut.read();
System.out.println("网络接口有效个数:"+pstuOut.nInterfaceNum);
System.out.println("移动网络接口信息");
NETDEV_NETINTERFACE_INFO[] stuInterface = pstuOut.stuInterface;
for (int i = 0; i < pstuOut.nInterfaceNum; i++) {
int a = i+1;
System.out.println("-----第"+a+"个----");
System.out.println("是否有效:"+stuInterface[i].bValid);
try {
System.out.println("网口名称:"+new String(stuInterface[i].szName,encode));
System.out.println("实际 3G 支持的网络模式个
数:"+stuInterface[i].nSupportedModeNum);
31
SupportedModeByteArr[] szSupportedModes= stuInterface[i].szSupportedModes;
String prt = "";
for (int j = 0; j < stuInterface[i].nSupportedModeNum; j++) {
if(j == (stuInterface[i].nSupportedModeNum-1) ) {
prt += new String
(szSupportedModes[j].supportedModeByteArr,encode).trim();
}else {
prt += new String
(szSupportedModes[j].supportedModeByteArr,encode).trim() +"、";
}
}
System.out.println("3G 支持的网络模式:"+prt);
System.out.println("国际移动用户识别码:"+new String(stuInterface[i].szIMEI,encode));
System.out.println("集成电路卡识别码即 SIM 卡卡号:"+new
String(stuInterface[i].szICCID,encode));
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
}
} else {
System.err.println("getNetAppMobileInterface Failed!" + ToolKits.getErrorCode());
}
}
2.2.5 网络配置
2.2.5.1 IP 配置
2.2.5.1.1 简介
IP 配置，即用户通过调用 SDK 接口，对设备的 IP 等信息进行获取和配置，包含 IP 地址、子网
掩码、默认网关等信息。
2.2.5.1.2 接口总览
表2-10 IP 配置接口说明
接口 说明
CLIENT_GetNewDevConfig 查询配置信息
CLIENT_ParseData 解析查询到的配置信息
CLIENT_SetNewDevConfig 设置配置信息
CLIENT_PacketData 将需要设置的配置信息，打包成字符串格式
32
2.2.5.1.3 流程说明
IP 配置业务流程
开始
登录设备
CLIENT_LoginWithHighLevelSecurity
注销用户
CLIENT_Logout
释放SDK资源
CLIENT_Cleanup
结束
调用初始化接口
CLIENT_Init
门禁网络配置
获取：CLIENT_GetNewDevConfig
配合CLIENT_ParseData使用
IP设置的szCommand：CFG_CMD_NETWORK
门禁网络配置
设置：CLIENT_SetNewDevConfig
配合CLIENT_PacketData使用
IP设置的szCommand：CFG_CMD_NETWORK
流程说明
调用 CLIENT_Init 函数，完成 SDK 初始化流程。
调用 CLIENT_LoginWithHighLevelSecurity 函数登录设备。
调用 CLIENT_GetNewDevConfig 函数，结合 CLIENT_ParseData 来查询门禁 IP 网络
配置。
⚫ szCommand：CFG_CMD_NETWORK。
⚫ pBuf：CFG_NETWORK_INFO。
调用 CLIENT_SetNewDevConfig 函数，结合 CLIENT_PacketData 来设置门禁 IP 网络
配置。
⚫ szCommand：CFG_CMD_NETWORK。
⚫ pBuf：CFG_NETWORK_INFO。
业务执行完成之后，调用 CLIENT_Logout 函数登出设备。
SDK 功能使用完后，调用 CLIENT_Cleanup 函数释放 SDK 资源。
2.2.5.1.4 示例代码
// 网络配置
public void getSetNetWorkInfo() {
String command = NetSDKLib.CFG_CMD_NETWORK;
int channel = 0;
CFG_NETWORK_INFO network = new CFG_NETWORK_INFO();
// 获取
if (ToolKits.GetDevConfig(m_hLoginHandle, channel, command, network)) {
System.out.println("主机名称 : " + new String(network.szHostName).trim());
33
for (int i = 0; i < network.nInterfaceNum; i++) {
System.out.println("网络接口名称 : " + new String(network.stuInterfaces[i].szName).trim());
System.out.println("ip 地址 : " + new String(network.stuInterfaces[i].szIP).trim());
System.out.println("子网掩码 : " + new
String(network.stuInterfaces[i].szSubnetMask).trim());
System.out.println("默认网关 : " + new
String(network.stuInterfaces[i].szDefGateway).trim());
System.out.println(
"DNS 服务器地址 : " + new
String(network.stuInterfaces[i].szDnsServersArr[0].szDnsServers).trim()
+ "\n" + new
String(network.stuInterfaces[i].szDnsServersArr[1].szDnsServers).trim());
System.out.println("MAC 地址 : " + new
String(network.stuInterfaces[i].szMacAddress).trim());
}
if (ToolKits.SetDevConfig(m_hLoginHandle, channel, command, network)) {
System.out.println("Set NETWORK Succeed!");
} else {
System.err.println("Set NETWORK Failed!" + netsdk.CLIENT_GetLastError());
}
} else {
System.err.println("Get NETWORK Failed!" + netsdk.CLIENT_GetLastError());
}
}
2.2.5.2 主动注册配置
2.2.5.2.1 简介
主动注册配置，即用户通过调用 SDK 接口，对设备的主动注册信息进行配置，包括主动注册使
能、设备 ID、服务器信息等。
2.2.5.2.2 接口总览
表2-11 主动注册配置接口说明
接口 说明
CLIENT_GetNewDevConfig 查询配置信息。
CLIENT_ParseData 解析查询到的配置信息。
CLIENT_SetNewDevConfig 设置配置信息。
CLIENT_PacketData 将需要设置的配置信息，打包成字符串格式。
34
2.2.5.2.3 流程说明
主动注册配置业务流程
开始
登录设备
CLIENT_LoginWithHighLevelSecurity
注销用户
CLIENT_Logout
释放SDK资源
CLIENT_Cleanup
结束
调用初始化接口
CLIENT_Init
主动注册配置
获取：CLIENT_GetNewDevConfig
配合CLIENT_ParseData使用
主动注册设置的szCommand：CFG_CMD_DVRIP
主动注册配置
设置：CLIENT_SetNewDevConfig
配合CLIENT_PacketData使用
主动注册设置的szCommand：CFG_CMD_DVRIP
流程说明
调用 CLIENT_Init 函数，完成 SDK 初始化流程。
调用 CLIENT_LoginWithHighLevelSecurity 函数登录设备。
主动注册配置。
⚫ 调用 CLIENT_GetNewDevConfig 函数，结合 CLIENT_ParseData 来查询主动注册
配置。
szCommand：CFG_CMD_DVRIP。
pBuf：CFG_DVRIP_INFO。
⚫ 调用 CLIENT_SetNewDevConfig 函数，结合 CLIENT_PacketData 来设置主动注册
配置。
szCommand：CFG_CMD_DVRIP。
pBuf：CFG_DVRIP_INFO。
业务执行完成之后，调用 CLIENT_Logout 函数登出设备。
SDK 功能使用完后，调用 CLIENT_Cleanup 函数释放 SDK 资源。
2.2.5.2.4 示例代码
// 网络协议配置
public void getSetDVRIPInfo() {
String command = NetSDKLib.CFG_CMD_DVRIP;
int channel = 0;
CFG_DVRIP_INFO dvrIp = new CFG_DVRIP_INFO();
// 获取
if (ToolKits.GetDevConfig(m_hLoginHandle, channel, command, dvrIp)) {
35
System.out.println("TCP 服务端口 : " + dvrIp.nTcpPort);
System.out.println("SSL 服务端口 :" + dvrIp.nSSLPort);
System.out.println("UDP 服务端口 :" + dvrIp.nUDPPort);
System.out.println("组播端口号 :" + dvrIp.nMCASTPort);
// 设置，在获取的基础上设置
if (ToolKits.SetDevConfig(m_hLoginHandle, channel, command, dvrIp)) {
System.out.println("Set DVRIP Succeed!");
} else {
System.err.println("Set DVRIP Failed!" + netsdk.CLIENT_GetLastError());
}
} else {
System.err.println("Get DVRIP Failed!" + netsdk.CLIENT_GetLastError());
}
}
2.2.6 设备时间设置
2.2.6.1 设备时间设置
2.2.6.1.1 简介
设备时间设置，即用户通过调用 SDK 接口，对设备时间进行获取和设置的操作。
2.2.6.1.2 接口总览
表2-12 时间设置接口说明
接口 说明
CLIENT_SetupDeviceTime 设置设备当前时间。
36
2.2.6.1.3 流程说明
时间设置业务流程
开始
登录设备
CLIENT_LoginWithHighLevelSecurity
注销用户
CLIENT_Logout
释放SDK资源
CLIENT_Cleanup
结束
调用初始化接口
CLIENT_Init
时间时区设置
CLIENT_SetupDeviceTime
流程说明
调用 CLIENT_Init 函数，完成 SDK 初始化流程。
调用 CLIENT_LoginWithHighLevelSecurity 函数登录设备。
调用 CLIENT_SetupDeviceTime 函数来设置门禁时间信息。
业务执行完成之后，调用 CLIENT_Logout 函数登出设备。
SDK 功能使用完后，调用 CLIENT_Cleanup 函数释放 SDK 资源。
2.2.6.1.4 示例代码
/**
* 时间同步
*/
public void setupDeviceTime() {
SimpleDateFormat simpleDate = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
String date = simpleDate.format(new java.util.Date());
String[] dateTime = date.split(" ");
String[] mDate1 = dateTime[0].split("-");
String[] mDate2 = dateTime[1].split(":");
NetSDKLib.NET_TIME pDeviceTime = new NetSDKLib.NET_TIME();
pDeviceTime.dwYear = Integer.parseInt(mDate1[0]);
pDeviceTime.dwMonth = Integer.parseInt(mDate1[1]);
pDeviceTime.dwDay = Integer.parseInt(mDate1[2]);
pDeviceTime.dwHour = Integer.parseInt(mDate2[0]);
37
pDeviceTime.dwMinute = Integer.parseInt(mDate2[1]);
pDeviceTime.dwSecond = Integer.parseInt(mDate2[2]);
if(netsdkApi.CLIENT_SetupDeviceTime(loginHandle, pDeviceTime)) {
System.out.println("同步时间成功!");
} else {
System.out.println("同步时间失败" + ToolKits.getErrorCode());
}
}
2.2.6.2 NTP 服务器和时区配置
2.2.6.2.1 简介
NTP 服务器和时区配置，即用户通过调用 SDK 接口，对 NTP 服务器和时区进行获取和配置。
2.2.6.2.2 接口总览
表2-13 NTP 服务器和时区接口说明
接口 说明
CLIENT_GetNewDevConfig 查询配置信息。
CLIENT_ParseData 解析查询到的配置信息。
CLIENT_SetNewDevConfig 设置配置信息。
CLIENT_PacketData 将需要设置的配置信息，打包成字符串格式。
2.2.6.2.3 流程说明
NTP 校时业务流程
开始
登录设备
CLIENT_LoginWithHighLevelSecurity
注销用户
CLIENT_Logout
释放SDK资源
CLIENT_Cleanup
结束
调用初始化接口
CLIENT_Init
获取NTP校时配置、时区配置
CLIENT_GetNewDevConfig
配合CLIENT_ParseData使用
szCommand：CFG_CMD_NTP
设置NTP校时配置、时区配置
CLIENT_SetNewDevConfig
配合CLIENT_PacketData使用
szCommand：CFG_CMD_NTP
38
流程说明
调用 CLIENT_Init 函数，完成 SDK 初始化流程。
调用 CLIENT_LoginWithHighLevelSecurity 函数登录设备。
调用 CLIENT_GetNewDevConfig 函数，结合 CLIENT_ParseData 来查询门禁 NTP 校
时配置、时区配置。
⚫ szCommand：CFG_CMD_NTP。
⚫ pBuf：CFG_NTP_INFO。
调用 CLIENT_SetNewDevConfig 函数，结合 CLIENT_PacketData 来设置门禁 NTP 校
时配置、时区配置。
⚫ szCommand：CFG_CMD_NTP。
⚫ pBuf：CFG_NTP_INFO。
业务执行完成之后，调用 CLIENT_Logout 函数登出设备。
SDK 功能使用完后，调用 CLIENT_Cleanup 函数释放 SDK 资源。
2.2.6.2.4 示例代码
// 时区同步
public void SetNTP() {
NetSDKLib.CFG_NTP_INFO ntpInfo = new NetSDKLib.CFG_NTP_INFO();
if (ToolKits.GetDevConfig(loginHandle, -1, NetSDKLib.CFG_CMD_NTP, ntpInfo)) {
System.out.println("bEnable : " + ntpInfo.bEnable);
System.out.println("emTimeZoneType : " + ntpInfo.emTimeZoneType);
System.out.println("szTimeZoneDesc : " + new String(ntpInfo.szTimeZoneDesc).trim());
}
// 设置
ntpInfo.bEnable = 1;
ntpInfo.emTimeZoneType = NetSDKLib.EM_CFG_TIME_ZONE_TYPE.EM_CFG_TIME_ZONE_0;
if (ToolKits.SetDevConfig(loginHandle, -1, NetSDKLib.CFG_CMD_NTP, ntpInfo)) {
System.out.println("SetNTP Succeed!");
}
}
2.2.7 人员管理
2.2.7.1.1 简介
人员信息，即用户通过调用 SDK，可以对门禁设备的人员信息字段（包含：编号、姓名、人脸、
卡、指纹、密码、用户权限、时段、假日计划、用户类型等）进行增删查改的操作。
2.2.7.1.2 接口总览
表2-14 人员信息接口说明
接口 说明
CLIENT_ControlDevice 控制设备。
CLIENT_QueryDevState 查询设备状态。
39
2.2.7.1.3 流程说明
用户信息管理业务流程
开始
登录设备
CLIENT_LoginWithHighLevelSecurity
注销用户
CLIENT_Logout
释放SDK资源
CLIENT_Cleanup
结束
调用初始化接口
CLIENT_Init
门禁设备用户信息管理
CLIENT_ControlDevice
type添加：CTRLTYPE_CTRL_RECORDSET_INSERT
删除：CTRLTYPE_CTRL_RECORDSET_REMOVE
清空：CTRLTYPE_CTRL_RECORDSET_CLEAR
获取用户信息：CLIENT_QueryDevState
ntYpe：CTRLTYPE_DEVSTATE_DEV_RECORDSET
门禁设备用户信息更新
CLIENT_ControlDevice
Type：CTRLTYPE_CTRL_RECORDSET_UPDATE
流程说明
调用 CLIENT_Init 函数，完成 SDK 初始化流程。
调用 CLIENT_LoginWithHighLevelSecurity 函数登录设备。
调用 CLIENT_ControlDevice 函数来对用户信息进行操作。
表2-15 type 对应含义和结构体
Type 对应含义 emType Param
CTRLTYPE_CTRL_R
ECORDSET_INSER
T
CTRLTYPE_CTRL_R
ECORDSET_INSER
TEX
添加用户信
息
NET_RECORD
_ACCESSCTL
CARD
NET_CTRL_RECORDSE
T_INSERT_PARAM
NET_RECORDSET_ACC
ESS_CTL_CARD
CTRLTYPE_CTRL_REC
ORDSET_REMOVE
删除用户信
息
NET_RECORD
_ACCESSCTL
CARD
NET_CTRL_RECORDSE
T_PARAM
NET_RECORDSET_ACC
ESS_CTL_CARD
CTRLTYPE_CTRL_REC
ORDSET_CLEAR
清空用户信
息
NET_RECORD
_ACCESSCTL
CARD
NET_CTRL_RECORDSET_PA
RAM
先调用 CLIENT_QueryDevState 接口来获取用户信息。
40
表2-16 type 对应含义和结构体
Type 对应含义 emType Param
NET_DEVSTATE_DEV_
RECORDSET
获取用 户
信息
NET_RECORD_
ACCESSCTLCA
RD
NET_CTRL_RECORDSET_P
ARAM
NET_RECORDSET_ACCESS
_CTL_CARD
再调用 CLIENT_ControlDevice 函数更新用户信息。
表2-17 type 对应含义和结构体
Type 对应含义 emType Param
CTRLTYPE_CTRL_R
ECORDSET_UPDAT
E
CTRLTYPE_CTRL_R
ECORDSET_UPDAT
EEX
更新用户信
息
NET_RECOR
D_ACCESSCT
LCARD
NET_CTRL_RECORDSE
T_PARAM
NET_RECORDSET_AC
CESS_CTL_CARD
业务执行完成之后，调用 CLIENT_Logout 函数登出设备。
SDK 功能使用完后，调用 CLIENT_Cleanup 函数释放 SDK 资源。
2.2.7.1.4 注意事项
⚫ 卡号：人员卡号。
⚫ 卡类型：当设置为胁迫卡时，与卡绑定的人员通过卡密码、开门密码、指纹开门时，会触发
胁迫报警 。
⚫ 卡密码：此密码适用于卡+密码开门模式。
⚫ 时间段：选择配置时间段对应序号。如果未设置序号，请到“时间段”配置中进行配置，具体
方法请参见“2.2.9.1 时段配置”。
⚫ 开门密码：设置此密码后，无需刷卡直接输入密码即可开门，详细介绍请参见“2.2.10.4 开
门密码”。
⚫ 有效次数：仅来宾用户支持设置此字段。
⚫ 是否为首卡：根据实际情况选择。首卡信息的配置方法，请参见“2.2.10.1 分时段、首卡开
门”。
2.2.7.1.5 示例代码
/**
* 插入密码
*/
public void insertPassword() {
// 密码的编号, 支持 500 个, 不重复
final String userId = "1";
// 开门密码
final String openDoorPassword = "888887";
NetSDKLib.NET_RECORDSET_ACCESS_CTL_PWD accessInsert = new
NetSDKLib.NET_RECORDSET_ACCESS_CTL_PWD();
41
System.arraycopy(userId.getBytes(), 0, accessInsert.szUserID,
0, userId.getBytes().length);
System.arraycopy(openDoorPassword.getBytes(), 0, accessInsert.szDoorOpenPwd,
0, openDoorPassword.getBytes().length);
/// 以下字段可以固定, 目前设备做了限制必须要带
accessInsert.nDoorNum = 2; // 门个数 表示双门控制器
accessInsert.sznDoors[0] = 0; // 表示第一个门有权限
accessInsert.sznDoors[1] = 1; // 表示第二个门有权限
accessInsert.nTimeSectionNum = 2; // 与门数对应
accessInsert.nTimeSectionIndex[0] = 255; // 表示第一个门全天有效
accessInsert.nTimeSectionIndex[1] = 255; // 表示第二个门全天有效
NetSDKLib.NET_CTRL_RECORDSET_INSERT_PARAM insert = new
NetSDKLib.NET_CTRL_RECORDSET_INSERT_PARAM();
insert.stuCtrlRecordSetInfo.emType =
NetSDKLib.EM_NET_RECORD_TYPE.NET_RECORD_ACCESSCTLPWD; // 记录集信息类型
insert.stuCtrlRecordSetInfo.pBuf = accessInsert.getPointer();
accessInsert.write();
insert.write();
boolean success = netSdk.CLIENT_ControlDevice(loginHandle,
NetSDKLib.CtrlType.CTRLTYPE_CTRL_RECORDSET_INSERT, insert.getPointer(),
5000);
insert.read();
accessInsert.read();
if(!success) {
System.err.println("insert password failed. 0x" +
Long.toHexString(netSdk.CLIENT_GetLastError()));
return;
}
System.out.println("Password nRecNo : " + insert.stuCtrlRecordSetResult.nRecNo);
passwordRecordNo = insert.stuCtrlRecordSetResult.nRecNo;
}
/**
* 更新密码
*/
public void updatePassword() {
NetSDKLib.NET_RECORDSET_ACCESS_CTL_PWD accessUpdate = new
NetSDKLib.NET_RECORDSET_ACCESS_CTL_PWD();
accessUpdate.nRecNo = passwordRecordNo; // 需要修改的记录集编号,由插入获得
/// 密码编号, 必填否则更新密码不起作用
42
final String userId = String.valueOf(accessUpdate.nRecNo);
System.arraycopy(userId.getBytes(), 0, accessUpdate.szUserID,
0, userId.getBytes().length);
// 新的开门密码
final String newPassord = "333333";
System.arraycopy(newPassord.getBytes(), 0,
accessUpdate.szDoorOpenPwd, 0, newPassord.getBytes().length);
/// 以下字段可以固定, 目前设备做了限制必须要带
accessUpdate.nDoorNum = 2; // 门个数 表示双门控制器
accessUpdate.sznDoors[0] = 0; // 表示第一个门有权限
accessUpdate.sznDoors[1] = 1; // 表示第二个门有权限
accessUpdate.nTimeSectionNum = 2; // 与门数对应
accessUpdate.nTimeSectionIndex[0] = 255; // 表示第一个门全天有效
accessUpdate.nTimeSectionIndex[1] = 255; // 表示第二个门全天有效
NetSDKLib.NET_CTRL_RECORDSET_PARAM update = new
NetSDKLib.NET_CTRL_RECORDSET_PARAM();
update.emType = NetSDKLib.EM_NET_RECORD_TYPE.NET_RECORD_ACCESSCTLPWD;
// 记录集信息类型
update.pBuf = accessUpdate.getPointer();
accessUpdate.write();
update.write();
boolean result = netSdk.CLIENT_ControlDevice(loginHandle,
NetSDKLib.CtrlType.CTRLTYPE_CTRL_RECORDSET_UPDATE, update.getPointer(),
5000);
update.read();
accessUpdate.read();
if (!result) {
System.err.println("update password failed. 0x" +
Long.toHexString(netSdk.CLIENT_GetLastError()));
}else {
System.out.println("update password success");
}
}
/**
* 全部删除
*/
public void alldeleteOperate() {
int type = NetSDKLib.CtrlType.CTRLTYPE_CTRL_RECORDSET_CLEAR;
NetSDKLib.NET_CTRL_RECORDSET_PARAM param = new
NetSDKLib.NET_CTRL_RECORDSET_PARAM();
if (flg) {
param.emType = NetSDKLib.EM_NET_RECORD_TYPE.NET_RECORD_TRAFFICREDLIST;
43
} else {
param.emType =
NetSDKLib.EM_NET_RECORD_TYPE.NET_RECORD_TRAFFICBLACKLIST;
}
param.write();
boolean zRet = netsdk.CLIENT_ControlDevice(m_hLoginHandle, type, param.getPointer(), 5000);
if (zRet) {
System.out.println("全部删除成功");
} else {
System.err.println("全部删除失败" + String.format("0x%x", netsdk.CLIENT_GetLastError()));
}
}
public static boolean queryRecordState(SdkStructure condition) {
int emType = getRecordType(condition);
if (emType == EM_NET_RECORD_TYPE.NET_RECORD_UNKNOWN) {
System.err.println("the input query condition SdkStructure [" + condition.getClass() + "]
invalid!");
return false;
}
NetSDKLib.NET_CTRL_RECORDSET_PARAM record = new
NetSDKLib.NET_CTRL_RECORDSET_PARAM();
record.emType = emType;
record.pBuf = condition.getPointer();
IntByReference intRetLen = new IntByReference();
condition.write();
record.write();
if (!netsdkApi.CLIENT_QueryDevState(loginHandle,
NetSDKLib.NET_DEVSTATE_DEV_RECORDSET,
record.getPointer(), record.size(), intRetLen, 3000)) {
return false;
}
record.read();
condition.read();
output(condition);
return true;
}
private static void output(SdkStructure record) { // 具体输出在上层定义
if (record instanceof NET_RECORDSET_ACCESS_CTL_CARDREC) {
44
printRecord((NET_RECORDSET_ACCESS_CTL_CARDREC)record);
}else if(record instanceof NET_RECORDSET_ACCESS_CTL_CARD) {
printRecord((NET_RECORDSET_ACCESS_CTL_CARD)record);
}
}
public static int getRecordNo() {
return nRecordNo;
}
private static int getRecordType(SdkStructure object) {
int type = EM_NET_RECORD_TYPE.NET_RECORD_UNKNOWN;
if (object instanceof NET_RECORDSET_ACCESS_CTL_CARD
|| object instanceof FIND_RECORD_ACCESSCTLCARD_CONDITION) {
type = EM_NET_RECORD_TYPE.NET_RECORD_ACCESSCTLCARD;
}else if (object instanceof NET_RECORD_ACCESSQRCODE_INFO) {
type = EM_NET_RECORD_TYPE.NET_RECORD_ACCESSQRCODE;
}else if (object instanceof NET_RECORDSET_ACCESS_CTL_PWD) {
type = EM_NET_RECORD_TYPE.NET_RECORD_ACCESSCTLPWD;
}else if (object instanceof NET_RECORDSET_ACCESS_CTL_CARDREC
|| object instanceof FIND_RECORD_ACCESSCTLCARDREC_CONDITION_EX) {
type = EM_NET_RECORD_TYPE.NET_RECORD_ACCESSCTLCARDREC_EX;
}
return type;
}
}
2.2.8 门配置
2.2.8.1 简介
门配置信息，即用户通过调用 SDK 接口，对门禁设备的门配置进行获取和设置的操作，包括开
45
门模式、门锁保持时间、关门超时时长、假期时间段编号、开门时间段及报警使能项等。
2.2.8.2 接口总览
表2-18 门配置信息接口说明
接口 说明
CLIENT_GetNewDevConfig 查询配置信息。
CLIENT_ParseData 解析查询到的配置信息。
CLIENT_SetNewDevConfig 设置配置信息。
CLIENT_PacketData 将需要设置的配置信息，打包成字符串格式。
2.2.8.3 流程说明
门配置信息业务流程
开始
登录设备
CLIENT_LoginWithHighLevelSecurity
注销用户
CLIENT_Logout
释放SDK资源
CLIENT_Cleanup
结束
调用初始化接口
CLIENT_Init
获取：CLIENT_GetNewDevConfig
配合CLIENT_ParseData使用
szCommand：CFG_CMD_ACCESS_EVENT
设置：CLIENT_SetNewDevConfig
配合CLIENT_PacketData使用
szCommand：CFG_CMD_ACCESS_EVENT
流程说明
调用 CLIENT_Init 函数，完成 SDK 初始化流程。
调用 CLIENT_LoginWithHighLevelSecurity 函数登录设备。
调用 CLIENT_GetNewDevConfig 函数，结合 CLIENT_ParseData 来查询门禁门配置信
息。
⚫ szCommand：CFG_CMD_ACCESS_EVENT。
⚫ pBuf：CFG_ACCESS_EVENT_INFO。
表2-19 CFG_ACCESS_EVENT_INFO 参数说明
CFG_ACCESS_EVENT_INFO 参数 对应含义
emState 门状态
nUnlockHoldInterval 开门时长
46
CFG_ACCESS_EVENT_INFO 参数 对应含义
nCloseTimeout 关门超时时长
emDoorOpenMethod 开门模式
bDuressAlarmEnable 胁迫
bBreakInAlarmEnable 闯入报警使能
bRepeatEnterAlarm 重复进入报警使能
abDoorNotClosedAlarmEnable 互锁报警使能
abSensorEnable 门磁使能
调用 CLIENT_SetNewDevConfig 函数，结合 CLIENT_PacketData 来设置门禁门配置信
息。
⚫ szCommand：CFG_CMD_ACCESS_EVENT。
⚫ pBuf：CFG_ACCESS_EVENT_INFO。
表2-20 CFG_ACCESS_EVENT_INFO 参数说明
CFG_ACCESS_EVENT_INFO 参数 对应含义
emState 门状态
nUnlockHoldInterval 开门时长
nCloseTimeout 关门超时时长
emDoorOpenMethod 开门模式
bDuressAlarmEnable 胁迫
bBreakInAlarmEnable 闯入报警使能
bRepeatEnterAlarm 重复进入报警使能
abDoorNotClosedAlarmEnable 互锁报警使能
abSensorEnable 门磁使能
业务执行完成之后，调用 CLIENT_Logout 函数登出设备。
SDK 功能使用完后，调用 CLIENT_Cleanup 函数释放 SDK 资源。
2.2.8.4 注意事项
⚫ 开启闯入报警、门未关报警功能时，需要同时开启门磁功能，才能实现闯入报警、门未关报
警功能。
⚫ 常开、常闭、远程验证引用的序号，通过“时间段”进行设置，具体设置方法请参见“2.2.9.1
时段配置”。
2.2.8.5 示例代码
// 门禁事件配置
public void AccessConfig() {
// 获取
String szCommand = NetSDKLib.CFG_CMD_ACCESS_EVENT;
int nChn = 0; // 通道
CFG_ACCESS_EVENT_INFO access = new CFG_ACCESS_EVENT_INFO(); //
m_stDeviceInfo.byChanNum 为设备通道数
if (ToolKits.GetDevConfig(loginHandle, nChn, szCommand, access)) {
System.out.println("门禁通道名称:" + new String(access.szChannelName).trim());
System.out.println("首卡使能:" + access.stuFirstEnterInfo.bEnable); // 0-false; 1-true
47
System.out.println("首卡权限验证通过后的门禁状态:" + access.stuFirstEnterInfo.emStatus); //
状态参考枚举 CFG_ACCESS_FIRSTENTER_STATUS
System.out.println("需要首卡验证的时间段, 值为通道号:" +
access.stuFirstEnterInfo.nTimeIndex);
}
// 设置
boolean bRet = ToolKits.SetDevConfig(loginHandle, nChn, szCommand, access);
if (bRet) {
System.out.println("Set Succeed!");
}
}
2.2.9 门时间配置
2.2.9.1 时段配置
2.2.9.1.1 简介
时段配置信息，即用户通过调用 SDK 接口，对门禁设备的门时间段进行获取和设置的操作。此
模板的配置不能直接对设备生效，需要被其他功能模块调用。
2.2.9.1.2 接口总览
表2-21 时段接口说明
接口 说明
CLIENT_GetNewDevConfig 查询配置信息。
CLIENT_ParseData 解析查询到的配置信息。
CLIENT_SetNewDevConfig 设置配置信息。
CLIENT_PacketData 将需要设置的配置信息，打包成字符串格式。
48
2.2.9.1.3 流程说明
时段业务配置流程
开始
登录设备
CLIENT_LoginWithHighLevelSecurity
注销用户
CLIENT_Logout
释放SDK资源
CLIENT_Cleanup
结束
调用初始化接口
CLIENT_Init
时段配置
获取：CLIENT_GetNewDevConfig
配合CLIENT_ParseData使用
szCommand：CFG_CMD_ACCESSTIMESCHEDULE
时段配置
设置：CLIENT_SetNewDevConfig
配合CLIENT_PacketData使用
szCommand：CFG_CMD_ACCESSTIMESCHEDULE
流程说明
调用 CLIENT_Init 函数，完成 SDK 初始化流程。
调用 CLIENT_LoginWithHighLevelSecurity 函数登录设备。
调用CLIENT_GetNewDevConfig 函数，结合CLIENT_ParseData 来查询门禁时段信息。
⚫ szCommand：CFG_CMD_ACCESSTIMESCHEDULE。
⚫ pBuf：CFG_ACCESS_TIMESCHEDULE_INFO。
调用CLIENT_SetNewDevConfig函数，结合CLIENT_PacketData来设置门禁时段信息。
⚫ szCommand：CFG_CMD_ACCESSTIMESCHEDULE。
⚫ pBuf：CFG_ACCESS_TIMESCHEDULE_INFO。
业务执行完成之后，调用 CLIENT_Logout 函数登出设备。
SDK 功能使用完后，调用 CLIENT_Cleanup 函数释放 SDK 资源。
2.2.9.1.4 示例代码
/**
* 门禁刷卡时间段设置
*/
public void setAccessTimeSchedule() {
CFG_ACCESS_TIMESCHEDULE_INFO msg = new CFG_ACCESS_TIMESCHEDULE_INFO();
String strCmd = NetSDKLib.CFG_CMD_ACCESSTIMESCHEDULE;
int nChannel = 120; // 通道号
// 获取
if(ToolKits.GetDevConfig(loginHandle, nChannel, strCmd, msg)) {
System.out.println("Enable:" + msg.bEnable);
49
try {
System.out.println("自定义名称:" + new String(msg.szName, "GBK").trim());
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
for(int i = 0; i < 7; i++) {
for(int j = 0; j < 4; j++) {
System.out.println("dwRecordMask:" +
msg.stuTimeWeekDay[i].stuTimeSection[j].dwRecordMask);
System.out.println(msg.stuTimeWeekDay[i].stuTimeSection[j].startTime() + "-" +
msg.stuTimeWeekDay[i].stuTimeSection[j].endTime() + "\n");
}
}
// 设置
if(ToolKits.SetDevConfig(loginHandle, nChannel, strCmd, msg)) {
System.out.println("Set AccessTimeSchedule Succeed!");
} else {
System.err.println("Set AccessTimeSchedule Failed!" + ToolKits.getErrorCode());
}
} else {
System.err.println("Get AccessTimeSchedule Failed!" + ToolKits.getErrorCode());
}
}
2.2.9.2 常开常闭时间段配置
2.2.9.2.1 简介
常开常闭时间段配置，即用户通过调用 SDK 接口，对门禁设备的时间段配置进行获取和设置的
操作，这里包括常开/常闭时段配置、远程验证时间段配置等信息
2.2.9.2.2 接口总览
表2-22 常开常闭时间段配置接口说明
接口 说明
CLIENT_GetNewDevConfig 查询配置信息。
CLIENT_ParseData 解析查询到的配置信息。
CLIENT_SetNewDevConfig 设置配置信息。
CLIENT_PacketData 将需要设置的配置信息，打包成字符串格式。
50
2.2.9.2.3 流程说明
常开常闭时间段配置流程
开始
登录设备
CLIENT_LoginWithHighLevelSecurity
注销用户
CLIENT_Logout
释放SDK资源
CLIENT_Cleanup
结束
调用初始化接口
CLIENT_Init
常开常闭时段以及远程验证时间段配置
获取：CLIENT_GetNewDevConfig
配合CLIENT_ParseData使用
szCommand：CFG_CMD_ACCESS_EVENT
常开常闭时段以及远程验证时间段配置
设置：CLIENT_SetNewDevConfig
配合CLIENT_PacketData使用
szCommand：CFG_CMD_ACCESS_EVENT
流程说明
调用 CLIENT_Init 函数，完成 SDK 初始化流程。
调用 CLIENT_LoginWithHighLevelSecurity 函数登录设备。
调用 CLIENT_GetNewDevConfig 函数，结合 CLIENT_ParseData 来查询门禁常开常闭
时段配置信息以及远程验证时间段。
⚫ szCommand：CFG_CMD_ACCESS_EVENT。
⚫ pBuf：CFG_ACCESS_EVENT_INFO。
表2-23 CFG_ACCESS_EVENT_INFO 参数说明
CFG_ACCESS_EVENT_INFO 参数 对应含义
nOpenAlwaysTimeIndex 常开时间段配置
nCloseAlwaysTimeIndex 常闭时间段配置
stuAutoRemoteCheck 远程验证时间段
调用 CLIENT_SetNewDevConfig 函数，结合 CLIENT_PacketData 来设置门禁常开常闭
时段配置信息以及远程验证时间段。
⚫ szCommand：CFG_CMD_ACCESS_EVENT。
⚫ pBuf：CFG_ACCESS_EVENT_INFO。
表2-24 CFG_ACCESS_EVENT_INFO 参数说明
CFG_ACCESS_EVENT_INFO 参数 对应含义
nOpenAlwaysTimeIndex 常开时间段配置
nCloseAlwaysTimeIndex 常闭时间段配置
stuAutoRemoteCheck 远程验证时间段
业务执行完成之后，调用 CLIENT_Logout 函数登出设备。
SDK 功能使用完后，调用 CLIENT_Cleanup 函数释放 SDK 资源。
51
2.2.9.2.4 注意事项
常开、常闭、远程验证引用的序号，通过“时间段”进行设置，具体设置方法请参见“2.2.9.1
时段配置”。
2.2.9.2.5 示例代码
/**
* 门禁刷卡时间段设置
*/
public void setAccessTimeSchedule() {
CFG_ACCESS_TIMESCHEDULE_INFO msg = new CFG_ACCESS_TIMESCHEDULE_INFO();
String strCmd = NetSDKLib.CFG_CMD_ACCESSTIMESCHEDULE;
int nChannel = 120; // 通道号
// 获取
if(ToolKits.GetDevConfig(loginHandle, nChannel, strCmd, msg)) {
System.out.println("Enable:" + msg.bEnable);
try {
System.out.println("自定义名称:" + new String(msg.szName, "GBK").trim());
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
for(int i = 0; i < 7; i++) {
for(int j = 0; j < 4; j++) {
System.out.println("dwRecordMask:" +
msg.stuTimeWeekDay[i].stuTimeSection[j].dwRecordMask);
System.out.println(msg.stuTimeWeekDay[i].stuTimeSection[j].startTime() + "-" +
msg.stuTimeWeekDay[i].stuTimeSection[j].endTime() + "\n");
}
}
// 设置
if(ToolKits.SetDevConfig(loginHandle, nChannel, strCmd, msg)) {
System.out.println("Set AccessTimeSchedule Succeed!");
} else {
System.err.println("Set AccessTimeSchedule Failed!" + ToolKits.getErrorCode());
}
} else {
System.err.println("Get AccessTimeSchedule Failed!" + ToolKits.getErrorCode());
}
}
52
2.2.10 门高级配置
2.2.10.1 分时段、首卡开门
2.2.10.1.1 简介
分时段、首卡开门，即用户通过调用 SDK 接口，对门禁设备的分时段、首卡、首用户开门配置
进行获取和设置的操作。
2.2.10.1.2 接口总览
表2-25 分时段和首卡开门接口说明
接口 说明
CLIENT_GetNewDevConfig 查询配置信息。
CLIENT_ParseData 解析查询到的配置信息。
CLIENT_SetNewDevConfig 设置配置信息。
CLIENT_PacketData 将需要设置的配置信息，打包成字符串格式。
2.2.10.1.3 流程说明
分时段和首卡开门业务流程
开始
登录设备
CLIENT_LoginWithHighLevelSecurity
注销用户
CLIENT_Logout
释放SDK资源
CLIENT_Cleanup
结束
调用初始化接口
CLIENT_Init
分时段、首卡开门配置
获取：CLIENT_GetNewDevConfig
配合CLIENT_ParseData使用
szCommand：CFG_CMD_ACCESS_EVENT
分时段、首卡开门配置
设置：CLIENT_SetNewDevConfig
配合CLIENT_PacketData使用
szCommand：CFG_CMD_ACCESS_EVENT
流程说明
调用 CLIENT_Init 函数，完成 SDK 初始化流程。
调用 CLIENT_LoginWithHighLevelSecurity 函数登录设备。
调用 CLIENT_GetNewDevConfig 函数，结合 CLIENT_ParseData 来查询门禁分时段、
53
首卡开门配置信息。
⚫ szCommand：CFG_CMD_ACCESS_EVENT。
⚫ pBuf：CFG_ACCESS_EVENT_INFO。
表2-26 CFG_ACCESS_EVENT_INFO 结构体参数说明
参数 含义
stuDoorTimeSection 分时段开门配置
stuFirstEnterInfo 首用户/卡开门配置
调用 CLIENT_SetNewDevConfig 函数，结合 CLIENT_PacketData 来设置门禁分时段、
首卡开门配置信息。
⚫ szCommand：CFG_CMD_ACCESS_EVENT。
⚫ pBuf：CFG_ACCESS_EVENT_INFO。
表2-27 _ACCESS_EVENT_INFO 结构体参数说明
参数 含义
stuDoorTimeSection 分时段开门配置
stuFirstEnterInfo 首用户/卡开门配置
业务执行完成之后，调用 CLIENT_Logout 函数登出设备。
SDK 功能使用完后，调用 CLIENT_Cleanup 函数释放 SDK 资源。
2.2.10.1.4 注意事项
⚫ 首卡引用的用户 ID 为卡号。
⚫ 为实现首卡开门功能，添加该用户 ID 对应人员到设备时，需要选择“首卡”，否则，首卡开
门功能无法使用。
2.2.10.1.5 示例代码
// 门禁事件配置
public void AccessConfig() {
// 获取
String szCommand = NetSDKLib.CFG_CMD_ACCESS_EVENT;
int nChn = 0; // 通道
CFG_ACCESS_EVENT_INFO access = new CFG_ACCESS_EVENT_INFO(); //
m_stDeviceInfo.byChanNum 为设备通道数
if (ToolKits.GetDevConfig(loginHandle, nChn, szCommand, access)) {
System.out.println("门禁通道名称:"
+ new String(access.szChannelName).trim());
System.out.println("首卡使能:" + access.stuFirstEnterInfo.bEnable); // 0-false;
// 1-true
System.out.println("首卡权限验证通过后的门禁状态:"
+ access.stuFirstEnterInfo.emStatus); // 状态参考枚举
//
CFG_ACCESS_FIRSTENTER_STATUS
System.out.println("需要首卡验证的时间段, 值为通道号:"
+ access.stuFirstEnterInfo.nTimeIndex);
System.out.println(" 当前门采集状态:" + access.emReadCardState);
}
54
// 设置
// access.emReadCardState = EM_CFG_CARD_STATE.EM_CFG_CARD_STATE_SWIPE; //
门禁刷卡
access.emReadCardState = EM_CFG_CARD_STATE.EM_CFG_CARD_STATE_COLLECTION;
// 门禁采集卡
// access.emReadCardState = EM_CFG_CARD_STATE.EM_CFG_CARD_STATE_UNKNOWN;
// 退出读卡状态
boolean bRet = ToolKits.SetDevConfig(loginHandle, nChn, szCommand,
access);
if (bRet) {
System.out.println("Set Succeed!");
}
}
2.2.10.2 多人组合开门
2.2.10.2.1 简介
多人组合开门，即用户通过调用 SDK 接口，对门禁设备的多人组合开门配置信息进行获取和设
置的操作。
2.2.10.2.2 接口总览
表2-28 多人组合开门接口说明
接口 说明
CLIENT_GetNewDevConfig 查询配置信息。
CLIENT_ParseData 解析查询到的配置信息。
CLIENT_SetNewDevConfig 设置配置信息。
CLIENT_PacketData 将需要设置的配置信息，打包成字符串格式。
55
2.2.10.2.3 流程说明
多人组合开门业务流程
开始
登录设备
CLIENT_LoginWithHighLevelSecurity
注销用户
CLIENT_Logout
释放SDK资源
CLIENT_Cleanup
结束
调用初始化接口
CLIENT_Init
多人组合开门配置
获取：CLIENT_GetNewDevConfig
配合CLIENT_ParseData使用
szCommand：CFG_CMD_OPEN_DOOR_GROUP
多人组合开门配置
设置：CLIENT_SetNewDevConfig
配合CLIENT_PacketData使用
szCommand：CFG_CMD_OPEN_DOOR_GROUP
流程说明
调用 CLIENT_Init 函数，完成 SDK 初始化流程。
调用 CLIENT_LoginWithHighLevelSecurity 函数登录设备。
调用 CLIENT_GetNewDevConfig 函数，结合 CLIENT_ParseData 来查询门禁多人组合
开门配置信息。
⚫ szCommand：CFG_CMD_OPEN_DOOR_GROUP。
⚫ pBuf：CFG_OPEN_DOOR_GROUP_INFO。
调用 CLIENT_SetNewDevConfig 函数，结合 CLIENT_PacketData 来设置门禁多人组合
开门配置信息。
⚫ szCommand：CFG_CMD_OPEN_DOOR_GROUP。
⚫ pBuf：CFG_OPEN_DOOR_GROUP_INFO。
业务执行完成之后，调用 CLIENT_Logout 函数登出设备。
SDK 功能使用完后，调用 CLIENT_Cleanup 函数释放 SDK 资源。
2.2.10.2.4 注意事项
⚫ 配置多人组合开门功能之前，需要先将人员添加到设备。
⚫ 组合序号：将人员进行分组，1 个门最多可以配置 4 个人员组。
⚫ 人员组：序号组内的人员。1 个组内人员人数最多为 50 人。人员需要提前添加到设备。
⚫ 有效人数：每个组内的有效人数≤组内当前人数，1 个门的有效人员总数≤5 人。
⚫ 设置人员组开门方式：仅支持卡、指纹，二选一。
2.2.10.2.5 示例代码
56
/**
* 多人多开门方式组合配置
* @param nChannel 通道号
* @param msg 多人多开门方式组合配置
*/
public boolean MoreOpenDoor(int nChannel,CFG_OPEN_DOOR_GROUP_INFO msg){
// 获取
String szCommand = NetSDKLib.CFG_CMD_OPEN_DOOR_GROUP;
if (!ToolKits.GetDevConfig(loginHandle, nChannel, szCommand, msg)) {
System.err.println("Get more open door Failed.");
return false;
}
System.out.println("有效组合数" + msg.nGroup + " 用户数目 " + msg.stuGroupInfo.length );
//设置
msg.stuGroupInfo[0].stuGroupDetail[0].emMethod=1;
msg.stuGroupInfo[0].stuGroupDetail[1].emMethod=1;
System.arraycopy("123".getBytes(), 0, msg.stuGroupInfo[0].stuGroupDetail[0].szUserID, 0,
"123".getBytes().length);
System.arraycopy("234".getBytes(), 0, msg.stuGroupInfo[0].stuGroupDetail[1].szUserID, 0,
"234".getBytes().length);
for(int i=0;ilFindeHandle 为
CLIENT_FindRecord 的 pOutParam-> lFindeHandle
[out]
pOutParam
查询记录条数出参，pOutParam ->nRecordCount为记录个数
[in] waittime 查询超时时间
返回值 成功返回 TRUE，失败返回 FALSE
说明 调用本接口之前应先调用 CLIENT_FindRecord 以打开查询句柄
3.3.9.1.2 按查询条件查询记录 CLIENT_FindRecord
表3-32 按查询条件查询记录说明
选项 说明
描述 按查询条件查询记录
函数
public boolean CLIENT_FindRecord(
LLong lLoginID,
NET_IN_FIND_RECORD_PARAM pInParam,
NET_OUT_FIND_RECORD_PARAM pOutParam,
int waittime
);
参数
[in]lLoginID 设备登录句柄
[in] pInParam 查询日志的参数，参数赋值说明请参见表 3-33
[out] pOutParam 查询日志的出参，返回查询句柄
[in] waittime 等待超时时间
返回值 成功返回 TRUE，失败返回 FALSE
说明
可以先调用本接口获得查询句柄，再调用 CLIENT_FindNextRecord 函数获
取记录列表，查询完毕可以调用 CLIENT_FindRecordClose 关闭查询句柄
表3-33 查询开门记录入参数说明
pInParam 结构体 赋值 说明
emType NET_RECORD_ACCESSCTLCARDREC_EX
用于开门记录查
询
129
3.3.9.1.3 查找记录 CLIENT_FindNextRecord
表3-34 查找记录说明
选项 说明
描述
查找记录:nFilecount:需要查询的条数,返回值为媒体文件条数返回值小于
nFilecount 则相应时间段内的文件查询完毕
函数
public boolean CLIENT_FindNextRecord(
NET_IN_FIND_NEXT_RECORD_PARAM pInParam,
NET_OUT_FIND_NEXT_RECORD_PARAM pOutParam,
int waittime
);
参数
[in] pInParam
查询记录入参，pInParam ->lFindeHandle 为
CLIENT_FindRecord 的 pOutParam-> lFindeHandle
[out]
pOutParam
查询记录出参返回记录信息
[in] waittime 等待超时时间
返回值 1：成功取回一条记录，0：记录已取完，-1：参数出错
说明 无
表3-35 查询开门记录出参说明
pOutParam 结构体 赋值 说明
pRecordList
NET_RECORDSET_ACCESS_C
TL_CARDREC
用于开门记录查询
3.3.9.1.4 结束记录查询 CLIENT_FindRecordClose
表3-36 结束记录查询说明
选项 说明
描述 结束记录查询
函数 public boolean CLIENT_FindRecordClose(LLong lFindHandle);
参数 [in] lFindHandle CLIENT_FindRecord 的返回值
返回值 成功返回 TRUE，失败返回 FALSE
说明
调用 CLIENT_FindRecord 打开查询句柄，查询完毕后应调用本函数以关闭
查询句柄
3.4 门禁控制器/人脸一体机（二代）
3.4.1 门禁控制
关于门控制接口的详细介绍，请参见“3.1.3.1 设备控制 CLIENT_ControlDeviceEx”。
关于门磁状态接口的详细介绍，请参见“3.3.2.4 查询设备状态 CLIENT_QueryDevState”。
130
3.4.2 设备信息查看
3.4.2.1 获取设备能力 CLIENT_GetDevCaps
表3-37 获取设备能力说明
选项 说明
描述 获取设备能力
函数
public boolean CLIENT_GetDevCaps(
LLong lLoginID, int nType,
Pointer pInBuf,
Pointer pOutBuf,
int nWaitTime
);
参数
[in] lLoginID 登录句柄
[in] nType
设备类型
控制参数根据 type 不同而不同
[in] pInBuf 获取设备能力（入参）
[out] pOutBuf 获取设备能力（出参）
[in] nWaitTime 超时时间
返回值 成功返回 TRUE，失败返回 FALSE
说明 无
nType、pInBuf 和 pOutBuf 的对照关系，请参见表 3-18。
表3-38 nType、pInBuf 和 pOutBuf 对照关系
nType 描述 pInBuf pOutBuf
NET_ACCESSCONT
ROL_CAPS
获取门禁能力 NET_IN_AC_CAPS NET_OUT_AC_CAPS
3.4.2.2 查询设备状态 CLIENT_QueryDevState
关于 CLIENT_QueryDevState 详细介绍，请参见“3.3.2.4 查询设备状态
CLIENT_QueryDevState”。
3.4.3 网络配置
请参见“3.3.3 网络配置”。
3.4.4 时间设置
请参见“3.3.4 时间设置”。
131
3.4.5 人员管理
3.4.5.1 用户管理
3.4.5.1.1 门禁用户信息管理接口 CLIENT_OperateAccessUserService
表3-39 门禁用户信息管理接口说明
选项 说明
描述 门禁人员信息管理接口
函数
public boolean CLIENT_OperateAccessUserService(
LLong lLoginID,
int emtype,
Pointer pstInParam,
Pointer pstOutParam,
int nWaitTime
);
参数
[in] lLoginID 登录句柄
[in] emtype 用户信息操作类型
[in] pInBuf 用户信息管理（入参）
[out] pOutBuf 用户信息管理（出参）
[in] nWaitTime 超时时间
返回值 成功返回 TRUE，失败返回 FALSE
说明 无
emtype、pInBuf 和 pOutBuf 的对照关系，请参见表 3-40。
表3-40 nType、pInBuf 和 pOutBuf 对照关系
emtype 描述 pInBuf pOutBuf
NET_EM_ACCESS_
CTL_USER_SERVIC
E_INSERT
添加用户信息
NET_IN_ACCESS_
USER_SERVICE_I
NSERT
NET_OUT_ACCESS_
USER_SERVICE_INS
ERT
NET_EM_ACCESS_
CTL_USER_SERVIC
E_REMOVE
删除用户信息
NET_IN_ACCESS_
USER_SERVICE_R
EMOVE
NET_OUT_ACCESS_
USER_SERVICE_RE
MOVE
NET_EM_ACCESS_
CTL_USER_SERVIC
E_CLEAR
清空所有用户信息
NET_IN_ACCESS_
USER_SERVICE_C
LEAR
NET_OUT_ACCESS_
USER_SERVICE_CLE
AR
3.4.5.1.2 开始查询人员信息接口 CLIENT_StartFindUserInfo
表3-41 开始查询人员信息接口说明
选项 说明
描述 开始查询人员信息接口
132
选项 说明
函数
public LLong CLIENT_StartFindUserInfo(
LLong lLoginID,
NET_IN_USERINFO_START_FIND pstIn,
NET_OUT_USERINFO_START_FIND pstOut,
int nWaitTime
);
参数
[in] lLoginID 登录句柄
[in] pstIn 开始查询人员信息接口（入参）
[out] pstOut 开始查询人员信息接口（出参）
[in] nWaitTime 超时时间
返回值 成功返回查询句柄，失败返回 0
说明 无
3.4.5.1.3 获取人员信息接口 CLIENT_DoFindUserInfo
表3-42 获取人员信息接口说明
选项 说明
描述 获取人员信息接口
函数
public boolean CLIENT_DoFindUserInfo(
LLong lFindHandle,
NET_IN_USERINFO_DO_FIND pstIn,
NET_OUT_USERINFO_DO_FIND pstOut,
int nWaitTime
);
参数
[in] lFindHandle CLIENT_StartFindUserInfo 返回值
[in] pstIn 获取人员信息接口（入参）
[out] pstOut 获取人员信息接口（出参）
[in] nWaitTime 超时时间
返回值 成功返回 TRUE，失败返回 FALSE
说明 无
3.4.5.1.4 停止查询人员信息接口 CLIENT_StopFindUserInfo
表3-43 停止查询人员信息接口说明
选项 说明
描述 停止查询人员信息接口
函数 public boolean CLIENT_StopFindUserInfo(LLong lFindHandle);
参数 [in] lFindHandle CLIENT_StartFindUserInfo 返回值
返回值 成功返回 TRUE，失败返回 FALSE
说明 无
133
3.4.5.2 卡片管理
3.4.5.2.1 门禁卡片信息管理接口 CLIENT_OperateAccessCardService
表3-44 门禁卡片信息管理接口说明
选项 说明
描述 门禁卡片信息管理接口
函数
public boolean CLIENT_OperateAccessCardService(
LLong lLoginID,
int emtype,
Pointer pstInParam,
Pointer pstOutParam,
int nWaitTime
);
参数
[in] lLoginID 登录句柄
[in] emtype 卡片信息操作类型
[in] pInBuf 卡片信息管理（入参）
[out] pOutBuf 卡片信息管理（出参）
[in] nWaitTime 超时时间
返回值 成功返回 TRUE，失败返回 FALSE
说明 无
emtype、pInBuf 和 pOutBuf 的对照关系，请参见表 3-18。
表3-45 nType、pInBuf 和 pOutBuf 对照关系
emtype 描述 pInBuf pOutBuf
NET_EM_ACCESS_
CTL_CARD_SERVIC
E_INSERT
添加卡片信息
NET_IN_ACCESS_
CARD_SERVICE_I
NSERT
NET_OUT_ACCESS_
CARD_SERVICE_INS
ERT
NET_EM_ACCESS_
CTL_CARD_SERVIC
E_REMOVE
删除卡片信息
NET_IN_ACCESS_
CARD_SERVICE_R
EMOVE
NET_OUT_ACCESS_
CARD_SERVICE_RE
MOVE
NET_EM_ACCESS_
CTL_CARD_SERVIC
E_CLEAR
清空所有卡片信息
NET_IN_ACCESS_
CARD_SERVICE_C
LEAR
NET_OUT_ACCESS_
CARD_SERVICE_CLE
AR
3.4.5.2.2 开始查询卡片信息接口 CLIENT_StartFindCardInfo
表3-46 开始查询卡片信息接口说明
选项 说明
描述 开始查询卡片信息接口
函数
public LLong CLIENT_StartFindCardInfo(
LLong lLoginID,
NET_IN_CARDINFO_START_FIND pstIn,
NET_OUT_CARDINFO_START_FIND pstOut,
int nWaitTime
);
参数 [in] lLoginID 登录句柄
134
选项 说明
[in] pstIn 开始查询卡片信息接口（入参）
[out] pstOut 开始查询卡片信息接口（出参）
[in] nWaitTime 超时时间
返回值 成功返回查询句柄，失败返回 0
说明 无
3.4.5.2.3 获取卡片信息接口 CLIENT_DoFindCardInfo
表3-47 获取卡片信息接口说明
选项 说明
描述 获取卡片信息接口
函数
public boolean CLIENT_DoFindCardInfo(
LLong lFindHandle,
NET_IN_CARDINFO_DO_FIND pstIn,
NET_OUT_CARDINFO_DO_FIND pstOut,
int nWaitTime
);
参数
[in] lFindHandle CLIENT_StartFindCardInfo 返回值
[in] pstIn 获取卡片信息接口（入参）
[out] pstOut 获取卡片信息接口（出参）
[in] nWaitTime 超时时间
返回值 成功返回 TRUE，失败返回 FALSE
说明 无
3.4.5.2.4 停止查询卡片信息接口 CLIENT_StopFindUserInfo
表3-48 停止查询卡片信息接口说明
选项 说明
描述 停止查询卡片信息接口
函数 public boolean CLIENT_StopFindCardInfo(LLong lFindHandle);
参数 [in] lFindHandle CLIENT_StartFindCardInf 返回值
返回值 成功返回 TRUE，失败返回 FALSE
说明 无
3.4.5.3 人脸管理
3.4.5.3.1 门禁人脸信息管理接口 CLIENT_OperateAccessFaceService
表3-49 门禁人脸信息管理接口说明
选项 说明
描述 门禁人脸信息管理接口
135
选项 说明
函数
public boolean CLIENT_OperateAccessFaceService(
LLong lLoginID,
int emtype,
Pointer pstInParam,
Pointer pstOutParam,
int nWaitTime
);
参数
[in] lLoginID 登录句柄
[in] emtype 人脸信息操作类型
[in] pInBuf 人脸信息管理（入参）
[out] pOutBuf 人脸信息管理（出参）
[in] nWaitTime 超时时间
返回值 成功返回 TRUE，失败返回 FALSE
说明 无
emtype、pInBuf 和 pOutBuf 的对照关系，请参见表 3-50。
表3-50 nType、pInBuf 和 pOutBuf 对照关系
emtype 描述 pInBuf pOutBuf
NET_EM_ACCESS_
CTL_FACE_SERVIC
E_INSERT
添加人脸信息
NET_IN_ACCESS_
FACE_SERVICE_IN
SERT
NET_OUT_ACCESS_
FACE_SERVICE_INS
ERT
NET_EM_ACCESS_
CTL_FACE_SERVIC
E_GET
获取人脸信息
NET_IN_ACCESS_
FACE_SERVICE_G
ET
NET_OUT_ACCESS_
FACE_SERVICE_GET
NET_EM_ACCESS_
CTL_FACE_SERVIC
E_UPDATE
更新人脸信息
NET_IN_ACCESS_
FACE_SERVICE_U
PDATE
NET_OUT_ACCESS_
FACE_SERVICE_UPD
ATE
NET_EM_ACCESS_
CTL_FACE_SERVIC
E_REMOVE
删除人脸信息
NET_IN_ACCESS_
FACE_SERVICE_R
EMOVE
NET_OUT_ACCESS_
FACE_SERVICE_REM
OVE
NET_EM_ACCESS_
CTL_FACE_SERVIC
E_CLEAR
清空人脸信息
NET_IN_ACCESS_
FACE_SERVICE_C
LEAR
NET_OUT_ACCESS_
FACE_SERVICE_CLE
AR
3.4.5.4 指纹管理
3.4.5.4.1 门禁指纹信息管理接口 CLIENT_OperateAccessFingerprintService
表3-51 门禁指纹信息管理接口说明
选项 说明
描述 门禁指纹信息管理接口
136
选项 说明
函数
public boolean CLIENT_OperateAccessFingerprintService(
LLong lLoginID,
int emtype,
Pointer pstInParam,
Pointer pstOutParam,
int nWaitTime
);
参数
[in] lLoginID 登录句柄
[in] emtype 指纹信息操作类型
[in] pInBuf 指纹信息管理（入参）
[out] pOutBuf 指纹信息管理（出参）
[in] nWaitTime 超时时间
返回值 成功返回 TRUE，失败返回 FALSE
说明 无
emtype、pInBuf 和 pOutBuf 的对照关系，请参见表 3-52。
表3-52 nType、pInBuf 和 pOutBuf 对照关系
emtype 描述 pInBuf pOutBuf
NET_EM_ACCESS_
CTL_FINGERPRINT
_SERVICE_INSERT
添加指纹信息
NET_IN_ACCESS_
FINGERPRINT_SE
RVICE_INSERT
NET_OUT_ACCESS_
FINGERPRINT_SERVI
CE_INSERT
NET_EM_ACCESS_
CTL_FINGERPRINT
_SERVICE_GET
获取指纹信息
NET_IN_ACCESS_
FINGERPRINT_SE
RVICE_GET
NET_OUT_ACCESS_
FINGERPRINT_SERVI
CE_GET
NET_EM_ACCESS_
CTL_FINGERPRINT
_SERVICE_UPDATE
更新指纹信息
NET_IN_ACCESS_
FINGERPRINT_SE
RVICE_UPDATE
NET_OUT_ACCESS_
FINGERPRINT_SERVI
CE_UPDATE
NET_EM_ACCESS_
CTL_FINGERPRINT
_SERVICE_REMOV
E
删除指纹信息
NET_IN_ACCESS_
FINGERPRINT_SE
RVICE_REMOVE
NET_OUT_ACCESS_
FINGERPRINT_SERVI
CE_REMOVE
NET_EM_ACCESS_
CTL_FINGERPRINT
_SERVICE_CLEAR
清空指纹信息
NET_IN_ACCESS_
FINGERPRINT_SE
RVICE_CLEAR
NET_OUT_ACCESS_
FINGERPRINT_SERVI
CE_CLEAR
3.4.6 门配置
3.4.6.1 门配置信息
3.4.6.1.1 解析查询到的配置信息 CLIENT_ParseData
关于 CLIENT_ParseData 的详细介绍，请参见“3.3.2.2 解析查询到的配置信息
CLIENT_ParseData”。
137
3.4.6.1.2 查询配置信息 CLIENT_GetNewDevConfig
关于 CLIENT_GetNewDevConfig 的详细介绍，请参见“3.3.3.1.2 查询配置信息
CLIENT_GetNewDevConfig”。
3.4.6.1.3 设置配置信息 CLIENT_SetNewDevConfig
关于 CLIENT_SetNewDevConfig 的详细介绍，请参见“3.3.3.1.3 设置配置信息
CLIENT_SetNewDevConfig”。
3.4.6.1.4 打包字符串格式 CLIENT_PacketData
关于 CLIENT_PacketData 的详细介绍，请参见“3.3.3.1.4 打包字符串格式 CLIENT_PacketData”。
3.4.7 门时间配置
3.4.7.1 时段配置
3.4.7.1.1 解析查询到的配置信息 CLIENT_ParseData
关于 CLIENT_ParseData 的详细介绍，请参见“3.3.2.2 解析查询到的配置信息
CLIENT_ParseData”。
3.4.7.1.2 查询配置信息 CLIENT_GetNewDevConfig
关于 CLIENT_GetNewDevConfig 的详细介绍，请参见“3.3.3.1.2 查询配置信息
CLIENT_GetNewDevConfig”。
3.4.7.1.3 设置配置信息 CLIENT_SetNewDevConfig
关于 CLIENT_SetNewDevConfig 的详细介绍，请参见“3.3.3.1.3 设置配置信息
CLIENT_SetNewDevConfig”。
3.4.7.1.4 打包字符串格式 CLIENT_PacketData
关于 CLIENT_PacketData 的详细介绍，请参见“3.3.3.1.4 打包字符串格式 CLIENT_PacketData”。
3.4.7.2 常开常闭时段配置
3.4.7.2.1 解析查询到的配置信息 CLIENT_ParseData
关于 CLIENT_ParseData 的详细介绍，请参见“3.3.2.2 解析查询到的配置信息
CLIENT_ParseData”。
3.4.7.2.2 查询配置信息 CLIENT_GetNewDevConfig
关于 CLIENT_GetNewDevConfig 的详细介绍，请参见“3.3.3.1.2 查询配置信息
CLIENT_GetNewDevConfig”。
138
3.4.7.2.3 设置配置信息 CLIENT_SetNewDevConfig
关于 CLIENT_SetNewDevConfig 的详细介绍，请参见“3.3.3.1.3 设置配置信息
CLIENT_SetNewDevConfig”。
3.4.7.2.4 打包字符串格式 CLIENT_PacketData
关于 CLIENT_PacketData 的详细介绍，请参见“3.3.3.1.4 打包字符串格式 CLIENT_PacketData”。
3.4.7.3 假日组
3.4.7.3.1 获取假日组接口 CLIENT_GetConfig
表3-53 获取假日组接口说明
选项 说明
描述 获取假日组接口
函数
public boolean CLIENT_GetConfig(
LLong lLoginID,
int emCfgOpType,
int nChannelID,
Pointer szOutBuffer,
int dwOutBufferSize,
int waittime,
Pointer reserve
);
参数
[in] lLoginID 登录句柄
[in] emCfgOpType
设置配置信息的类型
假日组配置：
NET_EM_CFG_ACCESSCTL_SPECIALDAY_GROUP
[in] nChannelID 通道号
[out] szOutBuffer 获取配置信息的缓存地址
[in] dwOutBufferSize 缓存地址大小
[in] waittime 超时时间
[in] reserve 保留参数
返回值 成功返回 TRUE，失败返回 FALSE
说明 无
表3-54 获取假日组信息 emCfgOpType 参数赋值说明
emCfgOpType 描述 szOutBuffer dwOutBufferSize
NET_EM_CFG_ACC
ESSCTL_SPECIALD
AY_GROUP
获取假日组信息
NET_CFG_ACCESSCT
L_SPECIALDAY_GRO
UP_INFO
NET_CFG_ACCESSCTL_
SPECIALDAY_GROUP_IN
FO结构体尺寸
3.4.7.3.2 设置假日组接口 CLIENT_SetConfig
表3-55 设置假日组接口说明
选项 说明
描述 设置假日组接口
139
选项 说明
函数
public boolean CLIENT_SetConfig(
LLong lLoginID,
int emCfgOpType,
int nChannelID,
Pointer szInBuffer,
int dwInBufferSize,
int waittime,
IntByReference restart,
Pointer reserve
);
参数
[in] lLoginID 登录句柄
[in] emCfgOpType
设置配置的类型
假日组配置：
NET_EM_CFG_ACCESSCTL_SPECIALDAY_GROUP
[in] nChannelID 通道号
[in] szInBuffer 配置的缓存地址
[in] dwInBufferSize 缓存地址大小
[in] waittime 超时时间
[in] restart 是否需要重启
[in] reserve 保留参数
返回值 成功返回 TRUE，失败返回 FALSE
说明 无
表3-56 设置假日组信息 mCfgOpType 参数赋值说明
emCfgOpType 描述 szInBuffer dwInBufferSize
NET_EM_CFG_ACC
ESSCTL_SPECIALD
AY_GROUP
设置假日组信息
NET_CFG_ACCES
SCTL_SPECIALDA
Y_GROUP_INFO
NET_CFG_ACCESSC
TL_SPECIALDAY_GR
OUP_INFO 结构体尺寸
3.4.7.4 假日计划
关于接口的详细介绍，请参见“3.4.7.3 假日组”。
表3-57 获取假日计划信息 emCfgOpType 参数赋值说明
emCfgOpType 描述 szOutBuffer dwOutBufferSize
NET_EM_CFG_ACC
ESSCTL_SPECIALD
AYS_SCHEDULE
获取计划信息
NET_CFG_ACCES
SCTL_SPECIALDA
YS_SCHEDULE_IN
FO
NET_CFG_ACCESSC
TL_SPECIALDAYS_S
CHEDULE_INFO 结构
体尺寸
表3-58 设置假日计划信息 emCfgOpType 参数赋值说明
emCfgOpType 描述 szInBuffer dwInBufferSize
NET_EM_CFG_ACC
ESSCTL_SPECIALD
AYS_SCHEDULE
设置假日计划信息
NET_CFG_ACCES
SCTL_SPECIALDA
YS_SCHEDULE_IN
FO
NET_CFG_ACCESSC
TL_SPECIALDAYS_S
CHEDULE_INFO 结构
体尺寸
140
3.4.8 门高级配置
请参见“3.3.8 门高级配置”。
3.4.9 记录查询
3.4.9.1 开门记录
请参见“3.3.9.1 开门记录”。
3.4.9.2 报警记录
3.4.9.2.1 查找记录条数 CLIENT_QueryRecordCount
表3-59 查询记录条数说明
选项 说明
描述 查找记录条数
函数
public boolean CLIENT_QueryRecordCount(
NET_IN_QUEYT_RECORD_COUNT_PARAM pInParam,
NET_OUT_QUEYT_RECORD_COUNT_PARAM pOutParam,
int waittime
);
参数
[in]
pInParam
查询记录条数入参，pInParam ->lFindeHandle 为
CLIENT_FindRecord 的 pOutParam-> lFindeHandle
[out]
pOutParam
查询记录条数出参，pOutParam ->nRecordCount为记录个数
[in] waittime 查询超时时间
返回值 成功返回 TRUE，失败返回 FALSE
说明 调用本接口之前应先调用 CLIENT_FindRecord 以打开查询句柄
3.4.9.2.2 按查询条件查询记录 CLIENT_FindRecord
表3-60 按查询条件查询记录说明
选项 说明
描述 按查询条件查询记录
函数
public boolean CLIENT_FindRecord(
LLong lLoginID,
NET_IN_FIND_RECORD_PARAM pInParam,
NET_OUT_FIND_RECORD_PARAM pOutParam,
int waittime
);
参数
[in]lLoginID 设备登录句柄
[in] pInParam 查询日志的参数，参数赋值说明请参见表 3-33
[out] pOutParam 查询日志的出参，返回查询句柄
[in] waittime 等待超时时间
141
选项 说明
返回值 成功返回 TRUE，失败返回 FALSE
说明
可以先调用本接口获得查询句柄，再调用 CLIENT_FindNextRecord 函数获
取记录列表，查询完毕可以调用 CLIENT_FindRecordClose 关闭查询句柄
表3-61 查询开门记录入参数说明
pInParam 结构体 赋值 说明
emType NET_RECORD_ACCESS_ALARMRECORD 用于报警记录查询
3.4.9.2.3 查找记录 CLIENT_FindNextRecord
表3-62 查找记录说明
选项 说明
描述
查找记录:nFilecount:需要查询的条数，返回值为媒体文件条数返回值小于
nFilecount 则相应时间段内的文件查询完毕
函数
public boolean CLIENT_FindNextRecord(
NET_IN_FIND_NEXT_RECORD_PARAM pInParam,
NET_OUT_FIND_NEXT_RECORD_PARAM pOutParam,
int waittime
);
参数
[in] pInParam
查询记录入参，pInParam ->lFindeHandle 为
CLIENT_FindRecord 的 pOutParam-> lFindeHandle
[out]
pOutParam
查询记录出参返回记录信息
[in] waittime 等待超时时间
返回值 1：成功取回一条记录，0：记录已取完，-1：参数出错
说明 无
表3-63 查询开门记录出参说明
pOutParam 结构体 赋值 说明
pRecordList
NET_RECORD_ACCESS_ALARMRE
CORD_INFO
用于报警记录查询
3.4.9.2.4 结束记录查询 CLIENT_FindRecordClose
表3-64 结束记录查询说明
选项 说明
描述 结束记录查询
函数 public boolean CLIENT_FindRecordClose(LLong lFindHandle);
参数 [in] lFindHandle CLIENT_FindRecord 的返回值
返回值 成功返回 TRUE，失败返回 FALSE
说明
调用 CLIENT_FindRecord 打开查询句柄，查询完毕后应调用本函数以关闭
查询句柄
142
第 4 章 回调函数
4.1 断线回调函数 fDisConnect
表4-1 断线回调函数说明
选项 说明
描述 断线回调函数
函数
public interface fDisConnect extends StdCallCallback {
public void invoke(
LLong lLoginID,
String pchDVRIP, int nDVRPort,
Pointer dwUser);
}
参数
[out]lLoginID CLIENT_LoginWithHighLevelSecurity 的返回值
[out]pchDVRIP 断线的设备 IP
[out]nDVRPort 断线的设备端口
[out]dwUser 回调函数的用户参数
返回值 无
说明 无
4.2 断线重连回调函数 fHaveReConnect
表4-2 断线重连回调函数说明
选项 说明
描述 断线重连回调函数
函数
public interface fHaveReConnect extends StdCallCallback {
public void invoke(
LLong lLoginID,
String pchDVRIP, int nDVRPort,
Pointer dwUser);
}
参数
[out]lLoginID CLIENT_LoginWithHighLevelSecurity 的返回值
[out]pchDVRIP 断线后重连成功的设备 IP
[out]nDVRPort 断线后重连成功的设备端口
[out]dwUser 回调函数的用户参数
返回值 无
说明 无
143
4.3 实时预览数据回调函数 fRealDataCallBackEx2
表4-3 实时预览数据回调函数说明
选项 说明
描述 实时预览数据回调函数
函数
public interface fRealDataCallBackEx2 extends SDKCallback{
void invoke(
LLong lRealHandle,
int dwDataType,
Pointer pBuffer,
int dwBufSize,
LLong param,
Pointer dwUser);
}
参数
[out]lRealHandle CLIENT_RealPlayEx 的返回值
[out]dwDataType
数据类型
0 表示原始数据
1 表示带有帧信息的数据
2 表示 YUV 数据
3 表示 PCM 音频数据
[out]pBuffer 预览数据块地址
[out]dwBufSize 预览数据块的长度，单位：字节
[out]param
回调数据参数结构体，dwDataType 值不同类型不
同。
dwDataType 为 0 时，param 为空指针
dwDataType 为 1 时，param 为
tagVideoFrameParam 结构体指针
dwDataType 为 2 时，param 为
tagCBYUVDataParam 结构体指针
dwDataType 为 3 时，param 为
tagCBPCMDataParam 结构体指针
[out]dwUser 回调函数的用户参数
返回值 无
说明 无
4.4 音频数据回调函数 pfAudioDataCallBack
表4-4 音频数据回调函数说明
选项 说明
描述 语音对讲的音频数据回调函数
144
选项 说明
函数
public interface pfAudioDataCallBack extends StdCallCallback {
public void invoke(
LLong lTalkHandle,
Pointer pDataBuf, int dwBufSize,
byte byAudioFlag, Pointer dwUser);
}
参数
[out]lTalkHandle CLIENT_StartTalkEx 的返回值
[out]pDataBuf 音频数据块地址
[out]dwBufSize 音频数据块的长度，单位：字节
[out]byAudioFlag
数据类型标志
0 表示来自本地采集
1 表示来自设备发送
[out]dwUser 回调函数的用户参数
返回值 无
说明 无
4.5 报警回调函数 fMessCallBack
表4-5 报警回调函数说明
选项 说明
描述 报警回调函数
函数
public interface fMessCallBack extends SDKCallback{
public boolean invoke(
int lCommand,
LLong lLoginID,
Pointer pStuEvent,
int dwBufLen,
String strDeviceIP,
NativeLong nDevicePort,
Pointer dwUser);
}
参数
[out]lCommand 报警类型，具体请参见表 4-6
[out]lLoginID 登录接口返回值
[out]pBuf
接收报警数据的缓存，根据调用的侦听接口和
lCommand 值不同，填充的数据不同
[out]dwBufLen pBuf 的长度，单位：字节
[out]pchDVRIP 设备 IP
[out]nDVRPort 端口
[out]dwUser 用户自定义数据
返回值 成功返回 TRUE，失败返回 FALSE
说明
一般在应用程序初始化时调用设置回调，在回调函数中根据不同的设备 ID 和命
令值做出不同的处理
145
表4-6 报警类型和结构体对应关系
报警所
属业务
报警类型名称 lCommand pBuf
报警主
机
本地报警事件 NET_ALARM_ALARM_EX2 ALARM_ALARM_INFO_EX2
电源故障事件 NET_ALARM_POWERFAULT
ALARM_POWERFAULT_INF
O
防拆事件
NET_ALARM_CHASSISINTR
UDED
ALARM_CHASSISINTRUDE
D_INFO
扩展报警输入通
道事件
NET_ALARM_ALARMEXTEN
DED
ALARM_ALARMEXTENDED
_INFO
紧急事件 NET_URGENCY_ALARM_EX
数据为 16 个字节数组，每个字
节表示一个通道状态
1 为有报警
0 为无报警
蓄电池低电压事
件
NET_ALARM_BATTERYLOW
POWER
ALARM_BATTERYLOWPOW
ER_INFO
设备邀请平台对
讲事件
NET_ALARM_TALKING_INVI
TE
ALARM_TALKING_INVITE_I
NFO
设备布防模式变
化事件
NET_ALARM_ARMMODE_C
HANGE_EVENT
ALARM_ARMMODE_CHANG
E_INFO
防区旁路状态变
化事件
NET_ALARM_BYPASSMOD
E_CHANGE_EVENT
ALARM_BYPASSMODE_CH
ANGE_INFO
报警输入源信号
事件
NET_ALARM_INPUT_SOUR
CE_SIGNAL
ALARM_INPUT_SOURCE_SI
GNAL_INFO
消警事件 NET_ALARM_ALARMCLEAR
ALARM_ALARMCLEAR_INF
O
子系统状态改变
事件
NET_ALARM_SUBSYSTEM_
STATE_CHANGE
ALARM_SUBSYSTEM_STAT
E_CHANGE_INFO
扩展模块掉线事
件
NET_ALARM_MODULE_LOS
T
ALARM_MODULE_LOST_IN
FO
PSTN 掉线事件
NET_ALARM_PSTN_BREAK
_LINE
ALARM_PSTN_BREAK_LINE
_INFO
模拟量报警事件
NET_ALARM_ANALOG_PUL
SE
ALARM_ANALOGPULSE_IN
FO
报警传输事件
NET_ALARM_PROFILE_ALA
RM_TRANSMIT
ALARM_PROFILE_ALARM_
TRANSMIT_INFO
无线设备低电量
报警事件
NET_ALARM_WIRELESSDE
V_LOWPOWER
ALARM_WIRELESSDEV_LO
WPOWER_INFO
防区布撤防状态
改变事件
NET_ALARM_DEFENCE_AR
MMODE_CHANGE
ALARM_DEFENCE_ARMMO
DECHANGE_INFO
子系统布撤防状
态改变事件
NET_ALARM_SUBSYSTEM_
ARMMODE_CHANGE
ALARM_SUBSYSTEM_ARM
MODECHANGE_INFO
探测器异常报警
NET_ALARM_SENSOR_ABN
ORMAL
ALARM_SENSOR_ABNORM
AL_INFO
病人活动状态报
警事件
NET_ALARM_PATIENTDETE
CTION
ALARM_PATIENTDETECTIO
N_INFO
146
报警所
属业务
报警类型名称 lCommand pBuf
门禁
门禁事件
NET_ALARM_ACCESS_CTL_EVE
NT
ALARM_ACCESS_CTL_EVENT_I
NFO
门禁未关事件详
细信息
NET_ALARM_ACCESS_CTL_NO
T_CLOSE
ALARM_ACCESS_CTL_NOT_CL
OSE_INFO
闯入事件详细信
息
NET_ALARM_ACCESS_CTL_BRE
AK_IN
ALARM_ACCESS_CTL_BREAK_I
N_INFO
反复进入事件详
细信息
NET_ALARM_ACCESS_CTL_REP
EAT_ENTER
ALARM_ACCESS_CTL_REPEAT_
ENTER_INFO
恶意开门事件
NET_ALARM_ACCESS_CTL_MAL
ICIOUS
ALARM_ACCESS_CTL_MALICIO
US
胁迫卡刷卡事件
详细信息
NET_ALARM_ACCESS_CTL_DU
RESS
ALARM_ACCESS_CTL_DURESS
_INFO
多人组合开门事
件
NET_ALARM_OPENDOORGROU
P
ALARM_OPEN_DOOR_GROUP_I
NFO
防拆事件
NET_ALARM_CHASSISINTRUDE
D
ALARM_CHASSISINTRUDED_IN
FO
本地报警事件 NET_ALARM_ALARM_EX2 ALARM_ALARM_INFO_EX2
门禁状态事件
NET_ALARM_ACCESS_CTL_STA
TUS
ALARM_ACCESS_CTL_STATUS_
INFO
锁舌报警
NET_ALARM_ACCESS_CTL_STA
TUS
ALARM_ACCESS_CTL_STATUS_
INFO
获取指纹事件 NET_ALARM_FINGER_PRINT
ALARM_CAPTURE_FINGER_PRI
NT_INFO
可视对
讲
直连情况下，呼叫
无答应事件
NET_ALARM_CALL_NO_ANSWE
RED
NET_ALARM_CALL_NO_ANSWE
RED_INFO
手机号码上报事
件
NET_ALARM_TELEPHONE_CHE
CK
ALARM_TELEPHONE_CHECK_I
NFO
VTS 状态上报 NET_ALARM_VTSTATE_UPDATE
ALARM_VTSTATE_UPDATE_INF
O
VTO 目标检测 NET_ALARM_ACCESSIDENTIFY NET_ALARM_ACCESSIDENTIFY
设备请求对方发
起对讲事件
NET_ALARM_TALKING_INVITE ALARM_TALKING_INVITE_INFO
设备取消对讲请
求事件
NET_ALARM_TALKING_IGNORE
_INVITE
ALARM_TALKING_IGNORE_INVI
TE_INFO
设备主动挂断对
讲事件
NET_ALARM_TALKING_HANGUP
ALARM_TALKING_HANGUP_INF
O
雷达监测超速报
警事件
NET_ALARM_RADAR_HIGH_SPE
ED
ALARM_RADAR_HIGH_SPEED_I
NFO
147
4.6 升级进度回调函数 fUpgradeCallBackEx
表4-7 升级进度回调函数说明
选项 说明
描述 升级进度回调函数
函数
public interface fUpgradeCallBackEx extends SDKCallback {
public void invoke(
LLong lLoginID,
LLong lUpgradechannel,
int nTotalSize,
int nSendSize,
Pointer dwUserData);
}
参数
[out]lLoginID 登录接口返回值
[out]
lUpgradechannel
CLIENT_StartUpgradeEx2 返回的升级句柄 ID
[out] nTotalSize 升级文件的总长度(单位:字节)
[out] nSendSize
已发送的文件长度(单位:字节)，为-1 时，表示发送升级
文件结束
[out]dwUser 用户自定义数据
返回值 无
说明
升级设备程序回调函数原形支持 G 以上升级文件
nTotalSize = 0, nSendSize = -1 表示升级完成
nTotalSize = 0, nSendSize = -2 表示升级出错
nTotalSize = 0, nSendSize = -3 用户没有权限升级
nTotalSize = 0, nSendSize = -4 升级程序版本过低
nTotalSize = -1, nSendSize = XX 表示升级进度
nTotalSize = XX, nSendSize = XX 表示升级文件发送进度
148
4.7 智能事件回调函数 fAnalyzerDataCallBack
表4-8 智能事件回调函数 fAnalyzerDataCallBack
选项 说明
描述 远程设备状态回调函数
函数
public interface fAnalyzerDataCallBack extends Callback {
public int invoke(LLong lAnalyzerHandle, int dwAlarmType, Pointer
pAlarmInfo, Pointer pBuffer, int dwBufSize, Pointer dwUser, int nSequence,
Pointer reserved);
}
参数
[out]lAnalyzerHandle CLIENT_RealLoadPictureEx 返回值
[out]dwEventType 智能事件类型
[out] pAlarmInfo 事件信息缓存
[out]pBuffer 图片缓存
[out]dwBufSize 图片缓存大小
[out]dwUser 用户数据
[out]nSequence 序列号
[out]reserved 保留
返回值 无
说明
订阅远程设备智能事件后，如果前端设备有相关的智能事件，会上报发生事件的
相关信息
法律声明
商标声明
⚫ ：本声明适用所有产品。如本产品使用 HDMI 技术，词语 HDMI、HDMI
High-Definition Multimedia Interface（高清晰度多媒体接口）、HDMI 商业外观和 HDMI 徽标
均为 HDMI Licensing Administrator, Inc.的商标或注册商标。本产品已经获得 HDMI
Licensing Administrator, Inc.授权使用 HDMI 技术。
⚫ VGA 是 IBM 公司的商标。
⚫ Windows 标识和 Windows 是微软公司的商标或注册商标。
⚫ 在本文档中可能提及的其他商标或公司的名称，由其各自所有者拥有。
责任声明
⚫ 在适用法律允许的范围内，在任何情况下，本公司都不对因本文档中相关内容及描述的产品
而产生任何特殊的、附随的、间接的、继发性的损害进行赔偿，也不对任何利润、数据、商
誉、文档丢失或预期节约的损失进行赔偿。
⚫ 本文档中描述的产品均“按照现状”提供，除非适用法律要求，本公司对文档中的所有内容
不提供任何明示或暗示的保证，包括但不限于适销性、质量满意度、适合特定目的、不侵犯
第三方权利等保证。
隐私保护提醒
您安装了我们的产品，您可能会采集人脸、指纹、车牌等个人信息。在使用产品过程中，您需要
遵守所在地区或国家的隐私保护法律法规要求，保障他人的合法权益。如，提供清晰、可见的标
牌，告知相关权利人视频监控区域的存在，并提供相应的联系方式。
149
关于本文档
⚫ 本文档供多个型号产品使用，产品外观和功能请以实物为准。
⚫ 如果不按照本文档中的指导进行操作而造成的任何损失由使用方自己承担。
⚫ 本文档会实时根据相关地区的法律法规更新内容，具体请参见产品的纸质、电子光盘、二维
码或官网，如果纸质与电子档内容不一致，请以电子档为准。
⚫ 本公司保留随时修改本文档中任何信息的权利，修改的内容将会在本文档的新版本中加入，
恕不另行通知。
⚫ 本文档可能包含技术上不准确的地方、或与产品功能及操作不相符的地方、或印刷错误，以
公司最终解释为准。
⚫ 如果获取到的 PDF 文档无法打开，请使用最新版本或最主流的阅读工具。
150
网络安全建议
保障设备基本网络安全的必须措施：
1. 使用复杂密码
请参考如下建议进行密码设置：
⚫ 长度不小于 8 个字符。
⚫ 至少包含两种字符类型，字符类型包括大小写字母、数字和符号。
⚫ 不包含账户名称或账户名称的倒序。
⚫ 不要使用连续字符，如 123、abc 等。
⚫ 不要使用重叠字符，如 111、aaa 等。
2. 及时更新固件和客户端软件
⚫ 按科技行业的标准作业规范，设备（如 NVR、DVR 和 IP 摄像机等）的固件需要及时更
新至最新版本，以保证设备具有最新的功能和安全性。设备接入公网情况下，建议开启
在线升级自动检测功能，便于及时获知厂商发布的固件更新信息。
⚫ 建议您下载和使用最新版本客户端软件。
增强设备网络安全的建议措施：
1. 物理防护
建议您对设备（尤其是存储类设备）进行物理防护，比如将设备放置在专用机房、机柜，并
做好门禁权限和钥匙管理，防止未经授权的人员进行破坏硬件、外接设备（例如 U 盘、串口）
等物理接触行为。
2. 定期修改密码
建议您定期修改密码，以降低被猜测或破解的风险。
3. 及时设置、更新密码重置信息
设备支持密码重置功能，为了降低该功能被攻击者利用的风险，请您及时设置密码重置相关
信息，包含预留手机号/邮箱、密保问题，如有信息变更，请及时修改。设置密保问题时，建
议不要使用容易猜测的答案。
4. 开启账户锁定
出厂默认开启账户锁定功能，建议您保持开启状态，以保护账户安全。在攻击者多次密码尝
试失败后，其对应账户及源 IP 将会被锁定。
5. 更改 HTTP 及其他服务默认端口
建议您将 HTTP 及其他服务默认端口更改为 1024～65535 间的任意端口，以减小被攻击者
猜测服务端口的风险。
6. 使能 HTTPS
建议您开启 HTTPS，通过安全的通道访问 Web 服务。
7. MAC 地址绑定
建议您在设备端将其网关设备的 IP 与 MAC 地址进行绑定，以降低 ARP 欺骗风险。
8. 合理分配账户及权限
根据业务和管理需要，合理新增用户，并合理为其分配最小权限集合。
9. 关闭非必需服务，使用安全的模式
如果没有需要，建议您关闭 SNMP、SMTP、UPnP 等功能，以降低设备面临的风险。
如果有需要，强烈建议您使用安全的模式，包括但不限于：
⚫ SNMP：选择 SNMP v3，并设置复杂的加密密码和鉴权密码。
⚫ SMTP：选择 TLS 方式接入邮箱服务器。
⚫ FTP：选择 SFTP，并设置复杂密码。
⚫ AP 热点：选择 WPA2-PSK 加密模式，并设置复杂密码。
151
10. 音视频加密传输
如果您的音视频数据包含重要或敏感内容，建议启用加密传输功能，以降低音视频数据传输
过程中被窃取的风险。
11. 安全审计
⚫ 查看在线用户：建议您不定期查看在线用户，识别是否有非法用户登录。
⚫ 查看设备日志：通过查看日志，可以获知尝试登录设备的 IP 信息，以及已登录用户的
关键操作信息。
12. 网络日志
由于设备存储容量限制，日志存储能力有限，如果您需要长期保存日志，建议您启用网络日
志功能，确保关键日志同步至网络日志服务器，便于问题回溯。
13. 安全网络环境的搭建
为了更好地保障设备的安全性，降低网络安全风险，建议您：
⚫ 关闭路由器端口映射功能，避免外部网络直接访问路由器内网设备的服务。
⚫ 根据实际网络需要，对网络进行划区隔离：若两个子网间没有通信需求，建议使用 VLAN、
网闸等方式对其进行网络分割，达到网络隔离效果。
⚫ 建立 802.1x 接入认证体系，以降低非法终端接入专网的风险。
⚫ 开启设备 IP/MAC 地址过滤功能，限制允许访问设备的主机范围。
