NetSDK
1.0.0.0
NetSDK开发文档
|
#include "interface/errcode.h"
结构体 | |
struct | XVR_SDK_DevCfgTime |
设备时间配置 更多... | |
struct | XVR_SDK_DevCfgRtmp |
设备RTMP推流配置 更多... | |
struct | XVR_SDK_FaceInfoV1 |
一代设备人脸注册信息 更多... | |
struct | XVR_SDK_FaceInfoV2 |
二代设备人脸注册信息 更多... | |
宏定义 | |
#define | XVRSDK_API |
#define | XVR_SDK_FACE_IMAGE_SIZE_MAX (300 * 1024) |
注册脸图文件大小上限 更多... | |
#define | XVR_SDK_FACE_IMAGE_WIDTH_MAX 1080 |
注册脸图最大像素宽度 更多... | |
#define | XVR_SDK_FACE_IMAGE_HEIGHT_MAX 1080 |
注册脸图最大像素高度 更多... | |
#define | XVR_SDK_FACE_FEATURE_VECTOR_SIZE 512 |
注册脸图特征值向量大小 更多... | |
#define | XVR_SDK_PERSON_ID_MAX_LEN 33 |
注册人ID最大长度(字节) 更多... | |
#define | XVR_SDK_PERSON_NAME_MAX_LEN 33 |
注册人名字最大长度(字节) 更多... | |
#define | XVR_SDK_PERSON_LABEL_MAX_LEN 64 |
注册人标签最大长度(字节) 更多... | |
类型定义 | |
typedef enum XVR_SDK_GenderType | XVR_SDK_GenderType |
性别 更多... | |
typedef struct XSHANDLE | XSHANDLE |
SDK连接句柄 更多... | |
typedef enum XVR_SDK_CONFIG_TYPE | XVR_SDK_CONFIG_TYPE |
SDK配置参数 更多... | |
typedef enum XVR_SDK_DEVICE_CONFIG_TYPE | XVR_SDK_DEVICE_CONFIG_TYPE |
设备配置参数 更多... | |
枚举 | |
enum | XVR_SDK_GenderType { Unspecified = -1, Male = 0, Female = 1 } |
性别 更多... | |
enum | XVR_SDK_CONFIG_TYPE { XVR_SDK_CFG_SEND_TIMEOUT, XVR_SDK_CFG_RECV_TIMEOUT } |
SDK配置参数 更多... | |
enum | XVR_SDK_DEVICE_CONFIG_TYPE { XVR_SDK_DEVCFG_TIME, XVR_SDK_DEVCFG_RTMP } |
设备配置参数 更多... | |
函数 | |
int XVRSDK_API | XVR_SDK_Init (void) |
SDK全局初始化 更多... | |
int XVRSDK_API | XVR_SDK_Cleanup (void) |
SDK全局反初始化 更多... | |
int XVRSDK_API | XVR_SDK_Create (XSHANDLE **handle) |
创建SDK连接实例 更多... | |
int XVRSDK_API | XVR_SDK_Destroy (XSHANDLE *handle) |
释放并关闭SDK连接实例 更多... | |
int XVRSDK_API | XVR_SDK_Login (XSHANDLE *handle, const char *address, int port, const char *username, const char *password) |
登陆设备 更多... | |
int XVRSDK_API | XVR_SDK_Heartbeat (XSHANDLE *handle) |
Check connection alive 更多... | |
int XVRSDK_API | XVR_SDK_GetDeviceConfig (XSHANDLE *handle, XVR_SDK_DEVICE_CONFIG_TYPE cfg, char *buffer, int size) |
获取设备配置,暂时只支持获取时间配置 更多... | |
int XVRSDK_API | XVR_SDK_SetDeviceConfig (XSHANDLE *handle, XVR_SDK_DEVICE_CONFIG_TYPE cfg, const char *data, int length) |
设置设备配置,暂时只支持设置时间 更多... | |
int XVRSDK_API | XVR_SDK_FaceRegister (XSHANDLE *handle, const struct XVR_SDK_FaceInfoV2 *info, const char *img_data, int img_len) |
注册人脸(适用于二代设备) 更多... | |
int XVRSDK_API | XVR_SDK_FaceRegisterV1 (XSHANDLE *handle, const struct XVR_SDK_FaceInfoV1 *info) |
注册人脸(适用于一代设备) 更多... | |
int XVRSDK_API | XVR_SDK_FaceUnregister (XSHANDLE *handle, const char *person_ids[], int person_cnt) |
批量删除人脸 更多... | |
int XVRSDK_API | XVR_SDK_FaceList (XSHANDLE *handle, int start, int limit, struct XVR_SDK_FaceInfoV2 result[], const char *condition, int *count) |
查询人脸信息 更多... | |
int XVRSDK_API | XVR_SDK_Control_Gateway (XSHANDLE *handle, int gateway_index, int control_type) |
远程门禁控制 更多... | |
#define XVR_SDK_FACE_FEATURE_VECTOR_SIZE 512 |
注册脸图特征值向量大小
#define XVR_SDK_FACE_IMAGE_HEIGHT_MAX 1080 |
注册脸图最大像素高度
#define XVR_SDK_FACE_IMAGE_SIZE_MAX (300 * 1024) |
注册脸图文件大小上限
#define XVR_SDK_FACE_IMAGE_WIDTH_MAX 1080 |
注册脸图最大像素宽度
#define XVR_SDK_PERSON_ID_MAX_LEN 33 |
注册人ID最大长度(字节)
#define XVR_SDK_PERSON_LABEL_MAX_LEN 64 |
注册人标签最大长度(字节)
#define XVR_SDK_PERSON_NAME_MAX_LEN 33 |
注册人名字最大长度(字节)
#define XVRSDK_API |
typedef enum XVR_SDK_CONFIG_TYPE XVR_SDK_CONFIG_TYPE |
SDK配置参数
typedef enum XVR_SDK_DEVICE_CONFIG_TYPE XVR_SDK_DEVICE_CONFIG_TYPE |
设备配置参数
typedef enum XVR_SDK_GenderType XVR_SDK_GenderType |
性别
enum XVR_SDK_CONFIG_TYPE |
设备配置参数
枚举值 | |
---|---|
XVR_SDK_DEVCFG_TIME | 设备时间, 见
|
XVR_SDK_DEVCFG_RTMP | 设备推流配置 |
enum XVR_SDK_GenderType |
int XVRSDK_API XVR_SDK_Cleanup | ( | void | ) |
SDK全局反初始化
int XVRSDK_API XVR_SDK_Control_Gateway | ( | XSHANDLE * | handle, |
int | gateway_index, | ||
int | control_type | ||
) |
远程门禁控制
[in] | handle | 连接句柄 |
[in] | gateway_index | 门禁序号,从1开始,-1表示对所有门进行操作 |
[in] | control_type | 命令值:0- 关闭,1- 打开 |
int XVRSDK_API XVR_SDK_Create | ( | XSHANDLE ** | handle | ) |
创建SDK连接实例
[out] | handle | 连接句柄输出 |
int XVRSDK_API XVR_SDK_Destroy | ( | XSHANDLE * | handle | ) |
释放并关闭SDK连接实例
[in] | handle | 连接句柄 |
int XVRSDK_API XVR_SDK_FaceList | ( | XSHANDLE * | handle, |
int | start, | ||
int | limit, | ||
struct XVR_SDK_FaceInfoV2 | result[], | ||
const char * | condition, | ||
int * | count | ||
) |
查询人脸信息
[in] | handle | 连接句柄 |
[in] | start | 起始位置 |
[in] | limit | 查询记录数, 上限50 |
[in] | result | 查询结果(至少limit条)缓冲区 |
[in] | condition | 查询条件, 如非NULL, 则查找PersonName或PersonID匹配condition的记录, 最大32字节 |
[out] | count | 查询结果记录数 |
int XVRSDK_API XVR_SDK_FaceRegister | ( | XSHANDLE * | handle, |
const struct XVR_SDK_FaceInfoV2 * | info, | ||
const char * | img_data, | ||
int | img_len | ||
) |
注册人脸(适用于二代设备)
[in] | handle | 连接句柄 |
[in] | info | 注册人脸信息 |
[in] | img_data | 脸图数据缓冲区 |
[in] | img_len | 脸图数据大小 |
int XVRSDK_API XVR_SDK_FaceRegisterV1 | ( | XSHANDLE * | handle, |
const struct XVR_SDK_FaceInfoV1 * | info | ||
) |
注册人脸(适用于一代设备)
[in] | handle | 连接句柄 |
[in] | info | 注册人脸信息 |
int XVRSDK_API XVR_SDK_FaceUnregister | ( | XSHANDLE * | handle, |
const char * | person_ids[], | ||
int | person_cnt | ||
) |
批量删除人脸
[in] | handle | 连接句柄 |
[in] | person_ids | 要删除的人脸person id数组,person id最大长度为32位。 |
[in] | person_cnt | 要删除的人脸ID个数 |
int XVRSDK_API XVR_SDK_GetDeviceConfig | ( | XSHANDLE * | handle, |
XVR_SDK_DEVICE_CONFIG_TYPE | cfg, | ||
char * | buffer, | ||
int | size | ||
) |
获取设备配置,暂时只支持获取时间配置
[in] | handle | 连接句柄 |
[in] | cfg | 配置类型 |
[out] | buffer | 配置数据缓冲区 |
[in] | size | 配置数据缓冲区大小 |
int XVRSDK_API XVR_SDK_Heartbeat | ( | XSHANDLE * | handle | ) |
Check connection alive
[in] | handle | 连接句柄 |
int XVRSDK_API XVR_SDK_Init | ( | void | ) |
SDK全局初始化
int XVRSDK_API XVR_SDK_Login | ( | XSHANDLE * | handle, |
const char * | address, | ||
int | port, | ||
const char * | username, | ||
const char * | password | ||
) |
登陆设备
[in] | handle | 连接句柄 |
[in] | address | 设备地址 |
[in] | port | 设备端口 |
[in] | username | 用户名 |
[in] | password | 用户密码 |
int XVRSDK_API XVR_SDK_SetDeviceConfig | ( | XSHANDLE * | handle, |
XVR_SDK_DEVICE_CONFIG_TYPE | cfg, | ||
const char * | data, | ||
int | length | ||
) |
设置设备配置,暂时只支持设置时间
[in] | handle | 连接句柄 |
[in] | cfg | 配置类型 |
[in] | data | 配置数据 |
[in] | length | 配置数据长度 |