SDK-接入文档(ios版)

类MGFaceIDDetectManager

初始化函数initFaceIdManagerWithToken

函数名initFaceIdManagerWithToken
方法描述- (instancetype)initFaceIdManagerWithToken:(NSString *__nonnull)token error:(FaceIDDetectError **__nonnull)error;
名称初始化方法
说明活体检测初始化时调此接口
变量名说明
token类型: NSString *
说明:业务流水号
error类型: FaceIDDetectError**
说明: 初始化错误类型,若没有错误,则该参数为空

定制Host的初始化函数initFaceIdManagerWithToken

函数名initFaceIdManagerWithToken
方法描述- (instancetype)initFaceIdManagerWithToken:(NSString *__nonnull)token networkHostURL:(NSString *__nonnull)hostUrlStr error:(FaceIDDetectError **__nonnull)error;
名称初始化方法
说明活体检测初始化时调此接口
变量名说明
token类型: NSString *
说明:业务流水号
hostUrlStr类型: NSString *
说明:自定义Host
error类型: FaceIDDetectError**
说明: 初始化错误类型,若没有错误,则该参数为空

设置语言函数setMGFaceIDLiveDetectLanguage

说明:该方法是类方法,请在开启 FaceID 活体检测接口startDetect之前调用去设置中英文

函数名setMGFaceIDLiveDetectLanguage
方法描述-(void)setMGFaceIDLiveDetectLanguage:(FaceIDDetectBundleLanguageKey)liveDetectLanguage;
名称启动FaceID活体检测
类型说明函数
说明启动FaceID活体检测
变量名说明
liveDetectLanguage类型: FaceIDDetectBundleLanguageKey
说明: 语言枚举类型

FaceID 语言设置的枚举 FaceIDDetectBundleLanguageKey

typedef enum : NSUInteger {
    MGFaceIDDetectionZh = 0,  中文
    MGFaceIDDetectionEn       英文
} FaceIDDetectBundleLanguageKey;

函数startDetect

函数名startDetect
方法描述- (void)startDetect:(UIViewController *__nonnull)detectVC callback:(FaceIDDetectBlock __nonnull)result;
名称启动FaceID活体检测
类型说明函数
说明启动FaceID活体检测
变量名说明
detectVC类型: UIViewController *
说明: 启动检测的VC
result类型: FaceIDDetectBlock
说明: 检测结果的block回调。详情请参考(MGFaceIDDetectConfig.h)
  • 注意:每次调用startDetect前,请先调用initFaceIdManagerWithToken接口

函数getSdkVersion

此函是为非必须函数,获取的SDK版本号便于后期定位问题,建议使用;

函数名getSdkVersion
方法描述+ (NSString *_Nonnull)getSdkVersion;
名称获取SDK的版本号
类型说明函数
说明无
返回值NSString*, 一个字符串,表示当前SDK的版本号。

函数getSdkBuildInfo

此函是为非必须函数,获取的SDK构筑信息便于后期定位问题,建议使用;

函数名getSdkBuildInfo
方法描述+ (NSString *_Nonnull)getSdkBuildInfo;
名称获取SDK的构筑信息
类型说明函数
说明无
返回值NSString*, 一个字符串。

FaceIDDetectBlock回调函数

函数名FaceIDDetectBlock
方法描述Detect的回调函数,返回相应的结果
名称typedef void(^ FaceIDDetectBlock)(NSUInteger Code,NSString* Message);
类型说明函数
说明无
变量名说明
Code类型: NSUInteger
说明:参见SDK-错误码说明
Message类型: NSString*
说明:参见SDK-错误码说明

SDK介绍

SDK 版本: FaceIDZFAC 1.2.2I

模型说明:

  • 模型分别为 Meg_FaceLandmark,Meg_FaceRect,Meg_ActionLive。
  • 模型是 SDK 的核心组件,在 MGFaceIDLiveDetectResouce.bundle 中。

SDK 集成要求:

  • SDK支持的系统最低要求是 iOS 8.0,只支持真机架构 (arm64和armv7),不支持模拟器架构 (x86_64和i386)。

SDK 集成说明:

  • 1、添加 SDK 库:将 sdk 文件夹中的 MGFaceIDLiveDetect.framework 添加到工程中,添加后确保 TARGETS-Build Phases-Link Binary With Libraries 中可以查找到 MGFaceIDDetect.framework(Required)。如果该 SDK(.framework) 在非 PROJECT 根目录下,请确定在 TARGETS-Build Settings-Framework Search Paths 选项中添加了该 SDK 所在的目录路径。
  • 2、因为该 framework中使用了 category,需要在 Ohter Linker Flags 中添加 -ObjC;
  • 3、添加系统依赖:在 TARGETS-Build Phases-Link Binary With Libraries 中添加 AVFoundation.framework、 CoreMedia.framework;
  • 4、添加资源:将 resource 文件夹中的资源包 (MGFaceIDLiveDetectResouce.bundle) 添加到工程中,需要勾选 (Add to targets) 到指定的 target;
  • 5、因为该 SDK 中使用了 C++ 编码,需要工程支持混编 C++。设置 TARGETS-Build Settings-Compile Sources As 选项为 Objective-C++ 或者将调用该 SDK 的文件后缀名称改为 mm;
  • 6、添加硬件权限:因为在 SDK 中调用了系统相机,需要在 info.plist 中添加 Privacy - Camera Usage Description ;
  • 7、调用 SDK 接口:通过 #import <MGFaceIDLiveDetect/MGFaceIDLiveDetect.h> 调用 SDK 中的 API 接口;

集成注意事项:

  • 1、必须在网络连通的情况下使用,离线状态无法该 SDK 无法启动;
  • 2、SDK 不支持 bitcode 设置。

当前版本

  • v1.2.2

历史版本

  • v1.2.0 文档
  • v1.1.0 文档