NetSDK  1.0.0.0
NetSDK开发文档
xvrsdk.h
浏览该文件的文档.
1 #ifndef __IPC_SDK_H__
2 #define __IPC_SDK_H__
3 
4 #ifdef __cplusplus
5 extern "C"
6 {
7 #endif
8 
9 #include "interface/errcode.h"
10 
11 #if defined(_MSC_VER)
12  #ifdef XVRSDK_STATIC
13  #define XVRSDK_API
14  #else
15  #ifdef XVRSDK_EXPORTS
16  #define XVRSDK_API __declspec(dllexport)
17  #else
18  #define XVRSDK_API __declspec(dllimport)
19  #endif
20  #endif
21 #else
22 #define XVRSDK_API
23 #endif
24 
26 #define XVR_SDK_FACE_IMAGE_SIZE_MAX (300 * 1024)
27 #define XVR_SDK_FACE_IMAGE_WIDTH_MAX 1080
29 #define XVR_SDK_FACE_IMAGE_HEIGHT_MAX 1080
31 #define XVR_SDK_FACE_FEATURE_VECTOR_SIZE 512
33 #define XVR_SDK_PERSON_ID_MAX_LEN 33
35 #define XVR_SDK_PERSON_NAME_MAX_LEN 33
37 #define XVR_SDK_PERSON_LABEL_MAX_LEN 64
39 
42 {
44  time_t timestamp;
46  int timezone;
47 };
48 
51 {
57  char rtmp_url[512];
58 };
59 
61 typedef enum XVR_SDK_GenderType
62 {
66  Male = 0,
68  Female = 1,
70 
71 
74 {
84  int Age;
89 };
90 
93 {
101  int Age;
104 };
105 
107 typedef struct XSHANDLE XSHANDLE;
108 
111 {
117 
120 {
126 
132 int XVRSDK_API XVR_SDK_Init(void);
133 
139 int XVRSDK_API XVR_SDK_Cleanup(void);
140 
147 int XVRSDK_API XVR_SDK_Create(XSHANDLE **handle);
148 
155 int XVRSDK_API XVR_SDK_Destroy(XSHANDLE *handle);
156 
167 int XVRSDK_API XVR_SDK_Login(XSHANDLE *handle, const char *address, int port, const char *username, const char *password);
168 
176 
186 int XVRSDK_API XVR_SDK_GetDeviceConfig(XSHANDLE *handle, XVR_SDK_DEVICE_CONFIG_TYPE cfg, char *buffer, int size);
187 
197 int XVRSDK_API XVR_SDK_SetDeviceConfig(XSHANDLE *handle, XVR_SDK_DEVICE_CONFIG_TYPE cfg, const char *data, int length);
198 
208 int XVRSDK_API XVR_SDK_FaceRegister(XSHANDLE *handle, const struct XVR_SDK_FaceInfoV2 *info, const char *img_data, int img_len);
209 
217 int XVRSDK_API XVR_SDK_FaceRegisterV1(XSHANDLE *handle, const struct XVR_SDK_FaceInfoV1 *info);
218 
227 int XVRSDK_API XVR_SDK_FaceUnregister(XSHANDLE *handle, const char *person_ids[], int person_cnt);
228 
240 int XVRSDK_API XVR_SDK_FaceList(XSHANDLE *handle, int start, int limit, struct XVR_SDK_FaceInfoV2 result[], const char *condition, int *count);
241 
250 int XVRSDK_API XVR_SDK_Control_Gateway(XSHANDLE *handle, int gateway_index, int control_type);
251 
252 #ifdef __cplusplus
253 };
254 #endif
255 
256 #endif // __IPC_SDK_H__
XVR_SDK_Heartbeat
int XVRSDK_API XVR_SDK_Heartbeat(XSHANDLE *handle)
Check connection alive
Male
Definition: xvrsdk.h:66
XVR_SDK_FaceInfoV1::Name
char Name[XVR_SDK_PERSON_NAME_MAX_LEN+1]
注册人名字
Definition: xvrsdk.h:80
XVR_SDK_DevCfgRtmp
设备RTMP推流配置
Definition: xvrsdk.h:50
errcode.h
XVR_SDK_GetDeviceConfig
int XVRSDK_API XVR_SDK_GetDeviceConfig(XSHANDLE *handle, XVR_SDK_DEVICE_CONFIG_TYPE cfg, char *buffer, int size)
获取设备配置,暂时只支持获取时间配置
XVR_SDK_PERSON_ID_MAX_LEN
#define XVR_SDK_PERSON_ID_MAX_LEN
注册人ID最大长度(字节)
Definition: xvrsdk.h:34
XVR_SDK_FaceUnregister
int XVRSDK_API XVR_SDK_FaceUnregister(XSHANDLE *handle, const char *person_ids[], int person_cnt)
批量删除人脸
XVR_SDK_DevCfgRtmp::rtmp_enable
int rtmp_enable
rtmp推流开关
Definition: xvrsdk.h:53
XVR_SDK_FaceInfoV1::Age
int Age
年龄
Definition: xvrsdk.h:84
XVR_SDK_FaceInfoV1
一代设备人脸注册信息
Definition: xvrsdk.h:73
XVR_SDK_DEVICE_CONFIG_TYPE
XVR_SDK_DEVICE_CONFIG_TYPE
设备配置参数
Definition: xvrsdk.h:119
XVR_SDK_DevCfgTime::timezone
int timezone
时区(秒)
Definition: xvrsdk.h:46
XVRSDK_API
#define XVRSDK_API
Definition: xvrsdk.h:22
XVR_SDK_DevCfgTime::timestamp
time_t timestamp
时间戳
Definition: xvrsdk.h:44
XVR_SDK_FaceInfoV2::Label
char Label[XVR_SDK_PERSON_LABEL_MAX_LEN+1]
注册人标签
Definition: xvrsdk.h:99
XVR_SDK_FaceInfoV1::Feature
double Feature[XVR_SDK_FACE_FEATURE_VECTOR_SIZE]
特征值
Definition: xvrsdk.h:88
XVR_SDK_SetDeviceConfig
int XVRSDK_API XVR_SDK_SetDeviceConfig(XSHANDLE *handle, XVR_SDK_DEVICE_CONFIG_TYPE cfg, const char *data, int length)
设置设备配置,暂时只支持设置时间
XVR_SDK_FaceInfoV2
二代设备人脸注册信息
Definition: xvrsdk.h:92
XVR_SDK_DevCfgRtmp::rtmp_timeout
int rtmp_timeout
rtmp推流超时时长
Definition: xvrsdk.h:55
XVR_SDK_CFG_SEND_TIMEOUT
发送数据超时时间, 默认30秒
Definition: xvrsdk.h:113
XVR_SDK_FaceInfoV1::Label
char Label[XVR_SDK_PERSON_LABEL_MAX_LEN+1]
注册人标签
Definition: xvrsdk.h:82
XVR_SDK_Create
int XVRSDK_API XVR_SDK_Create(XSHANDLE **handle)
创建SDK连接实例
XVR_SDK_DevCfgRtmp::rtmp_url
char rtmp_url[512]
rtmp 服务器地址
Definition: xvrsdk.h:57
XVR_SDK_DevCfgTime
设备时间配置
Definition: xvrsdk.h:41
XVR_SDK_FaceList
int XVRSDK_API XVR_SDK_FaceList(XSHANDLE *handle, int start, int limit, struct XVR_SDK_FaceInfoV2 result[], const char *condition, int *count)
查询人脸信息
XVR_SDK_FaceInfoV2::Name
char Name[XVR_SDK_PERSON_NAME_MAX_LEN+1]
注册人名字
Definition: xvrsdk.h:97
XVR_SDK_DEVCFG_TIME
设备时间, 见
Definition: xvrsdk.h:122
XVR_SDK_FaceInfoV2::Gender
XVR_SDK_GenderType Gender
性别
Definition: xvrsdk.h:103
XSHANDLE
struct XSHANDLE XSHANDLE
SDK连接句柄
Definition: xvrsdk.h:107
Female
Definition: xvrsdk.h:68
XVR_SDK_FaceRegister
int XVRSDK_API XVR_SDK_FaceRegister(XSHANDLE *handle, const struct XVR_SDK_FaceInfoV2 *info, const char *img_data, int img_len)
注册人脸(适用于二代设备)
XVR_SDK_Login
int XVRSDK_API XVR_SDK_Login(XSHANDLE *handle, const char *address, int port, const char *username, const char *password)
登陆设备
XVR_SDK_PERSON_LABEL_MAX_LEN
#define XVR_SDK_PERSON_LABEL_MAX_LEN
注册人标签最大长度(字节)
Definition: xvrsdk.h:38
XVR_SDK_DEVCFG_RTMP
设备推流配置
Definition: xvrsdk.h:124
XVR_SDK_FaceInfoV1::PersonID
char PersonID[XVR_SDK_PERSON_ID_MAX_LEN+1]
注册人ID
Definition: xvrsdk.h:76
XVR_SDK_FaceInfoV1::FaceID
char FaceID[XVR_SDK_PERSON_ID_MAX_LEN+1]
注册人脸ID
Definition: xvrsdk.h:78
XVR_SDK_GenderType
XVR_SDK_GenderType
性别
Definition: xvrsdk.h:61
XVR_SDK_Destroy
int XVRSDK_API XVR_SDK_Destroy(XSHANDLE *handle)
释放并关闭SDK连接实例
XVR_SDK_FaceRegisterV1
int XVRSDK_API XVR_SDK_FaceRegisterV1(XSHANDLE *handle, const struct XVR_SDK_FaceInfoV1 *info)
注册人脸(适用于一代设备)
XVR_SDK_FaceInfoV1::Gender
XVR_SDK_GenderType Gender
性别
Definition: xvrsdk.h:86
XVR_SDK_CFG_RECV_TIMEOUT
接收数据超时时间, 默认30秒
Definition: xvrsdk.h:115
XVR_SDK_FaceInfoV2::Age
int Age
年龄
Definition: xvrsdk.h:101
XVR_SDK_CONFIG_TYPE
XVR_SDK_CONFIG_TYPE
SDK配置参数
Definition: xvrsdk.h:110
XVR_SDK_Cleanup
int XVRSDK_API XVR_SDK_Cleanup(void)
SDK全局反初始化
XVR_SDK_FACE_FEATURE_VECTOR_SIZE
#define XVR_SDK_FACE_FEATURE_VECTOR_SIZE
注册脸图特征值向量大小
Definition: xvrsdk.h:32
XVR_SDK_PERSON_NAME_MAX_LEN
#define XVR_SDK_PERSON_NAME_MAX_LEN
注册人名字最大长度(字节)
Definition: xvrsdk.h:36
XVR_SDK_FaceInfoV2::PersonID
char PersonID[XVR_SDK_PERSON_ID_MAX_LEN+1]
注册人ID
Definition: xvrsdk.h:95
XVR_SDK_Control_Gateway
int XVRSDK_API XVR_SDK_Control_Gateway(XSHANDLE *handle, int gateway_index, int control_type)
远程门禁控制
Unspecified
未指定
Definition: xvrsdk.h:64
XVR_SDK_Init
int XVRSDK_API XVR_SDK_Init(void)
SDK全局初始化