ymx-baidu-ocr
    正在准备搜索索引...

    接口 HkMacauTwCardData

    港澳台证件识别参数

    通过 exitentrypermitType 指定具体出入境许可证件类型

    interface HkMacauTwCardData {
        autoTimeoutMs?: number;
        captureMode?: CaptureMode;
        exitentrypermitType: string;
        extraParams?: Record<string, string | number | boolean>;
        hideAlbum?: boolean;
        returnImage?: boolean;
    }

    层级 (查看层级一览)

    索引

    属性

    autoTimeoutMs? captureMode? exitentrypermitType extraParams? hideAlbum? returnImage?

    属性

    autoTimeoutMs?: number

    自动采集超时时间（毫秒），仅自动采集模式生效； 超过该时间未检测到合格画面时 SDK 触发 AUTO_CAPTURE_TIMEOUT 错误

    5000
    captureMode?: CaptureMode

    采集模式，身份证正面/反面自动识别请使用 idCardFrontAuto / idCardBackAuto， 或设置 captureMode: 'auto'

    manual
    exitentrypermitType: string

    出入境许可证件类型

    • hk_mc_passport_front 港澳通行证正面
    • hk_mc_passport_back 港澳通行证反面
    • tw_passport_front 台湾通行证正面
    • tw_passport_back 台湾通行证反面
    • tw_return_passport_front 台胞证正面
    • tw_return_passport_back 台胞证反面
    • hk_mc_return_passport_front 返乡证正面
    • hk_mc_return_passport_back 返乡证反面
    extraParams?: Record<string, string | number | boolean>

    动态追加的识别参数（key 为云端 API 参数名）

    • 字符串值使用 putParam，布尔值使用 putBoolParam，数值使用 putNumberParam 写入
    {
      detect_direction: true,
      probability: true
    }
    hideAlbum?: boolean

    是否隐藏从相册选图的按钮，默认显示相册选图按钮，设为 true 时隐藏

    false
    returnImage?: boolean

    是否在返回结果中附带采集图片（JPEG 格式的 Base64 编码）， 开启后会增加一次图片编码耗时，仅在业务需要展示/回传识别图片时开启

    false

    显示设置

    成员可见性

    目录

    属性