SDK-接入文档(android版)

此文档只适用于FaceID MegLiveStill SDK 2.0.0及以上版本，SDK 1.3版本及以下版本请参考对应历史文档。

接口说明

入口类MegLiveManager

MegLiveManager类是管理活体认证的类，此类不可以初始化，只能通过getInstance获得其单例。

接口

MegLiveManager.getInstance

函数名MegLiveManager getInstance()
名称获取MegLiveManager的实例
类型说明函数
说明获取MegLiveManager的单例
  • 返回值说明
返回值说明
MegLiveManagerMegLiveManager的单实例对象

MegLiveManager.getVersion

函数名String getVersion()
名称获取SDK的版本号
类型说明函数
  • 返回值说明
返回值说明
String一个字符串，表示当前SDK的版本号。如：MegLiveStill 2.0.0

MegLiveManager.getBuildInfo

函数名String getBuildInfo()
名称获取SDK的构建信息
类型说明函数
  • 返回值说明
返回值说明
String一个字符串，表示当前SDK的SDK的构建信息。

MegLiveManager.setManifestPackage

函数名void setManifestPackage(String package)
名称设置资源编译的包名，工程中AndroidManifest.xml的package属性的值
类型说明函数
说明此函数非必需调用，默认获取资源package为本包包名，如build.gradle的applicationId与AndroidManifest.xml中不一致的情况，必须在preDetect之前调用，并将AndroidManifest.xml的package传入。

  • 返回值说明

    无返回值

重点说明

若build.gradle的applicationId与AndroidManifest.xml的package不一致，必须在startDetect接口之前调用此接口，并传AndroidManifest.xml的package。 如下图示: 1 2 当不一致时，改接口必须被调用且必须在startDetect之前调用。图中情况传入的package为 com.megvii.test。即 setManifestPackage(“com.megvii.test”);

MegLiveManager.preDetect

函数名void preDetect(Context context, String token,String language,String host PreCallback callback)
名称活体检测预处理接口，结果会以callback返回。失败则无法进行以后所有工作。
类型说明函数
说明监听者会在活体验证结束后被调用，如果没有设置，则不会调用。
  • 参数说明
参数说明类型
contextAndroid上下文Context
token业务流水号，每次验证前，通过服务端API获取的业务流水号（bizToken）String
language语种 参照ISO 639标准 使用系统默认传nullString
host网络请求host。 host取值见附录E 【host取值列表】，请根据具体情况选择host取值。String
callbackPreCallback的类对象，接收预处理结果，详见回调函数PreCallback说明PreCallback

setVerticalDetectionType

函数名void setVerticalDetectionType(@Vertical int verticalDetection)
名称垂直检测设置
类型说明函数
说明MegLiveManager. DETECT_VERITICAL_FRONT 前两秒检测
MegLiveManager. DETECT_VERITICAL_KEEP 始终检测
MegLiveManager. DETECT_VERITICAL_DISABLE 不检测
  • 参数说明
参数说明类型
verticalDetection垂直检测类型int

接口PreCallback

PreCallback是一个活体检测前预处理的回调接口，开启活体验证之前需要优先调用此接口。

PreCallback. onPreStart

函数名void onPreStart()
名称开启预处理
类型说明函数
说明此处无实际意义，代表预处理开启，此处可用于展示progress bar

PreCallback. onPreFinish

函数名void onPreFinish(String token,int errorCode,String errorMessage)
名称完成预处理之后的回调
类型说明函数
说明只有当完成预处理且errorCode==1000的时候才可以调用startDetect开启活体检测
  • 参数说明
参数说明类型
token业务流水号，用户调用预处理传入的tokenString
errorCode预处理结果码,具体错误码参考文档ErrorCode说明int
errorMessage预处理结果信息，具体错误信息参考文档ErrorCode说明String

MegLiveManager. startDetect

函数名void startDetect(DetectCallback callback);
名称开始活体认证
类型说明函数
说明在预处理接口onPreFinish 成功回调且errorCode==1000的时候才能开启
  • 参数说明
参数说明类型
callbackDetectCallback的类对象，接受活体结果的接口,详见回调函数DetectCallback说明DetectCallback

接口DetectCallback

DetectCallback是一个活体检测完成返回活体认证结果的回调接口。

DetectCallback.onDetectFinish

函数名void onDetectFinish(String token,int errorCode,String errorMessage，String data)
名称完成活体检测之后的回调结果
类型说明函数
  • 参数说明
参数说明类型
token业务流水号，用户调用预处理传入的tokenString
errorCode预处理结果码,具体错误码参考文档ErrorCode说明int
errorMessage预处理结果信息，具体错误信息参考文档ErrorCode说明String
data客户端完成验证后的加密数据。
注：需用该data调用服务端接口进行数据验证		String

集成说明(Android Studio)

  1. 将res目录下的资源文件拷贝到项目app的res下，若果不需要多语种适配可以将res下的中英文适配文件夹删除，如果需要适配其他语种则需要建立对应语种目录（图片资源如果需要区分多语种也需要建立对应目录），demo中提供了默认（中文）、英文、中文三种示例
    3

  2. 把aar文件复制进入libs文件夹中
    4

  3. 在APP的build.gradle中加入

    repositories {
 flatDir{
     dirs 'libs'
     }
 }
 lintOptions {
    checkReleaseBuilds false
    abortOnError false
 }

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

    5

  5. 点击Rebuild Project

  • UI定制

    可定制的UI内容：

    可定制的内容主要包括：控件颜色、文案内容、文案颜色、文案字号、图片资源、语音资源等。下文将逐个页面说明哪些UI元素可以修改。

    6

  • 1、默认图片资源可以更换，素材名称：liveness_image_center

  • 2、首页提示语文字颜色可替换 文案字体颜色变量名：livenessGuideRemindTextColor

  • 3、首页同意协议文字颜色可更换，变量名：livenessGuideReadColor

  • 4、button颜色可更换，文字颜色可以更换。

    button可选状态颜色变量名：livenessDetectButtonSelectedBGColor

    button不可选状态颜色变量名：livenessDetectButtonNormalBGColor

    button高亮状态颜色变量名：livenessDetectButtonHighlightBGColor

    字体颜色变量名：livenessDetectButtonTextColor

  • 5、背景色可以更换，变量名称：livenessHomeBackgroundColor

  • 6、右上角关闭按钮资源可以更换，变量名称：liveness_home_closeicon

  • 7、圆环部分背景色可以替换，变量名称：livenessHomeRingColor

  • 8、进度条颜色可以更换，变量名称：livenessHomeProcessBarColor

  • 9、验证失败后，进度条颜色可以更换，变量名称：livenessHomeValidationFailProcessBarColor

  • 10、圆圈下的字体颜色、字体大小、文案内容可以更换，此字体一直保持居中状态，支持折行； 文案字体颜色变量名：livenessHomePromptColor 文案字体大小变量名：livenessHomePromptSize 文案内容： “请让我看到您的正脸”：livenessHomePromptFrontalFaceText “验证中，请稍候”：livenessHomePromptWaitText “人脸有效面积太小”：livenessHomePromptFaceEreaText “请让光线再亮点”：livenessHomePromptBrighterText “请让光线再暗点”：livenessHomePromptDarkerText “请再靠近一些”：livenessHomePromptCloserText “请离屏幕远一些”：livenessHomePromptFurtherText “请避免侧光或背光”：livenessHomePromptNoBacklightingText “请将正脸置于取景框内”:livenessHomePromptFrontalFaceInBoundingBoxText “请勿遮挡眼睛”: livenessHomePromptNoEyesOcclusionText “请勿遮挡嘴巴”: livenessHomePromptNoMouthOcclusionText “很好，请保持不动”: livenessHomePromptStayStillText

    “请向左或向右缓慢转头”： livenessHomePromptShakeHeadText “请缓慢点头”： livenessHomePromptNodText “请张嘴”： livenessHomePromptOpenMouthText “请眨眼”： livenessHomePromptBlinkText

  • 11、动作活体时语音资源可以替换： “请眨眼”：liveness_blink “请张嘴”：liveness_mouth_open “请向左或向右缓慢转头”：liveness_shakehead “请缓慢点头”：liveness_nod “很好”：liveness_well_done

  • 12、在loading过程中，loading效果素材可以更换；素材名称：liveness_home_loadingicon

  • 13、退出弹层标题内容、标题文案字号、颜色可以更换： 字体颜色变量名：livenessExitTitlePromptColor 字体大小变量名：livenessExitTitlePromptSize 文案内容： “确认退出吗”：livenessExitTitlePromptText

  • 14、退出弹层的中的左右两个选项的文案内容、文案字号、颜色可以更换： 左项： 字体颜色变量名：livenessExitLeftPromptColor 字体大小变量名：livenessExitLeftPromptSize 文案内容： “取消”：livenessExitLeftPromptText 右项： 字体颜色变量名：livenessExitRightPromptColor 字体大小变量名：livenessExitRightPromptSize 文案内容： “确定”：livenessExitRightPromptText

  • 15、图中动画内容可以替换： 眨眼动画： liveness_blink_eye_close liveness_blink_eye_open 张嘴动画： liveness_mouth_close liveness_mouth_open 点头动画： liveness_nod_down liveness_nod_up 摇头动画： liveness_shakehead_left liveness_shakehead_right

  • 16、重试弹层标题文案字号、颜色可以更换： 字体颜色变量名：livenessRetryTitlePromptColor 字体大小变量名：livenessRetryTitlePromptSize

  • 17、重试弹层的中的左右两个选项的文案内容、文案字号、颜色可以更换： 左项： 字体颜色变量名： livenessRetryLeftPromptColor

    字体大小变量名：livenessRetryLeftPromptSize 文案内容： “重新验证”：livenessRetryLeftPromptText 右项： 字体颜色变量名：livenessRetryRightPromptColor 字体大小变量名：livenessRetryRightPromptSize 文案内容： “结束验证”：livenessRetryRightPromptText

UI定制方法：

  • 修改尺寸、颜色、文案内容： 在values文件夹下修改文字内容、尺寸、 颜色等参数。
  • 替换图片资源： 替换drawable文件夹下存放图片资源，资源key值需要按照规定格式定义。
  • 替换语音资源： 替换raw文件夹下的音频文件。

附录A：ISO 639-1语言列表

语言代码语言语言代码语言语言代码语言语言代码语言
aa阿法尔语fr法语li林堡语se北萨米语
ab阿布哈兹语fy弗里西亚语ln林加拉语sg桑戈语
ae阿维斯陀语ga爱尔兰语lo老挝语sh塞尔维亚-克罗地亚语
af南非语gd苏格兰盖尔语lt立陶宛语si僧加罗语
ak阿坎语gl加利西亚语lu卢巴语sk斯洛伐克语
am阿姆哈拉语gn瓜拉尼语lv拉脱维亚语sl斯洛文尼亚语
an阿拉贡语gu古吉拉特语mg马达加斯加语sm萨摩亚语
ar阿拉伯语gv马恩岛语mh马绍尔语sn绍纳语
as阿萨姆语ha豪萨语mi毛利语so索马里语
av阿瓦尔语he希伯来语mk马其顿语sq阿尔巴尼亚语
ay艾马拉语hi印地语ml马拉亚拉姆语sr塞尔维亚语
az阿塞拜疆语ho希里莫图语mn蒙古语ss斯瓦特语
ba巴什基尔语hr克罗地亚语mo摩尔达维亚语st南索托语
be白俄罗斯语ht海地克里奥尔语mr马拉提语su巽他语
bg保加利亚语hu匈牙利语ms马来语sv瑞典语
bh比哈尔语hy亚美尼亚语mt马耳他语sw斯瓦希里语
bi比斯拉马语hz赫雷罗语my缅甸语ta泰米尔语
bm班巴拉语ia国际语Ana瑙鲁语te泰卢固语
bn孟加拉国语in印尼语nb书面挪威语tg塔吉克斯坦语
bo藏语ie国际语End北恩德贝勒语th泰语
br布列塔尼语ig伊博语ne尼泊尔语ti提格里尼亚语
bs波斯尼亚语ii四川彝语（诺苏语）ng恩敦加语tk土库曼语
ca加泰隆语ik依努庇克语nl荷兰语tl他加禄语
ce车臣语io伊多语nn新挪威语tn塞茨瓦纳语
ch查莫罗语is冰岛语no挪威语to汤加语
co科西嘉语it意大利语nr南恩德贝勒语tr土耳其语
cr克里语iu因纽特语nv纳瓦霍语ts宗加语
cs捷克语ja日语ny尼扬贾语tt塔塔尔语
cu古教会斯拉夫语jv爪哇语oc奥克语tw特威语
cv楚瓦什语ka格鲁吉亚语oj奥吉布瓦语ty塔希提语
cy威尔士语kg刚果语om奥洛莫语ug维吾尔语
da丹麦语ki基库尤语or奥利亚语uk乌克兰语
de德语kj宽亚玛语os奥塞梯语ur乌尔都语
dv迪维希语kk哈萨克语pa旁遮普语uz乌兹别克语
dz不丹语kl格陵兰语pi巴利语ve文达语
ee埃维语km高棉语pl波兰语vi越南语
el现代希腊语kn卡纳达语ps普什图语vo沃拉普克语
en英语ko朝鲜语、韩语pt葡萄牙语wa沃伦语
eo世界语kr卡努里语qu凯楚亚语wo沃洛夫语
es西班牙语ks克什米尔语rm罗曼什语xh科萨语
et爱沙尼亚语ku库尔德语rn基隆迪语yi依地语
eu巴斯克语kv科米语ro罗马尼亚语yo约鲁巴语
fa波斯语kw康沃尔语ru俄语za壮语
ff富拉语ky吉尔吉斯语rw卢旺达语zh中文、汉语
fi芬兰语la拉丁语sa梵语zu祖鲁语
fj斐济语lb卢森堡语sc萨丁尼亚语
fo法罗语lg卢干达语

附录B：语音资源列表

Key释义
liveness_blink“请眨眼”
liveness_mouth_open“请张嘴”
liveness_shakehead“请向左或向右缓慢转头”
liveness_nod“请缓慢点头”
liveness_well_done“很好”

附录C：图片资源列表

Key释义
liveness_home_closeicon右上角关闭按钮资源
liveness_home_loadingicon在loading过程中，loading效果素材
liveness_blink_eye_close眨眼动画中的闭眼图片
liveness_blink_eye_open眨眼动画中的睁眼图片
liveness_mouth_close张嘴动画中的闭嘴图片
liveness_mouth_open张嘴动画中的张嘴图片
liveness_nod_down点头动画中的低头图片
liveness_nod_up点头动画中的抬头图片
liveness_shakehead_left摇头动画中的向左摇头图片
liveness_shakehead_right摇头动画中的向右摇头图片

附录D：文本资源列表

Key文案内容
livenessHomePromptFrontalFaceText“请让我看到您的正脸”
livenessHomePromptWaitText“验证中，请稍候”
livenessHomePromptFaceEreaText“人脸有效面积太小”
livenessHomePromptBrighterText“请让光线再亮点”
livenessHomePromptDarkerText“请让光线再暗点”
livenessHomePromptCloserText“请再靠近一些”
livenessHomePromptFurtherText“请离屏幕远一些”
livenessHomePromptNoBacklightingText“请避免侧光或背光”
livenessHomePromptFrontalFaceInBoundingBoxText“请将正脸置于取景框内”
livenessHomePromptNoEyesOcclusionText“请勿遮挡眼睛”
livenessHomePromptNoMouthOcclusionText“请勿遮挡嘴巴”
livenessHomePromptStayStillText“很好，请保持不动”
livenessHomePromptShakeHeadText“请向左或向右缓慢转头”
livenessHomePromptNodText“请缓慢点头”
livenessHomePromptOpenMouthText“请张嘴”
livenessHomePromptBlinkText“请眨眼”
livenessExitTitlePromptText“确认退出吗”
livenessExitLeftPromptText“取消”
livenessExitRightPromptText“确定”
livenessHomePromptTooBrightText“光线过亮，请到更暗的环境中验证”

附录E：host取值列表

Host取值含义
https://api.megvii.com中国集群。目前只支持调用中国集群。

当前版本

  • v2.0.0

历史版本

← 计费说明SDK-接入文档(ios版) →