有方信息
  • 文档
  • YFD101
有方信息
2023-02-28
目录

CS SDK接口文档

YFD101 SDK接口文档 （CS版）

# 智能交互终端接口说明

# 服务启动关闭

# 检查设备是否在线

函数名称：GWQ_DeviceOnline
功能描述：检查设备是否在线
输入参数：无
输出参数：无
返回值：参见：错误代码

DLL_API_EXPORT int DLL_API_CALL GWQ_DeviceOnline();

# 回调定义

# 发送接收回调

功能:设置回调函数
参数:

  • tmp_send_cb - 发送结果回调
  • tmp_receive_cb - 接收回调

返回值:

  • 成功 0
typedef void (callback_str_send)(int ret); //发送回调
typedef void (callback_str_receive)(int cmd, const char* msg, const char* array[], int len); //接收回调
DLL_API_EXPORT int DLL_API_CALL set_callback(callback_str_send* tmp_send_cb, callback_str_receive* tmp_receive_cb);

# 摄像头画面回调设置

功能:
设置摄像头画面回调
参数:

  • data - 接收的摄像头画面

回调参数:

  • data - 图片数据
  • len - 图片数据长度

返回值:

  • 成功 0
  • 失败 -1(服务未启动)
typedef void (*USBHID_IMAGE_DATA)(const char* data, const int len);
DLL_API_EXPORT int DLL_API_CALL USBHID_setImageData(USBHID_IMAGE_DATA data);

# 文件发送接收时进度回调

功能:
设置发送接收文件进度回调(可选项, 不设置不触发回调)
返回值:

  • 成功 0
  • 失败 -1(服务未启动)
typedef void (*callback_schedule)(int min, int max);
DLL_API_EXPORT int DLL_API_CALL set_callback_schedule(callback_schedule tmp_send_cb);

# 设备功能接口

# 手写签名

功能:
手写名字（采集手写图片和轨迹数据）

  • 参数1:*签字图片保存路径(路径错误为空或错误保存在默认目录下)
  • 参数2:*签字xml数据文件保存路径(路径错误为空或错误保存在默认目录下)
  • 参数3:*签字笔线宽(小于或等于0 默认 6)
  • 参数4:*签字超时时间,单位:秒(小于或等于0 默认 1000秒)

设备返回结果:
通过设置 set_callback 回调接收
返回值:

  • 成功 0
  • 失败 -1(服务未启动) -2(未连接设备)
DLL_API_EXPORT int DLL_API_CALL GWQ_SignNameEx(const char *signPath, const char* xmlPath, const int linewidth, const int
timeout);

# 摄像头功能

功能:拍照

  • 参数1:文件保存文件夹路径
  • 参数2:相机指令(
    • 0 打开相机,
    • 1 拍照,
    • 2 开始采集视频(第三个参数可传超时时间单位:分钟),
    • 3 停止采集视频,
    • 4 关闭相机
    • 5 打开视频传输
    • 6 关闭视频传输
    • 7 用户手动拍照
    • 8 手动获取拍照图片
    • 9 手动获取视频和录音
  • 参数3:相机参数(默认打开相机传
    • {"GWQ_GetFrame":"0","order":3843,"stringarray":["640","480","0"],"type":"1"}, 不是打开相机传空)
  • 参数4:相机参数长度

设备返回结果:
通过设置 set_callback 回调接收
返回值:

  • 成功 0
  • 失败 -1(服务未启动) -2(未连接设备)
DLL_API_EXPORT int DLL_API_CALL GWQ_GetFrame(const char* path, const char *msg, const char *str[] = nullptr, const int
len_2 = -1);//普通拍照

# 读取二代证信息1

功能:打开读取二代证读取界面 参数:

  • msg - 设置超时时间格式: {"timeout":"1800"}

设备返回结果:
通过设置 set_callback 回调接收
返回值:

  • 成功 0
  • 失败 -1(服务未启动) -2(未连接设备)
DLL_API_EXPORT int DLL_API_CALL GWQ_ReadID(const char *msg);

# 单独采集指纹

功能:指纹采集，设置指纹最大采集次数

  • 参数1:超时时间
  • 参数2:指纹采集上限

设备返回结果:
通过设置 set_callback 回调接收
返回值:

  • 成功 0
  • 失败 -1(服务未启动) -2(未连接设备)
DLL_API_EXPORT int DLL_API_CALL GWQBJCA_ReadFingerprint(const int timeout, const int count);

# 设置轮播图片和轮播时间

功能:设置轮播图片或待机界面,并设置切换时间
参数:

  • time - 切换时间
  • array - 图片路径数组
  • len - 图片路径数量

设备返回结果:
通过设置 set_callback 回调接收
返回值:

  • 成功 0
  • 失败 -1(服务未启动) -2(未连接设备)
DLL_API_EXPORT int DLL_API_CALL GWQ_FileUpload(const char *time, const char* array[], const int len);

# 删除轮播图片

功能:删除单张或多张轮播图片或设置的单张待机图片
参数:

  • msg - 要删除的图片名称,如需删除全部设置的图片传入-1即可
    • 设备中的图片文件名可通过 调用GWQ_FileListTime()接口,在接受回调中收到当前设备中的图片列表

设备返回结果:
通过设置 set_callback 回调接收
返回值:

  • 成功 0
  • 失败 -1(服务未启动) -2(未连接设备)
DLL_API_EXPORT int DLL_API_CALL GWQ_FileDelete(const char *msg);

# 获取轮播时间和录播图片列表

功能:获取设备中设置的轮播图片和切换时间
参数:无

设备返回结果:
通过设置 set_callback 回调接收
返回值:

  • 成功 0
  • 失败 -1(服务未启动) -2(未连接设备)
DLL_API_EXPORT int DLL_API_CALL GWQ_FileListTime();

# 取消操作

功能:取消当前设备所有操作,返回轮播界面 参数:无

设备返回结果:
通过设置 set_callback 回调接收
返回值:

  • 成功 0
  • 失败 -1(服务未启动) -2(未连接设备)
DLL_API_EXPORT int DLL_API_CALL GWQ_CancelOperate();

# PDF文档确认

功能:文档确认 参数:

  • type - 文件类型 0pdf 1html
    • (此接口只能pdf,如需HTML和pdf都能使用*请使用 GwQBJCA_PDFConfirmCB 接口)
  • timeout - 超时时间
  • optionInfo - 未使用参数传 nullptr 即可
  • path - pdf文件路径

设备返回结果:
通过设置 set_callback 回调接收
返回值:

  • 成功 0
  • 失败 -1(服务未启动) -2(未连接设备)
DLL_API_EXPORT int DLL_API_CALL GWQBJCA_PDFConfirm(const int type, const int timeout, const char* optionInfo, const
char* path);

# PDF文档批注

功能:文档批注(点击签字位置弹出签字和指纹采集界面)
参数:

  • msg - 设置超时时间格式:
    • {"timeout":"1800"}
  • path - pdf文件路径

设备返回结果:
通过设置 set_callback 回调接收
返回值:

  • 成功 0
  • 失败 -1(服务未启动) -2(未连接设备)
DLL_API_EXPORT int DLL_API_CALL GWQBJCA_PDFPostil(const char *msg, const char* path);

# 显示柜员信息

功能:柜员信息展示

  • 参数1:姓名
  • 参数2:工号
  • 参数3:职位

设备返回结果:
通过设置 set_callback 回调接收
返回值:

  • 成功 0
  • 失败 -1(服务未启动) -2(未连接设备)
DLL_API_EXPORT int DLL_API_CALL GWQ_TellerInfo(const char *name, const char* number, const char* post, const char* path,
const int save);

# 评价器1

功能:评价器(3,5,7阶)

  • 参数1:姓
  • 参数2:部门
  • 参数3:工号
  • 参数4:评级分数(0-100)
  • 参数5:评价器等级(3,5,7)
  • 参数6:超时时间
  • 参数7:员工照片

设备返回结果:
通过设置 set_callback 回调接收
返回值:

  • 成功 0
  • 失败 -1(服务未启动) -2(未连接设备)
DLL_API_EXPORT int DLL_API_CALL GWQ_StartEvaluator(const char *name, const char *department, const char *jobnumber,
const int starlevel, const int evaluateorder,const int time, const char *path);

# 人证比对1

功能:人证比对(需设备带身份证模块和摄像头)
参数:

  • msg - 固定传入"0"*

设备返回结果:
通过设置 set_callback 回调接收
返回值:

  • 成功 0
  • 失败 -1(服务未启动) -2(未连接设备)
DLL_API_EXPORT int DLL_API_CALL GWQ_StartFace(const char *msg);

# 条形码设备识别

功能:条形码识别(需设备添加条形码扫描设备)

  • 参数:无

设备返回结果:
通过设置 set_callback 回调接收
返回值:

  • 成功 0
  • 失败 -1(服务未启动) -2(未连接设备)
DLL_API_EXPORT int DLL_API_CALL GWQ_GetQRCodeTwo(); //二维码设备采集

# 错误代码

code 描述
0 成功
-1 服务未启动
-2 连接失败
上次更新: 2023/03/11, 09:20:51
CS SDK接口文档
BS SDK接口文档

← BS SDK接口文档→

Theme by Vdoing | Copyright © 2018-2023 Haveways | 粤ICP备18079728号-1

×