LFLivenessSDK类说明

LFLivenessSDK.getInstance(Context context)

获取LivenessDetector类的单例对象

参数 说明
Context
返回值 说明

调用示例:

LFLivenessSDK mDetector = LFLivenessSDK.getInstance(getActivity());

int createHandle()

判断创建handle是否成功,成功返回true,失败返回false。

参数 说明
返回值 说明
int 创建handle返回值,根据返回判断是否创建成功,如0代表成功, -15代表SDK过期

调用示例:

LFLivenessSDK mDetector = LFLivenessSDK.getInstance(getActivity());
int createResultCode = mDetector.createHandle();

public void initLicPath(String licPath,String licName)

初始化License文件路径。

参数 说明
licPath License文件绝对路径
licName 传Assets目录下的lic文件名
返回值 说明

调用示例:

//初始化Liveness SDK的License路径
final String licPath = Constants.LICENSE_MIDDLE_PATH + File.separator + Constants.LICENSE_NAME;
LFLivenessSDK.getInstance(MainTestAcitivity.this).initLicPath(licPath, Constants.LICENSE_NAME);

public int getRemainingDays()

获取License文件剩余有效天数。

参数 说明
返回值 说明
int License文件剩余有效天数,如1代表明天过期。

调用示例:

//获取剩余天数
int remainingDays = LFLivenessSDK.getInstance(MainTestAcitivity.this).getRemainingDays();

public boolean checkLicenseValid(Context context)

获取License文件是否有效。

参数 说明
context 上下文对象
返回值 说明
boolean License文件是否有效。true:当前有效;false:当前无效

调用示例:

boolean isValid = LFLivenessSDK.getInstance(MainTestAcitivity.this).checkLicenseValid();

boolean start(int config)

开始活体检测

参数 说明
config config默认格式为outputtype | complexity

outputtype值参考LFLivenessSDK.LFLivenessOutputType
complexity值参考LFLivenessSDK.LFLivenessComplexity
返回值 说明
boolean 是否准备开始检测。 true:准备开始检测;false:未准备好检测

调用示例:

LFLivenessSDK mDetector = LFLivenessSDK.getInstance(getActivity());
boolean isDetectorStartSuccess = mDetector.start(getLivenessConfig());

static String getSDKVersion()

返回sdk版本信息

参数 说明
返回值 说明
String SDK版本号

调用示例:

String sdkVersion = LFLivenessSDK.getInstance(MainTestAcitivity.this).getSDKVersion();

LFLivenessSDK.LFStatus detect(byte[] image, int width, int height, int rotateAngle, LFLivenessSDK.LFLivenessMotion motion)

返回活体检测状态

参数 说明
image 输入的图片数据
width 图片的宽度
height 图片的高度
rotateAngle 图片的方向
motion 当前检测的动作
返回值 说明
Status结构体 Status结构体中detectStatus有四个状态:
参考枚举LFDetectStatus

boolean值passed为true表示通过检测,false表示未通过检测,判断动作通过需要同时判断detectStatus为PASSED并且passed为true

调用示例:

LFLivenessSDK mDetector = LFLivenessSDK.getInstance(getActivity());
LFLivenessSDK.LFStatus status = mDetector.detect(mNv21, Constants.PREVIEW_WIDTH, Constants.PREVIEW_HEIGHT, mCameraInfo.orientation, mMotionList[mCurrentMotion]);

LFLivenessSDK.LFRect getFaceRect() throws Exception

获取人脸框位置信息。调用失败抛出异常

参数 说明
返回值 说明
LFLivenessSDK.LFRect结构体 top,bottom,left,right分别代表上,下,左,右四个边的坐标

调用示例:

LFLivenessSDK mDetector = LFLivenessSDK.getInstance(getActivity());
LFLivenessSDK.LFRect = mDetector.getFaceRect();

void end()

活体检测结束

参数 说明
返回值 说明

调用示例:

LFLivenessSDK mDetector = LFLivenessSDK.getInstance(getActivity());
mDetector.end();

byte[] getLivenessResult() throws Exception

获取protobuf数据。调用失败时抛出异常

参数 说明
返回值 说明
byte[] 获取protobuf数据。需要将byte[]写入到文件中

调用示例:

LFLivenessSDK mDetector = LFLivenessSDK.getInstance(getActivity());
byte[] livenessResult = mDetector.getLivenessResult();

LFLivenessSDK.LFLivenessImageResult[] getImageResult() throws Exception

获取活体检测生成的图片序列。调用失败抛出异常

参数 说明
返回值 说明
LFLivenessSDK.LFLivenessImageResult[]结构体数组 LFLivenessSDK.LFLivenessImageResult[]结构体中包含了byte[] imageBytes(图片数据),int length(图片数组长度),int motion(图片对应的动作)

调用示例:

LFLivenessSDK mDetector = LFLivenessSDK.getInstance(getActivity());
LFLivenessSDK.LFLivenessImageResult[] imageResult = mDetector.getImageResult();

byte[] getVideoResult() throws Exception

获取活体检测生成的视频结果。调用失败抛出异常

参数 说明
返回值 说明
byte[] 获取活体检测生成的视频结果,只有 OUTPUTTYPE 设置为 video 时才会有视频结果

调用示例:

LFLivenessSDK mDetector = LFLivenessSDK.getInstance(getActivity());
byte[] videoResult = mDetector.getVideoResult();

void destroy()

销毁handle,回收内存

参数 说明
返回值 说明

调用示例:

LFLivenessSDK mDetector = LFLivenessSDK.getInstance(getActivity());
mDetector.destroy();

内部类

1. LFLivenessOutputType 输出类型

类型 说明
WRAPPER_OUTPUT_TYPE_SINGLE_IMAGE 单图模式
WRAPPER_OUTPUT_TYPE_MULTI_IMAGE 多图模式
WRAPPER_OUTPUT_TYPE_LOW_QUALITY_VIDEO 视频模式

2. LFLivenessComplexity 活体检测复杂度

类型 说明
WRAPPER_COMPLEXITY_EASY 简单模式
WRAPPER_COMPLEXITY_NORMAL 普通模式
WRAPPER_COMPLEXITY_HARD 困难模式
WRAPPER_COMPLEXITY_HELL 地狱模式

3. LFLivenessMotion 活体检测动作

类型 说明
BLINK 眨眼
MOUTH 张嘴
YAW 摇头
NOD 点头

4. LFDetectStatus 活体检测状态

类型 说明
PASSED 通过
DETECTING 检测中
INTERNAL_ERROR 检测出错
TRACKING_MISSED 人脸丢失

results matching ""

    No results matching ""