OcrOptions 对象

startOcr 参数

参数	类型	作用	必填
environment	CaaSEnvironment	用于将运行环境设置为 sandbox 或 production 的枚举。	是。
mobileToken	String	标识所采集数据来自您应用的客户端密钥。如果您尚未收到 mobile-token，请联系支持团队。每个环境需要不同的 token。	是。
document	CaaSDocumentType	定义用户完成的证件采集流程的枚举。	是。
options	OcrOptions?	包含 SDK 视觉、文案和行为自定义项的可选对象。	否。

OcrOptions

所有字段均为可选。未提供某个字段时，原生 SDK 会使用其默认值。

参数	类型	作用	默认值
sessionId	String?	标识 SDK 中启动的会话的密钥，用于通过日志追踪用户完成的完整流程。最多接受 255 个字符。	内部生成。
fontColor	String?	SDK 界面的字体和图标颜色，十六进制格式（例如 "#FFFFFF"）。	"#000000"
backgroundColor	String?	SDK 界面的背景颜色，十六进制格式（例如 "#000000"）。	"#FFFFFF"
fontFamily	CaaSFontFamily?	SDK 界面使用的字体。	CaaSFontFamily.openSans
showIntroductionScreens	bool?	设为 false 时，关闭证件采集前的介绍页。	true
showSuccessScreen	bool?	设为 false 时，关闭采集完成后的成功页。	true
audioConfiguration	FaceReconAudioConfiguration?	配置语音引导，实时播报采集指引。	FaceReconAudioConfiguration.disable
onboardingTextConfiguration	OnboardingTextConfiguration?	自定义引导页文案。	SDK 默认文案。
logLevel	CaaSLogLevel?	SDK 日志的详细级别。	CaaSLogLevel.debug

注意

OcrOptions 中的 audioConfiguration 参数自插件 5.3.0 版本起可用。

OnboardingTextConfiguration

参数	类型	作用
onboardingTitle	String?	引导页标题。
onboardingFirstLabel	String?	展示给用户的第一条说明。
onboardingSecondLabel	String?	展示给用户的第二条说明。
onboardingThirdLabel	String?	展示给用户的第三条说明。

OnboardingTextConfiguration(
  onboardingTitle: 'Dicas Importantes',
  onboardingFirstLabel: 'Vá para um local iluminado',
  onboardingSecondLabel: 'Retire o documento do plástico',
  onboardingThirdLabel: 'Garanta que o documento está corretamente enquadrado',
)

枚举

CaaSEnvironment

enum CaaSEnvironment {
  production,
  sandbox,
}

CaaSDocumentType

enum CaaSDocumentType {
  cnhFull,       // 巴西 CNH 驾驶证展开后的单张照片
  cnhDigital,    // 巴西电子 CNH 的 PDF
  cnh,           // 巴西 CNH，正面和背面
  rg,            // 巴西 RG 身份证，正面和背面
  address,       // 居住证明
  rne,           // 巴西外国人国家登记证，正面和背面
  crnm,          // 巴西国家移民登记证，正面和背面
  rgCinDigital,  // 电子 RG/CIN 的 PDF
}

注意

rgCinDigital 类型自插件 5.3.0 版本起可用。

CaaSFontFamily

enum CaaSFontFamily {
  jakarta,       // 仅 iOS
  futura,        // iOS 和 Android
  verdana,       // iOS 和 Android
  trebuchetMs,   // 仅 iOS
  tamilsangamMn, // 仅 iOS
  openSans,      // iOS 和 Android
  helvetica,     // 仅 Android
  poppins,       // 仅 Android
  roboto,        // 仅 Android
  systemFont,    // 仅 iOS
}

注意

字体的可用性因平台而异。如果传入平台不支持的字体，将使用该平台的默认字体。为保证跨平台一致性，请使用 futura、verdana 或 openSans。

FaceReconAudioConfiguration

enum FaceReconAudioConfiguration {
  enable,        // 显示音频开关，播报默认关闭
  disable,       // 关闭播报并隐藏开关
  accessibility, // 当设备启用无障碍功能时，显示开关且播报默认开启
}

CaaSLogLevel

enum CaaSLogLevel {
  trace,
  debug,
  log,
  info,
  warn,
  error,
}