harmony 鸿蒙HdfFaceAuth

HdfFaceAuth

提供人脸认证驱动的标准API接口。

人脸认证驱动为人脸认证服务提供统一的访问接口。获取人脸认证驱动代理后，人脸认证服务可以调用相关接口获取执行器，获取人脸认证执行器后，人脸认证服务可以调用相关接口获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。

Since:

3.2

名称	描述
FaceAuthTypes.idl	定义人脸认证驱动的枚举类和数据结构。
IExecutor.idl	定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。
IExecutorCallback.idl	定义异步API接口回调，用于返回异步接口的请求处理结果和信息。
IFaceAuthInterface.idl	定义获取人脸认证驱动的执行器列表接口，用于从人脸认证驱动获取执行器对象列表。

名称	描述
ExecutorInfo	struct 执行器信息。
TemplateInfo	struct 凭据模版信息。
IExecutor	interface 定义执行器接口，用于获取执行器，获取凭据模版信息，注册人脸特征模版，进行用户人脸认证，删除人脸特征模版等。
IExecutorCallback	interface 定义异步API接口回调，用于返回异步接口的请求处理结果和信息。使用细节见IExecutor。
IFaceAuthInterface	interface 定义获取人脸认证驱动的执行器列表接口。

名称	描述
AuthType : int { PIN = 1, FACE = 2, FINGERPRINT = 4 }	枚举用户认证凭据类型。
ExecutorRole : int { COLLECTOR = 1, VERIFIER = 2, ALL_IN_ONE = 3 }	枚举执行器角色。
ExecutorSecureLevel : int { ESL0 = 0, ESL1 = 1, ESL2 = 2, ESL3 = 3 }	枚举执行器安全等级。
CommandId : int { LOCK_TEMPLATE = 1, UNLOCK_TEMPLATE = 2, VENDOR_COMMAND_BEGIN = 10000 }	枚举人脸认证功能相关操作命令。
FaceTipsCode : int { FACE_AUTH_TIP_TOO_BRIGHT = 1, FACE_AUTH_TIP_TOO_DARK = 2, FACE_AUTH_TIP_TOO_CLOSE = 3, FACE_AUTH_TIP_TOO_FAR = 4,   FACE_AUTH_TIP_TOO_HIGH = 5, FACE_AUTH_TIP_TOO_LOW = 6, FACE_AUTH_TIP_TOO_RIGHT = 7, FACE_AUTH_TIP_TOO_LEFT = 8,   FACE_AUTH_TIP_TOO_MUCH_MOTION = 9, FACE_AUTH_TIP_POOR_GAZE = 10, FACE_AUTH_TIP_NOT_DETECTED = 11, VENDOR_FACE_AUTH_TIP_BEGIN = 10000 }	枚举提示信息编码。

名称	描述
package ohos.hdi.face_auth.v1_0	人脸认证接口的包路径。

enum AuthType : int

描述:

枚举用户认证凭据类型。

enum CommandId : int

描述:

枚举人脸认证功能相关操作命令。

enum ExecutorRole : int

描述:

枚举执行器角色。

枚举值	描述
COLLECTOR	执行器角色为采集器，提供用户认证时的数据采集能力，需要和认证器配合完成用户认证。
VERIFIER	执行器角色为认证器，提供用户认证时数据处理能力，读取存储凭据模板信息并完成比对。
ALL_IN_ONE	执行器角色为全功能执行器，可提供用户认证数据采集、处理、储存及比对能力。

enum ExecutorSecureLevel : int

描述:

枚举执行器安全等级。

枚举值	描述
ESL0	执行器安全级别为0，关键操作在无访问控制执行环境中完成。
ESL1	执行器安全级别为1，关键操作在有访问控制的执行环境中完成。
ESL2	执行器安全级别为2，关键操作在可信执行环境中完成。
ESL3	执行器安全级别为3，关键操作在高安环境如独立安全芯片中完成。

enum FaceTipsCode : int

描述:

枚举提示信息编码。