指纹识别API

来自Flyme开放平台
2015年12月14日 (一) 16:53Appadmin讨论 | 贡献的版本

(差异) ←上一版本 | 最后版本 (差异) | 下一版本→ (差异)
跳转至: 导航搜索

一、概述

1、目的
本文档针对说明第三方应用如何使用魅族手机的指纹服务。

2、架构
APP => FingerprintManager => FingerprintService => Fingerprint JNI

二、指纹API

1、open
函数原型:public static FingerprintManager open()
功能描述:创建FingerprintManager实例化对象,从而使用指纹服务。获取的实例化对象需要由调用者主动调用release接口将其释放。
参数描述:无
返回值:
FingerprintManager:返回实例化对象表示成功,后续可通过该对象的方法进行其他操作;
null:失败。

2、release
函数原型:void release();
功能说明:释放调用者通过open获取的实例化对象。当应用完成所需要的操作后,无需进行其他指纹识别操作,必须调用该接口进行释放,应与open成对出现。
参数说明:无
返回值:无

3、abort
函数原型:void abort() ;
功能说明:取消正在进行的指纹操作。
参数说明:无
返回值:无

4、setCaptureCallback
函数原型:public void setCaptureCallback(CaptureCallback captureCallback) ;
功能说明:设置图像捕获的回调函数。
参数说明:
captureCallback:图像捕获回调函数,其接口如下
public static interface CaptureCallback {

 /**
 * Called when the sensor is waiting for the user to touch the senso
r with the finger.
*/
void onWaitingForInput();
 /**
 * Called when the user has put down the finger and the image captur e procedure has started.
 */
void onInput();
 /**
* Called when the image capture procedure has completed.
 */
 void onCaptureCompleted();
void onCaptureFailed(int reason);
 }

返回值:无

5、startEnrol
函数原型:public void startEnrol(EnrolCallback enrolCallback, int fingerId) ;
功能说明:进行指纹注册。
参数说明:
EnrolCallback:指纹注册的回调函数,应用需要自己实现,接口定义如下

public static interface EnrolCallback {
/**
* Called when the enrollment procedure has finished analyzing a fin gerprint image.
 * @param data see more info in GuidedData class
 */
void onProgress(GuidedData data);
 /**
 * Called when the enrollment procedure has finished.
* @param fingerId the identifier used to reference the newly enroll ed fingerprint.
 */
 void onEnrolled(int fingerId);
 /**
 * Called if the enrollment failed.
 */
 void onEnrollmentFailed();
 void onFingerDownTimeOut();
 }

fingerId:标识一个要注册的指纹ID。
返回值:无

6、 startIdentify
函数原型:public void startIdentify(IdentifyCallback identifyCallback, int[] ids) ;
功能说明:进行指纹认证。
参数说明:
identifyCallback:指纹认证的回调函数,应用需要自己实现,其接口定义如下

 public static interface IdentifyCallback {
/**
* Called when the identification/verification procedure has succeed ed to find a match.
* @param fingerId the identifier of the matched fignerprint.
* @param updated set if the fingerprint data acquired during identi fication was used to improve
* the biometric data record for this identity.
*/
 void onIdentified(int fingerId, boolean updated);
 /**
 * Called when the identification/verification procedure has failed to find a match.
 */
void onNoMatch();
 }

ids:已经注册的指纹ID数组,可通过getIds()获得。
返回值:无

7、getIds
函数原型:public int[] getIds() ;
功能说明:获取已经注册的指纹ID列表。
参数说明:无
返回值:
数组:返回已经注册的指纹ID数组,最多支持5个指纹。
null:获取指纹ID失败。

8、deleteFingerData
函数原型:public void deleteFingerData(int fingerId) ;
功能说明:删除指定的指纹。
参数说明:
fingerId:要删除的指纹ID。
返回值:无

导航菜单