Android-SDK-Image Detection

---

中英文文档模板

---

中文版

---

Android-SDK-图像检测

开发准备

1. 前往注册: 账号由 ADVANCE GUARDIAN 发放， 请联系 ADVANCE GUARDIAN 取得accessKey、secretKey。

集成SDK到您的工程中

解压下载的压缩包，得到如下文件：

文件/文件夹名称	解释
picture_quality	包含OCR、ID Holding、Face Comparison三种引导框的UI功能库
libaaipicquality_v1.0.0.so	兼容so文件
picture_quality_lib-release.aar	图像检测功能aar

• picture_quality module包含OCR、ID Holding、Face Comparison三种引导框，可直接引用到您的主工程中，根据实际需求进行个性化修改。您也可以自行实现本功能。

• 关于libaaipicquality_v1.0.0.so：aar提供了 x86_64、arm64_v8a、x86、armeabi-v7a 四种架构的so，如您的工程需要依赖其他类型架构(如armeabi),可将此so文件拷贝至相应目录即可。

若您使用picture_quality功能库，请按照以下方式集成：

1. 导入picture_quality模块到您的工程

2. app工程添加对picture_quality模块的依赖

3. 在app目录下的build.gradle中增加如下代码,build工程即可

    repositories {
        flatDir {
            dirs project(': picture_quality').file('libs')
        }
    }
   

仅集成图像检测功能：

1. 拷贝picture_quality_lib-release.aar文件到项目的libs目录下

2. 在当前模块的build.gradle添加对aar的引用,build工程即可

    repositories {
        flatDir {
            dirs 'libs'
        }
    }
    dependencies {
    	...
    	api(name: 'picture_quality_lib-release', ext: 'aar')
    }
   

快速入门

初始化SDK。在自定义的application中增加如下初始化代码：

	GuardianPictureQualitySDK.init("your accessKey", "your secretKey", applicationContext);

picture_quality 库页面调用方法及检测逻辑：

	//cls:根据不同的需求跳转相应的页面.
	//OCRActivity.class
	//FaceComparisonActivity.class
	//IDHoldingPhotoCheckActivity.class
	
	Intent intent = new Intent(this, cls);
	startActivityForResult(intent, yourRequestCode);

	//在onActivityResult获取返回的图像信息，对图像进行检测
	@Override
	protected void onActivityResult(int requestCode, int resultCode, Intent data) {
    	if(requestCode == yourRequestCode && resultCode == RESULT_OK){
    	 ArrayList<BitmapEntity> caches = BitmapCaches.getCaches();//取到图像list，
    	}
	}

图像检测方法：

	GuardianPictureQualitySDK.qualityDetection()
	或
	GuardianPictureQualitySDK.qualityDetectionBitmap()

---

英文版

---

Android-SDK-Image Detection

Notes for Developer

1. Please apply for an Account (Official/Test) from ADVANCE Guardian
2. Obtain accessKey and secretKey

SDK Integration

Extract the Compressed File, which should have the following items inside:

File/Folder Name	Description
picture_quality	Contains OCR, ID Holding, Face Comparison Library
libaaipicquality_v1.0.0.so	Supporting .so File
picture_quality_lib-release.aar	Image Detection Function .aar File

• picture_quality module contains OCR, ID Holding, Face Comparison, 3 class that can be directly integrated to your main project and modified according to your needs. You can also implement this feature by yourself.

• About libaaipicquality_v1.0.0.so: aar provides x architectures of x86_64, arm64_v8a, x86, and armeabi-v7a. If your project needs to depend on other types of architectures (such as armeabi), you can copy this .so file to the corresponding directory in order to fix the compatibilty issue.

If you use the picture_quality library, please refer to the following integration steps:

1. Import the picture_quality module into your project

2. Adds dependency on the picture_quality module

3. Add the following code to build.gradle in the app directory and then build the project

    repositories {
        flatDir {
            dirs project(': picture_quality').file('libs')
        }
    }
   

Integrated image detection only:

1. Copy the picture_quality_lib-release.aar file to the project’s libs directory.

2. Add a reference to .aar file in the build.gradle of the current module.

    repositories {
        flatDir {
            dirs 'libs'
        }
    }
    dependencies {
    	...
    	api(name: 'picture_quality_lib-release', ext: 'aar')
    }
   

Quick Start

Initialize the SDK. Add the following code to your application:

	GuardianPictureQualitySDK.init("your accessKey", "your secretKey", applicationContext);

Picture_quality library method calling and detection logic:

	//cls:Jump to the corresponding page according to different needs..
	//OCRActivity.class
	//FaceComparisonActivity.class
	//IDHoldingPhotoCheckActivity.class
	
	Intent intent = new Intent(this, cls);
	startActivityForResult(intent, yourRequestCode);

	//Get the returned image information from `onActivityResult` and detect the image
	@Override
	protected void onActivityResult(int requestCode, int resultCode, Intent data) {
    	if(requestCode == yourRequestCode && resultCode == RESULT_OK){
    	 ArrayList<BitmapEntity> caches = BitmapCaches.getCaches();//get bitmapEntity list，
    	}
	}

Image Detection method:

	GuardianPictureQualitySDK.qualityDetection()
	OR
	GuardianPictureQualitySDK.qualityDetectionBitmap()