Android-SDK-活体检测(2D)

快速体验 Demo

方式一:

安装 CV-Demo.apk 到您的手机，使用测试账号进行登录。

方式二：

下载 Demo 工程

集成 SDK 到您的工程中

根据您项目依赖的 Google 库的类型选择下载 UI 模块源码，下载完成解压后将liveness文件夹拷贝至您的项目中作为一个普通的module进行依赖。

• android.support.**
• androidx.**

• 如果拉取 aar 失败，建议尝试如下操作：

  • 如果您的 gradle 版本小于 7.0，在项目的根目录下build.gradle增加 maven 仓库：

    xxxxxxxxxx
    allprojects {
        repositories {
            ...
            maven { url 'https://public-n3.advai.net/repository/maven-releases/' }
        }
    }
    

  • 如果您的项目 gradle 版本大于7.0，在项目的根目录下settings.gradle增加 maven 仓库:

    xxxxxxxxxx
    dependencyResolutionManagement {
        ...
        repositories {
            ...
            maven {
                url 'https://public-n3.advai.net/repository/maven-releases/'
            }
        }
    }
    

  • 如果上述做法仍然无法拉取 aar，您可以通过下方链接下载 aar，然后手动依赖到项目中：

    下方链接以 lib 2.4.0 和 core 5.8 为例，修改链接中的版本号可以下载对应的版本。

    • liveness_lib aar[版本更新记录]：https://public-n3.advai.net/repository/maven-releases/ai/advance/mobile-sdk/android/liveness-detection/2.4.0/liveness-detection-2.4.0.aar
    • core aar [版本更新记录] https://public-n3.advai.net/repository/maven-releases/ai/advance/mobile-sdk/android/core/5.8/core-5.8.aar

     

SDK 版本更新

• 查看版本记录
• 查看版本更新说明

快速入门

1. 初始化SDK

   xxxxxxxxxx
   // 最后一个布尔值代表是否开通的 Global 服务，如果是则设置为 true，反之为 false。
   // init 方法在 application 中调用
   GuardianLivenessDetectionSDK.init(this,your market,false);
   

2. 设置动作难度（在 setLicenseAndCheck() 方法之前调用，否则不生效）

   您可以根据业务要求指定动作检测的难度(EASY，NORMAL，HARD)，默认为 NORMAL

   xxxxxxxxxx
   GuardianLivenessDetectionSDK.setDetectionLevel(GuardianLivenessDetectionSDK.DetectionLevel.EASY);
   

3. 校验 license

   license 由您的服务端调用我们 openAPI 获取，启动活体检测之前调用

   xxxxxxxxxx
   String license = "xxx";
   String checkResult = GuardianLivenessDetectionSDK.setLicenseAndCheck(license);
   if ("SUCCESS".equals(checkResult)) {
       // license 有效
      startLivenessActivity();
   } else {
     // license 不可用，过期/格式错误/appId未备案
   }
   

4. 启动活体检测与获取检测结果

   SDK 默认不检查相机权限，如果您希望权限的申请交由 SDK 处理，可在 SDK 初始化方法调用后，调用如下方法，则 LivenessActivity 中会执行权限申请的操作：
   

   xxxxxxxxxx
   GuardianLivenessDetectionSDK.letSDKHandleCameraPermission();
   

   每次进行活体检测成功后，会返回唯一的 livenessId 和本次检测的 600*600 像素的清晰正面照片。

   • 您需要将 livenessId 传给您的服务端，由服务端调用 openAPI 获取本次检测的分值。

   • 您可以通过 SDK 提供的方法直接获取图片，也可以由服务端调用 openAPI 获取。

     xxxxxxxxxx
     /**
        * 请求状态码
        */
       public static final int REQUEST_CODE_LIVENESS = xxxx;
       
       /**
        * 启动活体检测
        */
       private void startLivenessActivity() {
       Intent intent = new Intent(this, LivenessActivity.class);
       startActivityForResult(intent, REQUEST_CODE_LIVENESS);
     }
     
     /**
      * 获取检测结果
      */
     @Override
     protected void onActivityResult(int requestCode, int resultCode, Intent data) {
         super.onActivityResult(requestCode, resultCode, data);
         if (requestCode == REQUEST_CODE_LIVENESS) {
           if (LivenessResult.isSuccess()) {// 活体检测成功
           String livenessId = LivenessResult.getLivenessId();// 本次活体id
           boolean pay = LivenessResult.isPay();// 是否收费
           Bitmap livenessBitmap = LivenessResult.getLivenessBitmap();// 本次活体图片
         } else {// 活体检测失败
           String errorCode = LivenessResult.getErrorCode();// 失败错误码
           String errorMsg = LivenessResult.getErrorMsg();// 失败原因
           String transactionId = LivenessResult.getTransactionId(); // 流水号，可用于排查问题
           ...
         }
       }
     }
     

5. 动作顺序说明

xxxxxxxxxx
> 默认的动作顺序是 [眨眼]->[摇头]，如需自定义动作顺序请参考如下代码：

在启动`LivenessActivity`页面前调用如下方法：
    
  // 第一个布尔值代表是否打乱传入的动作顺序，true 代表打乱顺序。
  GuardianLivenessDetectionSDK.setActionSequence(true,Detector.DetectionType.POS_YAW, Detector.DetectionType.MOUTH, Detector.DetectionType.BLINK);

4. 自定义返回的图像尺寸

   xxxxxxxxxx
   // 支持设置的入参范围：[300,1000]，单位：像素
   GuardianLivenessDetectionSDK.setResultPictureSize(600); 
   

5. 返回多张图片(默认关闭)

   支持在每个动作分别采集一张图像，如果打开此开关，由于额外采集了多张图片，会导致 SDK 运行时内存占用提升，如果您的 App 本身已经占用较多内存，则打开此项配置可能会引发内存溢出，请谨慎选择。

   xxxxxxxxxx
   GuardianLivenessDetectionSDK.capturePictureQueue(true);
   

   获取图片序列(活体检测成功后获取)：

   xxxxxxxxxx
   List<String> imageSequenceList = LivenessResult.getImageSequenceList();
   

6. 自定义动作时间

   支持自定义动作的检测时间，设置后所有动作都生效，单位：毫秒

   xxxxxxxxxx
   GuardianLivenessDetectionSDK.setActionTimeoutMills(10000);
   

7. 用户绑定(强烈建议)。

   您可以通过该方法将自己的用户唯一标识传给我们，我们会根据该标识建立映射关系。当遇到问题时，方便同我们进行日志追踪。

   xxxxxxxxxx
   GuardianLivenessDetectionSDK.bindUser(String userId)
   

8. 开启遮挡检测

   遮挡检测默认是关闭状态，如需开启遮挡检测，请在初始化SDK之后调用如下方法设置

   xxxxxxxxxx
   GuardianLivenessDetectionSDK.isDetectOcclusion(true)
   

9. 国际化

   SDK 支持中文，英文，印尼文，越南语，泰国语，印地语，西班牙语 七种语言/语音，跟随手机系统语言自动切换，无需代码设置。

   若没有跟随系统语言自动切换 ，请检查手机语言设置，确保【地区】和【语言】均已切换至对应的语言。
   若仍然出现语言国际化问题，同时 app 仅支持某种语言，可以通过在build.gradle中增加如下配置，过滤掉不需要的语言

   xxxxxxxxxx
   android {
       defaultConfig {
           ...
           resConfigs("in-rID") // 以仅支持印尼语为例
       }
   
   }
   

10. 运行时权限

    本 SDK 需要如下权限，并且已经在 aar 的清单文件中做了配置。

    xxxxxxxxxx
    <uses-feature android:name="android.hardware.camera" />
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.CAMERA" />
    

11. 关于 App Bundle 打包

    SDK 中包含 .so 文件，为了减少包大小，在上架 Google Play 时可以选择使用 Bundle 打包，请验证打包后的 APK 在各个架构的手机上都可以运行，如果出现提示【该设备不支持】，则表示组装 APK 时缺失了 .aar 中的 .so 文件。

12. 代码混淆

    SDK 已经做好了代码混淆，无需额外增加配置。

13. 关于Androidx

    考虑到 Androidx 与 support 包的互斥，本 SDK 的 .aar 全部是 support 包，如果您的项目是 androidX 类包，编译时遇到提示 support 包冲突错误，请在您项目的根目录下的gradle.properties文件中增加下述配置，重新编译项目即可：

    xxxxxxxxxx
    android.enableJetifier=true 
    

14. SDK 兼容性

    • 最低 Android 版本：4.4 (API Level:19)
    • SDK 编译版本：API Level：32
    • 额外依赖的第三方库：无
    • 支持的 CPU 架构：armeabi-v7a，arm64-v8a，x86，x86_64，armeabi
    • SDK 包大小：1.3MB 模型文件 + 每种 CPU 架构约 0.8MB
    • 采集图像大小：默认采集图像分辨率 600px*600px，大小约为 300KB，支持自定义图像尺寸范围：300px~1000px

Error Code: