本节提供声网 SDK 中插件相关 API 的参考文档。
RtcEngineConfig
类的 addExtensionRtcEngine
类的 enableExtensionRtcEngine
类的 setExtensionPropertyRtcEngine
类的 getExtensionPropertyIMediaExtensionObserver
类的 onEventAgoraRtcEngineKit
类的 enableExtensionWithVendorAgoraRtcEngineKit
类的 setExtensionPropertyWithVendorAgoraRtcEngineKit
类的 getExtensionPropertyWithVendorAgoraMediaFilterEventDelegate
类的 onEvent在声网 SDK 中调用插件相关 API 时,需要传入指定的 key 和 value。本节介绍远鉴人脸活体检测支持的 key-value 列表。
调用声网 SDK 的 setExtensionProperty
方法时,支持传入以下 key:
setExtensionProperty 方法的 key | 描述 |
---|---|
init | 初始化 |
声网 SDK 的 onEvent
回调可能包括以下 key:
onEvent 回调的 key | 描述 |
---|---|
text |
更新文本内容的提示 |
result |
活体检测完成后的结果 |
preerror |
活体检测初始化失败的信息 |
FosaferManager 的初始化方法。
value 包含以下参数:
value 参数 | 描述 |
---|---|
context |
Context 型,当前activity的上下文。 |
rtcEngine |
RtcEngine 型,声网引擎实体类。 |
appkey |
String 型,远鉴活体检测申请的 appkey。 |
appsecret |
String 型,远鉴活体检测申请的 appsecret。 |
value 包含以下参数:
value 参数 | 描述 |
---|---|
text |
String 型,更新文本内容的提示。 |
result |
String 型,活体检测完成后的结果。 |
preerror |
String 型,活体检测初始化失败的信息。 |
错误码 | 说明 | 解决方法 |
---|---|---|
1001 | 未知错误。 | / |
1002 | 参数缺失。 | 检查参数appid,appkey,appsecret是否都输入了 |
1003 | 服务验证错误。 | 根据提示错误信息进行修正 |
1009 | 引擎忙。 | 请退出去重试 |
1010 | 已取消 | / |
1102 | 未准备好。 | 需要先调用相应的prepare方法 |
1015 | 检测失败。 | / |
1016 | 检测超时。 | / |
1017 | 长时间未检测到数据。 | / |
1018 | 分数没达标。 | 请重新检测 |
调用声网 SDK 的 setExtensionPropertyWithVendor
方法时,支持传入以下 key:
setExtensionPropertyWithVendor 方法的 key | 描述 |
---|---|
set_appKey_appSecret | 设置 appKey 和 appSecret |
retry | 重试 |
声网 SDK 的 onEvent
回调可能包括以下 key:
onEvent 回调的 key | 描述 |
---|---|
result | 当前识别结果 |
value 包含以下参数:
value 参数 | 描述 |
---|---|
appKey |
NSString 类型,使用远鉴活体检测的 appKey。 |
appSecret |
NSString 类型,使用远鉴活体检测的订阅密钥。 |
value 包含以下参数:
value 参数 | 描述 |
---|---|
retry |
BOOL 类型,固定传@1即可 |
value 包含以下参数:
value 参数 | 描述 |
---|---|
errorCode |
NSString 类型,错误码 |
message |
NSString 类型,错误信息 |
错误码 | 说明 | 解决方法 |
---|---|---|
0 | 校验为活体 | / |
1001 | 检测超时 | 可以重新校验,调用retry,或者停止检测 |
1002 | 打开引擎库失败 | 返回上一个页面,重新进入检测页面 |
1003 | 引擎库返回人脸图片为空 | 重新检测,调用retry |
1004 | setProperty方法参数格式错误 | setExtensionPropertyWithVendor方法的value参数是否为json格式的字符串 |
1005 | appKey是空的 | set_appKey_appSecret传入的appKey是否为空 |
1006 | appSecret是空的 | set_appKey_appSecret传入的appSecret是否为空 |
2000 | 人脸图像采集成功 | / |
2001 | 未识别到人脸信息 | / |
2002 | 脸部位置不合法 | / |
2003 | 脸部面积太小了 | / |
2004 | 脸部面积太大了 | / |
2005 | 光线太暗了 | / |
2006 | 光线太亮了 | / |
2007 | 清晰度太低了 | / |
2008 | 手机需要竖屏 | / |
3001 | 网络请求出错 | 检查网络,重新检测,调用retry |
3002 | 检测失败 | 根据onEvent方法返回的具体提示做处理 |