CS SDK接口文档
# YF0504 SDK接口参考文档
V1.0.0_20230109
# 5寸接口说明
# SDK初始化
函数名称：GWQ_DeviceOnline
功能描述：初始化SDK
输入参数：无
输出参数：无
返回值：参见：错误代码
DLL_API_EXPORT int DLL_API_CALL GWQ_Init();
# SDK释放
函数名称：GWQ_DeviceOnline
功能描述：释放SDK资源
输入参数：无
输出参数：无
返回值：参见：错误代码
DLL_API_EXPORT int DLL_API_CALL GWQ_Release();
# 检查设备是否在线
函数名称：GWQ_DeviceOnline
功能描述：检查设备是否在线
输入参数：无
输出参数：无
返回值：参见：错误代码
DLL_API_EXPORT int DLL_API_CALL GWQ_DeviceOnline();
# 接收回调
功能: 设置回调函数
参数:
callback - 接收回调
回调参数:
type - 指令
data -当前指令包数据(512字节)
path - 接收的文件路径(不带文件时为空(nullptr))
返回值:
成功 0
typedef void (*callback_str_receive)(int type, const char* data, const char* path);
DLL_API_EXPORT int DLL_API_CALL GWQ_setCallback(callback_str_receive callback);
# 同屏回调设置
功能: 同屏数据
参数:
callback - 回调
回调参数:
x - x坐标
y - y坐标
p - 压感
sn - 包编号
typedef void (*callback_signatureData)(int x, int y, int p, int sn);
DLL_API_EXPORT int DLL_API_CALL GWQ_setSignatureData(callback_signatureData callback);
# 二、设备功能接口
# 语言切换
函数名称：GWQ_SwitchLanguage
功能描述：语言切换
输入参数：
language - 语言编号
0 - 中文
1 - 英文
2 - 白板
输出参数：无
返回值：参见：错误代码
DLL_API_EXPORT int DLL_API_CALL GWQ_SwitchLanguage(int language);
# 获取签字图片
函数名称：GWQ_GetImage
功能描述：获取签字图片(用户点击确定后发送)
输入参数：无
输出参数：无
返回值：参见：错误代码
DLL_API_EXPORT int DLL_API_CALL GWQ_GetImage();
# 设置签字图片
函数名称：GWQ_SetImage
功能描述：设置签字图片
输入参数：无
输出参数：无
返回值：参见：错误代码
DLL_API_EXPORT int DLL_API_CALL GWQ_SetImage(const char* path);
# 显示设置的图片
函数名称：GWQ_ShowImage
功能描述：显示设置的图片
输入参数：无
输出参数：无
返回值：参见：错误代码
DLL_API_EXPORT int DLL_API_CALL GWQ_ShowImage();
# 亮屏熄屏
函数名称：GWQ_OnOffScreen
功能描述：亮屏熄屏
输入参数：
type - 1 熄屏 0亮屏
输出参数：无
返回值：参见：错误代码
DLL_API_EXPORT int DLL_API_CALL GWQ_OnOffScreen(const int type);
# 重启设备
函数名称：GWQ_Reboot
功能描述：重启设备
输入参数：
输出参数：无
返回值：参见：错误代码
DLL_API_EXPORT int DLL_API_CALL GWQ_Reboot();
# 打开关闭指纹采集提示
函数名称：GWQ_Fingerprint
功能描述：打开关闭指纹采集提示
输入参数：
type - 1 打开 0或其他 关闭
输出参数：无
返回值：参见：错误代码
DLL_API_EXPORT int DLL_API_CALL GWQ_Fingerprint(const int type);
# 重新签字
函数名称：GWQ_ReSign
功能描述：重新签字
输入参数：无
输出参数：无
返回值：参见：错误代码
DLL_API_EXPORT int DLL_API_CALL GWQ_ReSign();
# 开启关闭报点(同屏报点)
函数名称：GWQ_OnOffPointReporting
功能描述：开启关闭报点
输入参数：
type - 1 开启 0关闭
输出参数：无
返回值：参见：错误代码
DLL_API_EXPORT int DLL_API_CALL GWQ_OnOffPointReporting(const int type);
# 设置开机logo
函数名称：GWQ_SetStartUpLogo
功能描述：设置开机logo
输入参数：
path - 开机logo图片绝对路径
输出参数：无
返回值：参见：错误代码
DLL_API_EXPORT int DLL_API_CALL GWQ_SetStartUpLogo(const char> path);
# 发送签字背景
函数名称：GWQ_SetSigningBackground
功能描述：发送签字背景
输入参数：
data - 签字图片数据
输出参数：无
返回值：参见：错误代码
DLL_API_EXPORT int DLL_API_CALL GWQ_SetSigningBackground(const char> data, const int len);
# 发送签字背景2
函数名称：GWQ_SetSigningBackground2
功能描述：发送签字背景2
输入参数：
data - 签字图片数据
输出参数：无
返回值：参见：错误代码
DLL_API_EXPORT int DLL_API_CALL GWQ_SetSigningBackground2(const char> data, const int len);
# 开始指纹采集
函数名称：GWQ_StartFinger
功能描述：开始指纹采集
输入参数：
type - 指纹颜色 0表示黑色，1表示红色
callback - 签字图片数据
输出参数：无
返回值：参见：错误代码
注意:
指纹库需放在dll 下级目录./Finger/Device*(*表示通配符,具体看Finger目录中文件结构)下,
否则找不到指纹设备
typedef void (*callback_GWQ_StartFinger)(const char* data, const int len);
DLL_API_EXPORT int DLL_API_CALL GWQ_StartFinger(const int type, callback_GWQ_StartFinger callback);
# 停止指纹采集并释放资源
函数名称：GWQ_StartFinger
功能描述：停止指纹采集并释放资源
输入参数：无
输出参数：无
返回值：参见：错误代码
DLL_API_EXPORT int DLL_API_CALL GWQ_StopFinger();
# 错误代码
| code | 描述 |
|---|---|
| 0 | 成功 |
| -1 | SDK未初始化 |
| -2 | 设备打开失败 |