API 概述

/// 获取SDK实例
+ (nonnull instancetype)sharedInstance;

/// 清理SDK资源
+ (void)clearInstance;

/// 设置 FaceIdToken
///@param onFaceIdTokenCreateFunction 获取FaceIdToken block
- (int)setFaceIdTokenCreateFunction:(FaceIdTokenCreateFunction _Nonnull)onFaceIdTokenCreateFunction;

/// 启动SDK模块，运行带有UI界面的功能识别模块
/// @note 请在View加载完毕后调用该接口
/// @param authConfig SDK需要运行的配置
/// @param onProcessSucceed 识别成功回调
/// @param onProcessFailed 识别失败回调
- (void)startHuiYanAuthWithAuthConfig:(AuthConfig * _Nonnull)authConfig
          withProcessSucceedBlock:(TXYSDKKitProcessSucceedBlock _Nonnull)onProcessSucceed
           withProcessFailedBlock:(TXYSDKKitProcessFailedBlock _Nonnull)onProcessFailed;

/// 设置关键流程的回调信息的监听（回调在子线程，不要直接出来UI事件）
-(void) sendMainPublicEventListenerBlock:(TXYHuiYanPublicEventCallBackBlock _Nonnull) publicEventCallBack;

@protocol TXYHuiYanEventDelegate <NSObject>
- (void)onStartLoading;// 已完成核身正在请求loading中
- (void)onStopLoading;// 请求完毕结束loading
@end

typedef enum : NSUInteger {
    HY_DEFAULT = 0,//跟随系统设置
    HY_ZH_HANS,//中文简体
    HY_EN,//英文
    HY_CUSTOMIZE_LANGUAGE //定制语言
} HY_LanguageType;

/// 用户设置主动刷新 返回FaceIDToken
typedef NSString *_Nullable(^FaceIdTokenCreateFunction)(void);
//设置FaceIdToken
[[HuiYanSDKKit sharedInstance] setFaceIdTokenCreateFunction:^NSString *{
      return faceIdToken;
}];

/// SDKKIt处理成功回调接口
/// @param resultInfo 核身成功
/// @param retFaceidToken 返回FaceIdToken
typedef void (^TXYSDKKitProcessSucceedBlock)(id _Nonnull resultInfo, id _Nullable retFaceidToken);

/// SDKKIt处理失败回调接口
/// @param error 处理过程中触发的异常错误
/// @param retFaceidToken 返回FaceIdToken
typedef void (^TXYSDKKitProcessFailedBlock)(NSError *_Nonnull error, id _Nullable retFaceidToken);

/// SDK的内部主要流程的事件监听（在子线程中回调，不要直接进行UI操作）
/// @param publicEvent 流程里的关键事件信息
typedef void (^TXYHuiYanPublicEventCallBackBlock)(HuiYanPublicEvent publicEvent);

// HuiYanPublicEvent 公有云特殊的事件
typedef enum : NSUInteger {
    // 启动拉取光线序列
    GET_LIVE_TYPE_HUIYAN,
    // 本地识别开始
    START_CHECK_HUIYAN,
    // 本地识别结束准备开启网络请求
    LOCAL_CHECK_OVER_HUIYAN,
    // 得到网络请求结果，并且需要结果为success才会回调
    GET_NET_RESULT_HUIYAN,
} HuiYanPublicEvent;