文档
YF1016

CS SDK接口文档

YF1016 SDK接口文档 C/S版

# 智能交互终端接口说明

# 服务启动关闭

# TCP与HID连接方法设置hid模式还是tcp模式,默认 hid模式

 Tcp模式HID模式二选一

参数:
isHid - (true HID /false tcp)
ip - (tcp时需要设置IP(端口内部固定8888)
返回值：
成功 0

建议:
程序启动时调用一次即可, 模式切换也可使用此接口,
切换后建议重新设置一次回调函数

DLL_API_EXPORT int DLL_API_CALL GWQ_SetHidAndTcp(const bool isHid, const char* ip = nullptr);

# 检查设备是否在线

函数名称：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秒)

设备返回结果:
通过设置 et_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:需要抄录的文字(最多108字符)

参数2:签字笔线宽(小于或等于0 默认 6)

参数3:多少个文字一行(传入小于或等于0默认3个字一行)

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL GWQ_SignName(const char *msg, const int linewidth, const int number);

# 摄像头功能

功能: 拍照
参数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 GWQ_ReadFingerprint(const int timeout, const int count);

# 拍照手指纹

功能: 指纹采集采集不上调用接口,摄像头拍摄指纹
参数:无设备返回结果:
通过设置 set_callback 回调接收返回值:

成功 0

失败 -1(服务未启动) -2(未连接设备)

 DLL_API_EXPORT int DLL_API_CALL GWQ_SetIsOneByOne();

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

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

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_GetVer();

# 获取设备序列号

功能:获取设备序列号
参数:无
设备返回结果:
通过设置 set_callback 回调接收
返回值:

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL GWQ_GetSN();

# 取消操作

功能:取消当前设备所有操作,返回轮播界面参数:无
设备返回结果:
通过设置 set_callback 回调接收
返回值:

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL GWQ_CancelOperate();

# 发送PC端画面到设备显示

功能:电脑画面发送到设备显示(NET功能, HID无此功能) 参数:

msg
1打开

非1关闭

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL GWQ_StartScreenCapture(const char *msg);

# 发送设备画面到PC端显示

功能:设备同屏到电脑显示(只支持NET, HID模式不支持) 参数:

index - 1打开 0关闭

ip - 设备ip

port - 接收端口号

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL GWQ_StartPreview(int index, const char *ip, unsigned short port);

# 发送html到设备显示

功能:发送html页面到设备显示
参数:

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

path - html静态文件路径或URL

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL GWQ_OpenURL(const char *msg, const char* path);

# PDF文档确认

功能:文档确认参数:

type - 文件类型 0pdf 1html(此接口只能pdf,如需HTML和pdf都能使用请使用 GWQ_PDFConfirmCB 接口)

timeout - 超时时间

optionInfo - 未使用参数传 nullptr 即可

path - pdf文件路径

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL GWQ_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 GWQ_PDFConfirm(const int type, const int timeout, const char* optionInfo, const char*
path);

# 显示柜员信息

功能:柜员信息展示

参数:姓名

参数:工号

参数:职位

设备返回结果:
通过设置 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);

# 软件升级

功能:设备软件升级接口(软件名称必须是pdfviewer,否则设备不予处理)
参数:

msg - 传空即可

path - pdfviewer文件绝对路径

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL GWQ_UpdateFile(const char *msg, const char* path);

# 人证比对1

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

msg - 固定传入"0"

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL GWQ_StartFace(const char *msg);

# 活体检测

功能:活体检测(需设备带摄像头)
参数:

msg - 固定传入"0"

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL GWQ_StartLiveDetection(const char *msg);

# 显示二维码

功能:设置二维码
参数:

msg - 字符串信息json字符串格式 {"msg":"订单号: 0123456789;费用: 10元","time":"30"}

path - 支付码图片绝对路径

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL GWQ_QRCode(const char *msg, const char* path);

# 显示叫号信息牌

功能:叫号信息牌
参数:

msg - 字符串信息json字符串格式 {"name":"测试","number":"10001","post":"测试员","save":0}

path - 操作员人脸图片绝对路径

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL GWQ_CallNumberInfo(const char *msg, const char* path);

# 键盘信息输入

功能:*键盘信息输入
参数:

msg - 字符串信息json字符串格式 {"ret":"0","time":"30"}
ret参数:
0 - 手机号

1 - 密码

2 - 金额

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

 DLL_API_EXPORT int DLL_API_CALL GWQ_Keyboard(const char *msg);

# 设备息屏或亮屏

功能:亮屏息屏
参数:

msg - 0 息屏 1 亮屏

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL GWQ_TheScreenSwitch(const char *msg);

# 设备关机或重启

功能:关机重启
参数:

msg - 0 关机 1 重启

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL GWQ_ShutdownRestart(const char *msg);

# 读取二代证信息2

功能:设备打开读取身份证信息界面
身份证信息接收回调设置参数(setCallbackReadID):

id - 身份证信息回调

回调接收参数demo(On_GWQ_ReadID):

ErrorCode：程序执行代码
0：执行成功

非0：执行失败

JsonData：身份证信息，json结构如下： {"id_num": "身份证号","FrontImgBase64": "身份证照片字节流（BASE64编码）"}

返回值:

0 成功

-1(服务未启动)

-2(未连接设备)

 typedef void (*On_GWQ_ReadID)(int ErrorCode, const char * JsonData);
DLL_API_EXPORT int DLL_API_CALL setCallbackReadID(On_GWQ_ReadID id);
DLL_API_EXPORT int DLL_API_CALL DoGWQ_ReadID(); //读取身份证信息

# 摄像头扫码类别设置

功能:摄像头扫码类别设置(目前只支持二维码识别)
参数:

codeType - 扫码类别
1：二维码

2:一维码

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL GWQ_SetQRCodeType(int codeType);

# 摄像头扫码

功能:打开摄像头扫码(必须先设置扫描类别 GWQ_SetQRCodeType)
参数:无摄像头二维码接收回调设置参数(setCallbackGetQRCode):

QRCode - 摄像头二维码回调

回调接收参数demo(GWQ_GetQRCode):

ErrorCode：程序执行代码 0：执行成功非0：执行失败

QRCode：二维码信息返回值:

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL DoGWQ_GetQRCode();

typedef void (*GWQ_GetQRCode)(int ErrorCode, const char * QRCode);

DLL_API_EXPORT int DLL_API_CALL setCallbackGetQRCode(GWQ_GetQRCode QRCode);

# PDF文档签字,并进行加密

功能:打开签字界面(带加密, 需设备带加密KEY)
参数:

SignerName - 签名人姓名

SignerIDNumType - 签名认证件号类型(身份证，军官证、护照、户口本、其他)

SIgnerIDNum - 签名人证件号

PDFPath - PC端PDF文件路径

SignType - 签字类别 1：电容笔签字

Location - 签字位置坐标格式上,下,左,右逗号分隔

showSignAndFingerType - 签字类型
0：表示接口参数控制签字位置，参数参考Location，

1：表示自由位置签名，用户点哪里就签哪里

timeout - 超时

promptMessage - 提示信息

PMmode - 是否开启声音提示 0关闭, 其他开启

SignDeclaration - 签字声明

FPWidth - 指纹显示区域宽度

SignWidth - 签字区域宽度

LineWidth - 签字线条宽度

加密签字返回信息回调设置参数(GWQ_StartSignEx4): *sign - 加密签字回调

回调接收参数demo(GWQ_StartSignEx4):

ErrorCode：程序执行代码 0：执行成功非0：执行失败

SignPdfBase64 - 加密pdf base64数据或 nullptr

SignNameBase64 - 签字图片 base64数据或 nullptr

FingerPrintBase64 - 无指纹数据一直为 nullptr

XML - 签字轨迹数据 base64数据或 nullptr*

返回值:

成功 0

失败 -1(服务未启动) -2(未连接设备)

typedef void (*GWQ_StartSignEx4)(int ErrorCode,const char* SignPdfBase64, const char* SignNameBase64, const char
*FingerPrintBase64, const char* XML);

 DLL_API_EXPORT int DLL_API_CALL setCallbackStartSignEx4(GWQ_StartSignEx4 sign);

 DLL_API_EXPORT int DLL_API_CALL DoGWQ_StartSignEx4( const char *SignerName, //签名人姓名 const char *SignerIDNumType,
//签名认证件号类型(身份证，军官证、护照、户口本、其他)const char *SIgnerIDNum, //签名人证件号 const
char *PDFPath, //PC端PDF文件路径 const int SignType, //签字类别 1：电容笔签字 const char* Location, //签字位置坐标 格式
上,下,左,右 逗号分隔 const int showSignAndFingerType,//签字类型：0：表示接口参数控制签字位置，参数参考Location，1：表示自由位置签名，用户点哪里就签哪里
const int timeout, //超时 const char* promptMessage, //提示信息 const int PMmode, //是否开启声音提示 0关闭, 其他开启
const char* SignDeclaration, //签字声明 const int FPWidth, //指纹显示区域宽度 const int SignWidth, //签字区域宽度 const
 int LineWidth); //签字线条宽度

# 评价器2

功能:打开评价器
参数:无
加密签字返回信息回调设置参数(setOnAfterAppraise):

AfterAppraise - 评价器结果回调

回调接收参数demo(OnAfterAppraise):

ErrorCode：程序执行代码 0：执行成功非0：执行失败

AppraiseResult：评价结果信息，Json结构，具体如下：
{"appraiseLevel": "", // 评价登记"appraiseContent": "", // 评价内容，为评价内容代码串，以“|”分割"otherAppraiseContent": "" // 其他评价内容 }

返回值:

成功 0

失败 -1(服务未启动) -2(未连接设备)

 typedef void (*OnAfterAppraise)(int ErrorCode, const char * AppraiseResult);
 DLL_API_EXPORT int DLL_API_CALL setOnAfterAppraise(OnAfterAppraise AfterAppraise);
 DLL_API_EXPORT int DLL_API_CALL StartAppraise(); //打开评价器2

# 人证比对2

功能:打开人脸识别
参数:无
加密签字返回信息回调设置参数(setOnAfterGWQ_StartFace):

Face - 人脸识别结果回调

回调接收参数demo(OnAfterGWQ_StartFace):

ErrorCode：程序执行代码
0：执行成功

非0：执行失败

JsonData - 人脸识别结果字符串

返回值:

成功 0

失败 -1(服务未启动) -2(未连接设备)

 typedef void (*OnAfterGWQ_StartFace)(int ErrorCode, const char * JsonData);
 DLL_API_EXPORT int DLL_API_CALL setOnAfterGWQ_StartFace(OnAfterGWQ_StartFace Face);
 DLL_API_EXPORT int DLL_API_CALL DoGWQ_StartFace(); //人脸识别

# 评价器3

功能:评价器3 参数:

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

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL openEvaluate(const char *msg);

# 文档确认(html或PDF)

功能描述:电子签名输入参数:

FilePath 凭证完整路径

Timeout 超时时t间(秒)

ButtonStatus 0,1,显示文字内容I1,1,显示文字内容l2,1,显示文字内容第一个数字是按钮,第二个数字0位隐藏，1为显示按钮

FileType

0 表示pdf

1 表示html

callback 回调函数输出参数: 无

返回值:

成功 0

失败 -1(服务未启动) -2(未连接设备)

typedef void(*caLlback_PDFConfirmCB)(int ErrorCode, char* Buttonstatus);
DLL_API_EXPORT int DLL_API_CALL GWQ_PDFConfirmCB(const char* FilePath, int Timeout, const char* ButtonStatus, int
FileType, caLlback_PDFConfirmCB callback);

# 关键字查询插入PDF

功能:PDF关键字查找插入签字参数:

msg - 插入信息设置{"height":"53","key":"办事人（签字）：","timeout":"1800","width":"96"}
height - 签字图片插入PDF后最大高度

width - 签字图片插入PDF后最大大宽度

key - PDF中查询的关键字(没有找到默认插入左下角)

timeout -超时时间

path - pdf绝对路径

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL designatedSpotSignPdf(const char *msg,const char* path);

# 条形码设备识别

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

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL GWQ_GetQRCodeTwo(); //二维码设备采集

# 评价器4

功能:评价器4
参数:

head - 页面头部文字

department - 办事部门信息

time - 办件时间信息*设备返回结果:

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL StartAppraiseTwo(const char* head, const char* department, const char* time);

# 评价器4选项配置文件更新

功能:评价器配置文件更新(只需设置一次, 调用评价器请调用 StartAppraiseTwo 接口)
参数:

path - 配置文件路径或nullptr(传空路径恢复设备默认选项列表)

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL StartConfigurationInfo(const char* path);

配置文件样例:

# HID心跳包

功能:心跳包(HID)

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

> DLL_API_EXPORT int DLL_API_CALL USBHID_Heartbeat();

# 指定位置签名录指纹

** *功能:指定位置签名录指纹 *输入参数

PDFPath---------凭证完整路径

XmlPath---------XML文件生成路径

Location--------签名或指纹位置 0,1,400,500|1,1,400,500

Retain --------预留项

Timeout---------超时时间

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL DoGWQ_StartSign(const char* PDFPath, const char* XmlPath, const char* Location, const
char* Retain, int Timeout);

# 评价器5

功能:评价器5
输入参数样例:

{"evaluator":[{"evaluatorText":"非常满意","evaluatorLevel":"0","detail":[{"text":"态度很好","code":"501"},{"text":"效率很高","code":"502"}]}]}

{"evaluatorText":"满意","evaluatorLevel":"1","detail":[{"text":"态度好","code":"503"},{"text":"效率高","code":"504"}]}

{"evaluatorText":"一般","evaluatorLevel":"2","detail":[{"text":"态度一般","code":"505"},{"text":"效率一般","code":"506"}]}

{"evaluatorText":"不满意","evaluatorLevel":"3","detail":[{"text":"态度不好","code":"507"},{"text":"效率不高","code":"508"}]}

{"evaluatorText":"非常不满意","evaluatorLevel":"4","detail":[{"text":"态度非常差","code":"509"},{"text":"效率极低","code":"510"}]}

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

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL DoGWQ_StartGoodBadEvaluator(const char* UserJson);

# 获取评价器5用户选择的选项

功能: 获取 DoGWQ_StartGoodBadEvaluator
评价器结果, 没有调用 DoGWQ_StartGoodBadEvaluator 时,调用返回 nullptr
返回值:
评价器返回的json字符串

DLL_API_EXPORT const char* DLL_API_CALL OnAfterGWQ_StartGoodBadEvaluator();

# PDF签字(PDF预览时在右下角按钮上方直接进行签字)

功能:打开pdf并且可悬浮签字界面
参数:

path - pdf文件绝对路径

tmp_cb - 设备返回操作结果后的回调函数

回调函数参数:

json - 设备返回的json字符串信息

signPath - 设备返回的签字图片绝对路径

xmlPath - 设备返回的签字轨迹xml文件绝对路径

返回值:

成功 0

失败 -1(服务未启动) -2(未连接设备)

typedef void (*callback_suspendSign)(const char* json, const char* signPath, const char* xmlPath);
DLL_API_EXPORT int DLL_API_CALL suspendSign(const char* path, callback_suspendSign tmp_cb);

# 评价器6

功能:评价器 6
参数:

UserJson - 评价器参数Json字符串

json字符串样例(detail 选项最多八项, 必须每条一样多,否则解析失败!):

{"head":"公积金业务办理","completedTime":"2021/11/26","doNumber":"123456","unit":
  "单位住房公积金","evaluator":[{"evaluatorText":"非常满意","evaluatorLevel":
  "0","detail":[{"text":"态度很好","code":"501"},{"text":"效率很高","code":"502"}]},
  {"evaluatorText":"满意","evaluatorLevel":
  "1","detail":[{"text":"态度好","code":"503"},{"text":"效率高","code":"504"}]},
  {"evaluatorText":"一般","evaluatorLevel":
  "2","detail":[{"text":"态度一般","code":"505"},{"text":"效率一般","code":"506"}]},
  {"evaluatorText":"不满意","evaluatorLevel":
  "3","detail":[{"text":"态度不好","code":"507"},{"text":"效率不高","code":"508"}]},
  {"evaluatorText":"非常不满意","evaluatorLevel":
  "4","detail":[{"text":"态度非常差","code":"509"},{"text":"效率极低","code":"510"}]}]}

返回值:

成功 0

失败 -1(服务未启动) -2(未连接设备)

DLL_API_EXPORT int DLL_API_CALL DoGWQ_accumulationFundEvaluator(const char *UserJson);

# 错误代码

code	描述
0	成功
-1	服务未启动
-2	连接失败

上次更新: 2023/03/11, 09:20:51

← BS SDK接口文档 CS SDK接口文档→

CS SDK接口文档

# 智能交互终端接口说明

# 服务启动关闭

# TCP与HID连接方法 设置hid模式还是tcp模式,默认 hid模式

# 检查设备是否在线

# 回调定义

# 发送接收回调

# 发送回调

# 接收回调

# 摄像头画面回调设置

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

# 设备功能接口

# 手写签名

# 多字抄录

# 摄像头功能

# 读取二代证信息1

# 单独采集指纹

# 拍照手指纹

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

# 删除轮播图片

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

# 获取当前软件版本号

# 获取设备序列号

# 取消操作

# 发送PC端画面到设备显示

# 发送设备画面到PC端显示

# 发送html到设备显示

# PDF文档确认

# PDF文档批注

# 显示柜员信息

# 评价器1

# 软件升级

# 人证比对1

# 活体检测

# 显示二维码

# 显示叫号信息牌

# 键盘信息输入

# 设备息屏或亮屏

# 设备关机或重启

# 读取二代证信息2

# 摄像头扫码类别设置

# 摄像头扫码

# PDF文档签字,并进行加密

# 评价器2

# 人证比对2

# 评价器3

# 文档确认(html或PDF)

# 关键字查询插入PDF

# 条形码设备识别

# 评价器4

# 评价器4选项配置文件更新

# HID心跳包

# 指定位置签名录指纹

# 评价器5

# 获取评价器5用户选择的选项

# PDF签字(PDF预览时在右下角按钮上方直接进行签字)

# 评价器6

# 错误代码

# TCP与HID连接方法设置hid模式还是tcp模式,默认 hid模式