builder
DocumentRecognition.Builder
| 参数 | 功能 | 是否必填 |
|---|---|---|
| mobileToken | 客户密钥，用于标识收集的数据来源于您的应用程序。如果尚未收到您的 mobile-token，请联系支持团队。 | 是。 |
| .setDocumentSteps(DocumentRecognitionStep[] documentSteps) | 定义用户进行的文档采集流程。更多信息请点击这里 | 是。 |
| .setSandboxEnvironment() | 若在构造函数中使用此参数，库将配置为向沙盒环境发送数据。若不存在，请求将发送到生产环境。 | 否。 |
| .showIntroductionScreens(Boolean showIntroductionScreens) | 设置为 "false" 时，禁用向用户显示的文档照片采集介绍屏幕。 | 否。默认值为 "true"。 |
| .setShowSuccessScreen(Boolean showSuccessScreen) | 设置为 "false" 时，禁用照片采集后的成功屏幕。 | 否。默认值为 "true"。 |
| .setBackgroundColor(String backgroundColor) | 允许配置 SDK activities 的背景颜色。 | 否。默认值为 "#ffffff"。 |
| .setFontColor(String fontColor) | 允许配置 SDK activities 的字体和图标颜色。 | 否。默认值为 "#000000"。 |
| .setFontFamily(FontFamily fontFamily) | 允许配置 SDK activities 的字体。 | 否。若未指定，默认为 FontFamily.open_sans。可用字体：FontFamily.open_sans、FontFamily.futura、FontFamily.verdana、FontFamily.roboto、FontFamily.poppins 和 FontFamily.helvetica。 |
| .setVisualConfiguration(VisualConfiguration. visualConfiguration) | 用于自定义 SDK 执行过程中向用户显示的图片。 | 否。 |
| .setTextConfiguration(TextConfiguration. textConfiguration) | 用于自定义 SDK 执行过程中向用户显示的引导屏幕上的文本。 | 否。 |
| .setSessionId(String sessionId) | 用于设置标识 SDK 启动会话的密钥。用于通过日志跟踪用户在 FaceRecon 执行过程中的完整流程。此字段最多接受 255 个字符。 | 否。 |
| .setLogLevel(DocumentRecognition.LogLevel logLevel) | 用于自定义 SDK 日志的详细级别。可用级别：LogLevel.debug、LogLevel.info、LogLevel.warn、LogLevel.error 和 LogLevel.trace。默认为 LogLevel.debug。 | 否。 |
| .setAudioConfiguration(AudioConfiguration audioConfiguration) | 配置 SDK 的语音引导，实时朗读拍摄指引。接受的配置为 AudioConfiguration.enable（显示音频开关按钮，语音默认关闭）、AudioConfiguration.disable（关闭语音并隐藏按钮）和 AudioConfiguration.accessibility（显示按钮，当设备启用了无障碍功能时语音默认开启）。当 TalkBack 开启时，完整指引由屏幕阅读器本身播报。 | 否。默认值为 AudioConfiguration.disable。 |
| .setLanguage(String language) | 设置 SDK 界面、无障碍提示和语音引导的语言，格式为 BCP 47 语言标签（例如 pt-BR、en、es 或 zh-Hans）。支持的语言：葡萄牙语（pt、pt-BR）、英语（en、en-US）、通用西班牙语（es、es-MX、es-419）和简体中文（zh、zh-Hans、zh-CN）。 标签不区分大小写，也接受 _ 作为分隔符（pt_BR）。不支持的标签（如 fr 或 zh-TW）会以英语显示 SDK，并在日志中记录警告。SDK 不使用设备的系统语言。 | 否。未设置时默认为葡萄牙语。 |
语言
- SDK 从不使用设备的系统语言，由您的集成代码决定。如需跟随应用的语言，请直接传入应用当前的语言标签，例如
Locale.getDefault().toLanguageTag()。 - 自定义的引导页文字（
onboardingTextConfiguration）会按传入的内容原样显示，请传入已翻译成所选语言的文字。 - 当设备安装了所选语言的语音时，语音引导会使用该语言播报；否则，本次会话中 SDK 的语音播报将保持关闭。TalkBack 仍会以所选语言朗读操作提示。
Android App Bundle
以 Android App Bundle 形式发布应用时，Google Play 只会安装用户设备所设置的语言。如果您的应用选择了与设备不同的语言，请在应用模块的 build.gradle 中关闭按语言拆分：
android {
bundle {
language {
enableSplit = false
}
}
}
如果所选语言的翻译未被安装，SDK 将以葡萄牙语显示，并在日志中记录警告。
VisualConfiguration 对象
| 参数 | 功能 | 是否必填 |
|---|---|---|
| .setOnboardingDrawable(int onboarding_drawable, int onboarding_width) | 用于配置在 SDK 引导屏幕上向用户显示的图片。参数 onboarding_drawable 应引用要显示的图片 ID，onboarding_width 是该图片的预期显示尺寸。 | 否。 |
| .setDocumentFullDrawable(int documentfull_drawable, int documentfull_width) | 用于配置在 SDK 完整驾照采集屏幕上向用户显示的图片。参数 documentfull_drawable 应引用要显示的图片 ID，documentfull_width 是该图片的预期显示尺寸。 | 否。 |
| .setDocumentFrontDrawable(int documentfront_drawable, int documentfront_width) | 用于配置在 SDK 驾照和身份证正面采集屏幕上向用户显示的图片。参数 documentfront_drawable 应引用要显示的图片 ID，documentfront_width 是该图片的预期显示尺寸。 | 否。 |
| .setDocumentBackDrawable(int documentback_drawable, int documentback_width) | 用于配置在 SDK 驾照和身份证背面采集屏幕上向用户显示的图片。参数 documentback_drawable 应引用要显示的图片 ID，documentback_width 是该图片的预期显示尺寸。 | 否。 |
| .setButtonBorderSize(int border_size) | 用于配置 SDK 按钮的边框宽度。 | 否。默认值为 1。 |
| .setButtonShadow(boolean button_shadow) | 设置为 false 时，移除 SDK 按钮使用的 Android 默认阴影效果。 | 否。默认值为 true。 |
TextConfiguration 对象
| 参数 | 功能 | 是否必填 |
|---|---|---|
| .setCustomText(CustomLabel label, String text) | 用于配置在 SDK 引导屏幕上向用户显示的文本 | 否。 |