Android开发文档
Android开发文档
目录
# 手写签字
# 引用签字控件
使用方式：在布局中引用SignView控件
# 设置签字笔颜色
void setPenColor(int color)
使用方式：SignView控件方法
入参：颜色值
返回：空
# 设置签字笔最小宽度
void setMinWidth(float minWidth)
使用方式：SignView控件方法
入参：最小宽度值
返回：空
# 设置签字笔最大宽度
void setMaxWidth(float maxWidth)
使用方式：SignView控件方法
入参：最大宽度值
返回：空
# 获取签字Bitmap
Bitmap getSignatureBitmap()
使用方式：SignView控件方法
入参：无
返回：签字Bitmap
# 获取所有签字点对象
List < SignPoint > getAllPoints()
使用方式：SignView控件方法
入参：最大宽度值
返回：签字点对象列表（属性见下表）
| **参数 | 数据类型 | 含义 | 值说明 |
|---|---|---|---|
| act | int | 签字点类型 | 0:按下；1:离开；2:移动 |
| timestamp | long | 签字时间戳 | |
| x | float | 签字x坐标 | |
| y | float | 签字y坐标 | |
| pressure | float | 签字压力值 | 0~2047 |
# **清空签字
void clear()
使用方式：SignView控件方法
入参：无
返回：空
# 指纹采集
# 新建指纹助手
FingerHelper(Context context)
使用方式：new
入参：Context
返回：指纹助手对象
# 设置指纹采集监听
void setFingerListener(FingerListener listener)
使用方式：FingerHelper对象方法
入参：指纹采集监听，实现其方法，在此方法中获取返回数据（详见3）
返回：空
# FingerListener接口方法
void onCatched(int quality, Bitmap image, byte[]fingerData)
参数1：指纹质量
参数2：指纹图片bitmap
参数3：指纹图片字节数组数据
void onError(int code, String msgStr)
参数1：错误代码
参数2：错误信息
# 打开指纹设备
int open()
使用方式：FingerHelper对象方法
入参：无
返回：1打开成功；其他值打开失败。
# 关闭指纹设备
boolean close()
使用方式：FingerHelper对象方法
入参：无
返回：true（关闭成功）、false（关闭失败）
# 采集指纹
void getFingerImage(boolean isLive)
使用方式：FingerHelper对象方法
入参：true（持续采集）、false（采集一次）
返回：空
# 停止采集
void stopGetFinger()
使用方式：FingerHelper对象方法
入参：无
返回：空
# 设置指纹颜色
void setFingerColor(int color)
使用方式：FingerHelper对象方法
入参：颜色值[默认红色]
返回：空
# 设置指纹背景颜色
void setFingerBackColor(int color)
使用方式：FingerHelper对象方法
入参：颜色值[默认透明]
返回：空
# 释放资源
void release()
使用方式：FingerHelper对象方法
入参：无
返回：空
# 身份证读取
# 新建读卡助手
CardHelper(Context context)
使用方式：new
入参：Context
返回：读卡助手对象
# 设置卡监听
void setCardListener(CardHelper.CardListener listener)
使用方式：CardHelper对象方法
入参：卡监听，实现其方法，在接口方法中获取返回数据（详见3）
返回：空
# 卡监听接口方法
void onReadIDCard(IDCard idCard)
返回参数：身份证对象，主要属性说明见下表
| 属性名 | 数据类型 | 含义 | 备注 |
|---|---|---|---|
| name | String | 姓名 | |
| sex | String | 性别 | |
| nation | String | 民族 | |
| birth | String | 出生日期 | |
| address | String | 住址 | |
| idNumber | String | 身份证号 | |
| depart | String | 发证机关 | |
| validityTime | String | 有效期限 | |
| photo | Bitmap | 照片 | 身份证照片 |
void onOpen(intresult, String msg)
返回参数1：CardHelper. OPEN_FAIL（失败）、CardHelper. OPEN_SUCCESS（成功）
返回参数2：结果信息
void onError(int code, String msg)
返回参数1：错误代码
返回参数2：错误信息
# 打开读卡设备
void open()
使用方式：CardHelper对象方法
入参：无
返回：空（结果在监听方法中获取，见3）
# 关闭读卡设备
void close()
使用方式：CardHelper对象方法
入参：无
返回：空
# 读身份证
void readIDCard(boolean isLive)
使用方式：CardHelper对象方法
入参：true连续读卡，false读一次
返回：空（结果在监听方法中获取，见3）
# 停止读卡
void stopRead()
使用方式：CardHelper对象方法
入参：无
返回：空
# 人脸比对
# 新建人脸比对管理类
FacePassManager(Context ct, CameraPreview RGBCameraView, CameraPreview IRCameraView, FaceView faceView)
使用方式：new
入参：Context，彩色相机控件，红外相机控件，人脸识别框控件
返回：人脸比对管理对象
# 打开相机（开始预览）
void openCamera()
使用方式：FacePassManager对象方法
入参：无
返回：空
# 开始人脸比对
void startFacePass(Bitmap photo, FacePassManager.FacePassListener listener)
使用方式：FacePassManager对象方法
入参1：包含人脸照片
入参2：人脸比对监听，实现其onPacePassed方法，在此方法中获取返回数据（详见4）
返回：空
# 接口onPacePassed方法
void onPacePassed(int result, float score, float liveScore, Bitmap face)
参数1：比对结果（值含义见下表）
参数2：人脸相似度值（越大越相似）
参数3：活体度值（越大越为活体）
参数4：抓取的人脸bitmap
| 参数 | 含义 |
|---|---|
| FacePassManager.PASS_RES_SUCCESS | 比对正常（非比对通过，通过与否由相似度值判断） |
| FacePassManager.PASS_RES_IDCARD_NO_FACE | 传入的照片（比如身份中读取的）未识别到人脸 |
| FacePassManager.PASS_RES_PHOTO_NO_IMAGE | 抓取的照片无图像（抓取失败） |
| FacePassManager.PASS_RES_PHOTO_NO_FACE | 抓取的照片未识别到人脸 |
# 停止人脸比对
void stopFacePass()
使用方式：FacePassManager对象方法
入参：无
返回：空
# 获取人脸识别框方向是否镜像
boolean getFaceViewMirror()
使用方式：FacePassManager对象方法
入参：无
返回：true（镜像）、false（无镜像）
# 设置人脸识别框方向是否镜像
void setFaceViewMirror(boolean mirror)
使用方式：FacePassManager对象方法
入参：true（镜像）、false（无镜像）
返回：空
# 设置彩色相机 VID、PID
void setRgbCameraVidPid(int vid, int pid)
使用方式：FacePassManager对象方法（应当在调用打开相机前调用）
入参：彩色相机的 vid 和 pid
返回：空
# 设置红外相机 VID、PID
void setIrCameraVidPid(int vid, int pid)
使用方式：FacePassManager对象方法（应当在调用打开相机前调用）
入参：红外相机的 vid 和 pid
返回：空
# 设置活体检测使能
void setLivenessEnable(boolean enable)
使用方式：FacePassManager对象方法（应当在调用打开相机前调用）
入参：true（默认，进行活体检测，需要红外相机）、false（不进行活体检测）
返回：空
# 释放资源
void release()
使用方式：FacePassManager对象方法
入参：无
返回：空
# 高拍仪（相机）
# 新建相机助手
CameraHelper(Context context)
使用方式：new
入参：Context
返回：相机助手对象
# 设置预览SurfaceView
void setPreviewDisplay(SurfaceView sv)
使用方式：CameraHelper对象方法
入参：SurfaceView
返回：空
# 设置预览SurfaceView
void setCameraListener(CameraListener cameraListener)
使用方式：CameraHelper对象方法
入参：相机监听，实现其接口方法，获取返回数据（详见4）
返回：空
# 相机监听CameraListener接口方法
void onOpened(int res, String msg);
参数1：1为打开相机成功，其他值为打开失败
参数2：详细信息
void onClosed(int res, String msg);
参数1：1为关闭相机成功，其他值为关闭失败
参数2：详细信息
void onPreviewFrame(Bitmap bitmap);
参数1：预览帧图片
void onPictureTaken(Bitmap photo);
参数1：拍照结果图片
# 打开相机
void openCamera();
void openCamera(int id);
使用方式：CameraHelper对象方法
入参：相机ID号（不传默认打开ID为0的相机）
返回：空（打开结果在CameraListener接口中获取，详见4）
# 关闭相机
void closeCamera()
使用方式：CameraHelper对象方法
入参：无
返回：空（关闭结果在CameraListener接口中获取，详见4）
# 切换相机
void changeCamera()
使用方式：CameraHelper对象方法
入参：无（按ID顺序，循环切换）
返回：空
# 拍照
void takePhoto()
使用方式：CameraHelper对象方法
入参：无
返回：空（拍照结果在CameraListener接口中获取，详见4）
# 释放相机资源
void release()
使用方式：CameraHelper对象方法，应当在使用完相机后调用，释放相机资源
入参：无
返回：空
# USBHID通讯
# 获取通讯对象
static USBHidHelper getInstance()
入参：无
返回：通讯助手USBHidHelper对象
# 打开USBHID通讯
void open(String path)
使用方式：USBHidHelper对象方法
入参：接收文件存放路径
返回：空
# 关闭USBHID通讯
void close()
使用方式：USBHidHelper对象方法
入参：空
返回：空
# 设置通讯监听
void setHidListener(USBHidListener listener)
使用方式：USBHidHelper对象方法
入参：通讯监听接口（详见5）
返回：空
# 通讯监听接口方法
void onReceivedMsg(USBHidMsg msg)
参数：上位机发送的消息（指令）对象（属性见表1）
| 属性 | 类型 | 含义 | 值说明 | |
|---|---|---|---|---|
| work | int | 业务类型 | ||
| USBHidHelper. WORK_SIGNAL | 签字 | |||
| USBHidHelper. WORK_CAMERA | 相机 | |||
| USBHidHelper. WORK_FACE_PASS | 人脸比对 | |||
| USBHidHelper. WORK_ID_CARD | 身份证 | |||
| USBHidHelper. WORK_FINGERPRINT | 指纹 | |||
| USBHidHelper. WORK_PDF_READER | PDF文件阅读 | |||
| USBHidHelper. WORK_PDF_EDIT | PDF文件编辑 | |||
| USBHidHelper. WORK_EMPLOYEE | 员工信息展示 | |||
| USBHidHelper. WORK_SCORE | 员工评价 | |||
| USBHidHelper. WORK_FILE_UPLOAD | 上位机传文件 | |||
| USBHidHelper. WORK_FILE_DELETE | 删除文件 | |||
| USBHidHelper. WORK_CANCEL | 取消操作 | |||
| cameraOperate | int | 相机操作 | ||
| USBHidHelper. CAMERA_OPEN | 打开相机 | |||
| USBHidHelper. CAMERA_PHOTO | 拍照 | |||
| USBHidHelper. CAMERA_START_REC | 开始录像 | |||
| USBHidHelper. CAMERA_STOP_REC | 停止录像 | |||
| USBHidHelper. CAMERA_CLOSE | 关闭相机 | |||
| USBHidHelper. CAMERA_START_STREAM | 开启预览流 | |||
| USBHidHelper. CAMERA_STOP_STREAM | 停止预览流 | |||
| USBHidHelper. CAMERA_OPEN_VIEW | 打开预览界面 | |||
| signLineWidth | int | 签字线宽 | 签字业务时，设置签字线度 | |
| data | String | 数据 | 其他JSON字符串 |
void onReceivedFile(String path, int progress , int work)
参数1：接收的文件保存的路径
参数2：接收进度百分比
参数3：业务类型（详见表1）
# 发送数据
void send(USBHidData data)
使用方式：USBHidHelper对象方法
入参：USBHid数据对象（属性详见表2）
返回：空
| 属性 | 类型 | 含义 | 值说明 | |
|---|---|---|---|---|
| type | int | 数据类型 | USBHidHelper. TYPE_MSG | 纯文本消息 |
| USBHidHelper. TYPE_MSG_FILE | 文本+文件 | |||
| USBHidHelper. TYPE_SCREEN | 同屏 | |||
| USBHidHelper. TYPE_STREAM | 视频流 | |||
| work | int | 业务类型 | 详见表1 | |
| result | String | 执行结果 | “0”为执行成功，其他执行失败 | |
| resultAdd | String | 附加结果 | 目前仅用于人证比对时返回身份证信息 | |
| filePaths | String[] | 文件路径数组 | 文本+文件类型时传给上位机的文件的路径数组 | |
| fileData | Byte[] | 视频流字节数组 | 视频流类型时的帧图片字节数组 |