Face SDK iOS开发文档

目录

11 简介
2  1.1 功能介绍	
3  1.2 兼容性	
4  1.3 开发包说明	
52 集成指南	
6  2.1 Sample示例	
7  2.2 准备工作	
8    2.2.1 申请license	
9    2.2.2 下载SDK	
10  2.3 运行示例工程	
11    2.3.1自动配置授权信息集成	
12    2.3.2 未使用自动配置授权信息的集成	
13  2.4添加SDK到工程	
14  2.5权限声明	
153 功能使用	
16  3.1 活体识别	
17  3.2人脸采集	
18  3.3质量校验设置	
19  3.4 界面定制说明	
20  3.5接口设计说明	
21    3.5.1 DetectRemindCode	
22    3.5.2 FaceLivenessActionType	
23    3.5.3 LivenessRemindCode	
24  3.6创建实例	
25  3.7 设置人脸功能控制参数	
26  3.8 取得人脸图像采集功能接口	
27  3.9 取得活体检测功能接口	
28  3.10 设置人脸图像采集功能参数	
29  3.11 设置人脸功能控制参数	
30  3.12 活体动作设置	
314 常见问题	

1、简介

1.1 功能介绍

​ 百度Face SDK IOS 版是一种面向 IOS 移动设备人脸技术开发包，此版SDK包含人脸检测、活体识别等功能。基于该方案，开发者可以轻松的构建包含人脸检测、采集和活体识别的应用。在您使用SDK之前，我们首先为您介绍以下SDK本身及相关人脸能力，以便您能更方便使用人脸服务。

此版SDK所包含的能力如下：

• 本地版活体检测：通过让用户做出指定人脸配合式的交互动作，识别当前操作者是否为活体，此功能为离线使用，可设定指定动作是否使用及应用顺序。动作包含：眨眼、张嘴、左摇头，右摇头，摇摇头、向上抬头，向下低头七个。可有效抵御高清图片、3D建模、视频等攻击。
• 本地版人脸质量检测：判断视频流中的图片帧中，哪些图片质量较佳，即人脸图像特征清晰（满足角度、姿态、光照、模糊度等校验）。
• 本地版人脸图像采集：通过本地SDK能力，采集人脸图像，同时经过人脸质量检测，确保采集到的人脸图像符合各条件校验（角度、姿态、光照、模糊度等），为设备前端获取有效可分析人脸的主要功能。
• 离线授权：SDK的授权判断，授权介质也称为license，在SDK使用中，需要通过license向授权服务器发起请求，判断SDK的使用合法性及使用有效期。

此版SDK全部功能为离线版本，所有功能均本地化使用，主要用于在客户端（Android）获取人脸，实际业务使用中，可以按照业务需要，配合在线API完成全流程的业务集成。

为了方便您的开发，我们已经为您准备了多种场景的示例工程，您可以根据业务需要，在后台进行直接下载，目前支持【人脸核身】【人脸闸机/门禁】【人脸登录/考勤】【多人脸识别】,示例工程参考下图：

1.2 兼容性

• 系统：支持iOS8以上系统。需要开发者通过Deployment Target 来保证支持系统的检测。
• 机型：手机和平板皆可
• 网络：支持 WIFI 及移动网络,移动网络支持使用 NET 网关及WAP 网关(CMWAP、CTWAP、UNIWAP、3GWAP)。

1.3 开发包说明##

2、集成指南

2.1 Sample示例

• 把脸移入框内

  

  ​

• 慢慢低头

  

  ​

• 慢慢抬头

  ​

  

• 未检测到人脸

  ​

  

• 向左缓慢摇头

  

  ​

2.2 准备工作

2.2.1 申请license

人脸SDK License：此license用于SDK离线功能使用，在您的申请人脸SDK的后台页面，全局->产品服务->人脸识别->客户端SDK申请

人脸控制台路径如下：

点击客户端SDK管理，弹出如下图：创建应用（这里创建应用是为了使用离线SDK，上面创建应用为了使用人脸在线接口，如注册、识别等）

在弹出的框中输入授权标识，选择应用类型，应用系统，以及包名，详情请查看输入框右边提示

2.2.2 下载SDK

下载SDK分为自动配置授权信息（创建license后就可以选择为该应用，下载后SDK自动帮您配置授权，不用下载license拷贝到工程中，初始化参数licenseID,包名也帮您配置好了）和未配置授权信息两种方式：

2.3 运行示例工程

2.3.1 自动配置授权信息集成

如果您是通过自动配置授权信息下载的示例工程，只需配置好证书即可。查看下项目中的FaceParameterConfig.h文件，已经自动配置

配置好证书，即可运行。注意已经设置好的bundle id不要随意改动。

2.3.2 未使用自动配置授权信息的集成

打开或者新建一个项目。

右键点击项目，会出现一个添加菜单，在菜单中选择『Add Files to“此处是你的项目名字”…… 』,如下图所示：

2.4 添加SDK到工程##

1. 打开或者新建一个项目。
2. 右键点击项目，会出现一个添加菜单，在菜单中选择『Add Files to“此处是你的项目名字”…… 』,如下图所示：

3. 在添加文件弹出框里面选择申请到的license和SDK添加进来。如下图：

注意：license为百度官方提供的。

SDK包含下面三个文件:

• IDLFaceSDK.framework
• com.baidu.idl.face.faceSDK.bundle
• com.baidu.idl.face.model.bundle

4. 确认下Bundle Identifier 是否是申请license时填报的那一个，注意：license和Bundle Identifier是一一对应关系，填错了会导致SDK不能用。
5. 填写正确的FACE_LICENSE_ID。

（即后台展示的LicenseID）

在FaceParameterConfig.h文件里面填写拼接好的FACE_LICENSE_ID。

6. 选择链接C++标准库。

7. 如果没有使用pod管理第三方库的话，请在Build Setting >Linking > Other Linker Flags 上面加入 –ObjC 选项。如果用了pod请忽略，因为pod会自动添加上。

2.5 权限声明

需要使用相机权限：编辑Info.plist文件，添加

Privacy- Camera Usage Description 的Key值，Value为使用相机时候的提示语，可以填写：『使用相机』。

3、功能使用

3.1 活体识别

使用IDLFaceLivenessManager类的:

1(void)livenessStratrgyWithImage:(UIImage*)image previewRect:(CGRect)previewRectdetectRect:(CGRect)detectRect completionHandler:(LivenessStrategyCompletion)completion

方法进行活体识别功能。使用方法见下图：

3.2 人脸采集

使用IDLFaceDetectionManager类的

1(void)detectStratrgyWithImage:(UIImage*)image previewRect:(CGRect)previewRect  detectRect:(CGRect)detectRectcompletionHandler:(DetectStrategyCompletion)completion;

方法，来进行人脸采集。使用方法见下图：

3.3 质量校验设置

3.4 界面定制说明

如果需要自定义UI界面，可以在FaceBaseViewController类的viewDidLoad方法里面进行修改。

3.5 接口设计说明

3.5.1 DetectRemindCode

3.5.2 FaceLivenessActionType

3.5.3 LivenessRemindCode

3.6 创建实例

• 方法：FaceSDKManager.instance
• 参数：无
• 返回：人脸功能管理器
• 说明：创建人脸功能管理器。

3.7 设置人脸功能控制参数

• 方法

1 // 设置鉴权
2(void)setLicenseID:(NSString )licenseID andLocalLicenceFile:(NSString)localLicencePath;
3// 最小检测人脸阈值
4(void)setMinFaceSize:(NSInteger)width;
5// 截取人脸图片大小
6(void)setCropFaceSizeWidth:(CGFloat)width;
7// 人脸检测精度阈值
8(void)setNotFaceThreshold:(CGFloat)th; 
9// 人脸遮挡阈值
10(void)setOccluThreshold:(CGFloat)thr;
11// 亮度阈值
12(void)setIllumThreshold:(NSInteger)thr;
13// 图像模糊阈值
14(void)setBlurThreshold:(CGFloat)thr;
15// 头部姿态角度
16(void)setEulurAngleThrPitch:(NSInteger)pitch yaw:(NSInteger)yawroll:(NSInteger)roll; 
17// 是否进行人脸图片质量检测
18(void)setIsCheckQuality:(BOOL)isCheck;

3.8 取得人脸图像采集功能接口

• 方法

  Plain Text 复制

  1(void)detectWithImage:(UIImage *)image completion: (void (^)(FaceInfo *faceinfo, ResultCode resultCode))completion;

• 参数

image: 采集到的图像

• 返回

faceinfo: FaceInfo 人脸检测信息

resultCode: ResultCode 返回执行结果码

• 说明

​ 取得人脸图像采集功能接口。人脸图像采集接口完成，解析图片人脸信息，返回检测结果。

3.9 取得活体检测功能接口

• 方法

  Plain Text 复制

  1(void)livenessWithImage:(UIImage )image completion:(void (^)(FaceInfo faceinfo, LivenessState* state, ResultCode resultCode))completion;

• 参数

image: 采集到的图像

liveAction: 活体动作类型

• 返回

aceinfo: FaceInfo 人脸检测信息

livenessState:LivenessState 活体状态码

resultCode: ResultCode 返回执行结果码

• 说明

取得活体检测功能接口。活体检测功能接口完成，解析图片人脸信息，返回活体检测结果。

3.10 设置人脸图像采集功能参数

• 方法

  Plain Text 复制

  1(void)detectStratrgyWithImage:(UIImage *)image previewRect:(CGRect)previewRectdetectRect:(CGRect)detectRectcompletionHandler:(DetectStrategyCompletion)completion;

• 参数

previewRect 人脸图片大小，类型：Rect

detectRect 人脸检测区域大小，类型：Rect

completion 完成后返回照片和状态结果

• 说明

检测图片中的人脸信息，完成人脸图像采集，返回检测状态和结果。

3.11 设置人脸功能控制参数

• 方法

1(void)livenessStratrgyWithImage:(UIImage *)imagepreviewRect:(CGRect)previewRect detectRect:(CGRect)detectRectcompletionHandler:(LivenessStrategyCompletion)completion;

• 参数

previewRect 人脸图片大小，类型：Rect

detectRect 人脸检测区域大小，类型：Rect

completion 完成后返回照片和状态结果

• 说明

检测图片中的人脸信息，完成人脸图像采集和人脸活体检测，返回检测状态和结果。

3.12 活体动作设置

• 方法

  Plain Text 复制

  1(void)livenesswithList:(NSArray *)array order:(BOOL)ordernumberOfLiveness:(NSInteger)numberOfLiveness

• 参数

array: 活体动作列表

order: 是否按顺序进行活体动作

numberOfLiveness: 活体动作数目（array为nil是起作用）

• 返回

​ 无

• 说明

​ 活体动作设置

4、常见问题

1、license文件有什么用，该放在什么地方？

license文件需要申请，目的是作为sdk校验开发者的使用合法性，license文件放置位置 不对或未放置license文件会导致没法使用sdk，一般应先申请license文件，并把申请得到的license文件，放置在assets目录下面。****

2、活体检测常见有那些动作？是否可配置？

常见有6个动作，眨眼，张大嘴，向上抬头，向下低头，向左摇头，向右摇头等。 sdk提供FaceConfig参数设置类，如活体检测角度、光线，检测动作，检测动作数量等设置。

3、license文件失效了，不能用了怎么办？

License文件申请时候有期限，如过期会导致校验失效，需要在后台进行申请延期。