x-ocr-s
开发文档
如果需要查看效果请下载TMUI4.0组件库应用demo,导航到原生插件栏目体验。
本插件会让你的安卓应用增加大约8.7mb体积本插件会让你的IOS应用增加大约38mb(估算)体积web端需要网络加载模型文件,因为web无法离线,也不是调用api就是本地模型加载一次后,就不需要网络了
UniApp 适配的版本
功能
支持以下特殊的ocr文本识别。离线识别,不需要联网
注意:鸿蒙使用本插件时第二参数语言类型不会起作用,它会自适应识别语言。
- 支持中文
- 支持英文
- 支持韩文
- 支持日文
兼容性
Harmony | IOS | Android | WEB | 小程序 |
---|---|---|---|---|
支持 | 支持 | 支持 | 支持 | x |
说明
这是tmui4.0|XUI的原生插件附赠插件。种子用户可免于购买。
非种子用户:
普通授权:99元 源码授权:299元
使用
如果是安卓请务必打自定义基座,如果ios:你在mac环境下配置好了环境无需打包本地编译,如果win开发ios需要打包基座。
安卓:
如果你需要32位系统和模拟器x86上运行,需要自行配置打包cpu 支持类型,配置abis 需要自定义基座运行,且安卓5.0+(含5.0)以上支持
Ios: 同样按照官方文档配置所需CPU类型,默认是arm64
WEB: 请复制插件目录中的static目录到低的根目录static目录中即可。
API说明
插件提供了三个主要的API函数用于OCR文本识别:
1. chooseImageBuilder
从相册或相机选择图片进行文字识别
ts
chooseImageBuilder(
callback: (str: string[], source: string[]) => void,
langs: string|null
)
参数说明:
- callback:识别结果回调函数
- str: 识别出的文本数组
- source: 包含文本位置信息的数组,每个元素为JSON字符串,格式为:
{boundingBox:[left,top,width,height], text:string}
- langs:识别语言,可选值:
- 'zh':中文识别
- 'ja':日文识别
- null:默认中文zh
2. downloadUrlImageBuilder
下载网络图片进行文字识别
ts
downloadUrlImageBuilder(
url: string,
callback: (str: string[], source: string[]) => void,
langs: string|null
)
参数说明:
- url:网络图片地址
- callback:识别结果回调函数,参数同chooseImageBuilder
- langs:识别语言,可选值同chooseImageBuilder
3. localFilePathImageBuilder
识别本地图片文件
ts
localFilePathImageBuilder(
pathfile: string,
callback: (str: string[], source: string[]) => void,
langs: string|null
)
参数说明:
- pathfile:本地图片文件路径
- callback:识别结果回调函数,参数同chooseImageBuilder
- langs:识别语言,可选值同chooseImageBuilder
使用示例
ts
import {chooseImageBuilder,downloadUrlImageBuilder,localFilePathImageBuilder} from "@/uni_modules/x-ocr-s"
// 从相册/相机选择图片识别
chooseImageBuilder((txt:string[], sour:string[])=>{
// txt为识别出的文本数组
// sour为包含位置信息的JSON字符串数组,需要JSON.parse转换
sour.forEach(item => {
const info = JSON.parse(item)
console.log('文本:', info.text)
console.log('位置:', info.boundingBox)
})
}, 'zh')
// 识别网络图片
downloadUrlImageBuilder(
'https://example.com/test.jpg',
(txt:string[], sour:string[])=>{
console.log('识别文本:', txt)
console.log('详细信息:', sour)
},
'ja' // 日文识别
)
// 识别本地图片
localFilePathImageBuilder(
'/static/test.png',
(txt:string[], sour:string[])=>{
console.log('识别文本:', txt)
console.log('详细信息:', sour)
},
'zh' // 中文识别
)
注意事项
- 识别置信度默认设置为0.50,只返回置信度大于等于0.50的识别结果
- 回调函数中的source参数需要通过JSON.parse解析才能获取位置信息
- 建议图片清晰度较高,避免模糊、反光等影响识别效果
- Web端首次使用需要下载模型文件,请确保网络环境良好
更新日志
1.0.8(2025-08-17)
- 兼容鸿蒙原生
1.0.7(2025-02-14)
- 增加对web的支持,web使用时需要网络加载模型数据
1.0.6(2024-12-18)
- ios,安卓添加本地路径识别函数localFilePathImageBuilder,可自己循环批量处理.
1.0.5(2024-11-01)
- 修复ios可能的兼容问题
1.0.4(2024-10-31)
- ios没对齐安卓,失败不会返回回调.
1.0.3(2024-10-27)
升级了调用方式,使得安卓,ios用同样的方式调用,不再区别,统一使用callback,并且在回调中携带回了坐标,以便让大家通过坐标计算识别比例或者绘制位置 .并且文本块统一为行返回(之前是文本块返回,但在源始数据中还是块和坐标)
1.0.2(2024-09-24)
- 各个函数追回了个参数language:string|null,可以是zh,ja,两种语言中文和日文识别。
1.0.1(2024-05-04)
- 更新支持IOS端,需要IOS12.0(含)+
1.0.0(2024-04-10)
- ocr文本识别,ai模型识别,离线识别。
- tmui4.0种子用户,可免费赠送源码,无需购买