SDK-接入文档(android版)

接口说明

入口类

com.megvii.faceid.zzplatform.sdk.manager.FaceIdManager

接口

获取单实例对象接口

public static synchronized FaceIdManager getInstance(Context context);
  • 参数说明
参数说明
Contextandroid.os.Context：建议使用ApplicationContext
  • 返回值说明
返回值说明
FaceIdManager入口类FaceIdManager的单实例对象

初始化接口

public void init( String bizToken);

  • 调用说明

    必须在调用所有接口前，初始化成功，否则无法正常工作。

  • 参数说明

参数说明
bizToken业务流水号

开始检测接口

public void startDetect();
  • 参数说明
参数说明
无无
  • 返回值说明
返回值说明
void无返回值

设置Init回调接口

public void setFaceIdInitListener(FaceIdInitListener listener);
  • MegLiveDetectListener 说明
public interface FaceIdInitListener {
    void onSuccess ();
    void onFailed(int code, String msg);
}
参数说明
codeInit结果状态码，参见SDK-错误码说明
messageInit结果信息，参见SDK-错误码说明

设置Detect回调接口

public void setFaceIdDetectListener(FaceIdDetectListener listener);
  • FaceIdDetectListener 说明
public interface FaceIdDetectListener {
    void onSuccess(int code, String msg);
    void onFailed(int code, String msg);
}
参数说明
codestartDetect结果状态码，参见SDK-错误码说明
messagestartDetect结果信息，参见SDK-错误码说明

设置语言接口（可选接口）

public void setLanguage(Activity activity, String language);

  • 调用说明

    如需设置英文语言，必须在调用初始化接口(init)前设置，否则无法正常工作。

  • 参数说明

参数说明
activityandroid.app.Activity
language设置的语言。设置英文可传"en"，设置中文可传"zh"，默认为中文

设置HOST接口（可选接口）

public void setHost(Context context, String host);

  • 调用说明

    如需设置host，必须在调用初始化接口(init)前设置，否则无法正常工作。

  • 参数说明

参数说明
contextandroid.os.Context：建议使用ApplicationContext
host设置的host。例如："https://openapi.faceid.com"

获取SDK版本号接口：

public String getSdkVersion();
  • 参数说明
参数说明
无无
  • 返回值说明
返回值说明
StringSDK版本号

获取编译版本号接口：

public String getSdkBuildInfo();
  • 参数说明
参数说明
无无
  • 返回值说明
返回值说明
StringSDK编译信息

集成说明(Android Studio)

  1. 把arr文件复制进入libs文件夹中
    1

  2. 在APP的gradle中加入

    repositories {
 flatDir{
     dirs 'libs'
     }
 }

  3. 并在dependencies中加入compile(name:'zzplatform_sdk',ext:'aar')

    2

  4. 点击Rebuild Project

当前版本

  • v1.2.2

历史版本