@capacitor-community/image-to-text

中文文档
8.0.0发布于 2026/01/12Hippocratic License Version 2.0TypeScriptESM + CJS零依赖近 30 天下载 1.4万

图像到 Capacitor 的文本插件

中文使用文档
文档目录15 节
  1. 图像到文本
  2. 贷项
  3. 安装
  4. 使用量
  5. 相机示例
  6. iOS 用户
  7. 机器人用途
  8. 创建 Firebase 工程和 App
  9. 添加防火基地 SDK
  10. API 参考
  11. 检测文本(...)
  12. 接口
  13. 数字
  14. 兼容性
  15. 许可证


图像到文本

@capacitor-community/image-to-text

图像用于文本处理的Capacitor插件,使用苹果公司的IOS视野框架和MLKit的Android视野框架.

贷项

这个项目是从.. 密码 ML vennela Kodali所写的插件. 后被重构并被改造为Capacitor 4.

  • 对于控制器 4 项目使用 v4.x
  • 5个项目使用v5.x
  • 对于控制器 6 项目使用 v6.x

安装

npm install @capacitor-community/image-to-text

使用量

只有一个方法 detectText 它需要图像的文件名,然后返回与之相关的文本.

在您的申请中添加以下内容:

import { Ocr, TextDetections } from '@capacitor-community/image-to-text';

...

const data: TextDetections = await Ocr.detectText({ filename: '[get-filename-of-image-jpg]' });
for (let detection of data.textDetections) {
    console.log(detection.text);
}

上述代码将转换图像文件并 console.log 中找到的文本.

相机示例

你可以用这个 @capacitor/camera 拍照并转换为文本的插件 :

import { Camera, CameraResultType, CameraSource } from '@capacitor/camera';
import { Ocr, TextDetections } from '@capacitor-community/image-to-text';

.

const photo = await Camera.getPhoto({
  quality: 90,
  allowEditing: true,
  resultType: CameraResultType.Uri,
  source: CameraSource.Camera,
});

const data: TextDetections = await Ocr.detectText({ filename: photo.path });

for (let detection of data.textDetections) {
  console.log(detection.text);
}

可以找到完整的样本应用程序 这里。 。 。 .

video of scanning a card and it being converted to text

iOS 用户

在 iOS Capacitor 工程中使用此插件不需要额外的设置.

机器人用途

你的项目必须包括 google-services.json 存储在 Android 项目文件夹中的文件( 通常是) android/app) (中文(简体) ).

创建 Firebase 工程和 App

  • 签名到 控制台. firebase.google.com (原始内容存档于2017-10-22)
  • 点击 Add Project 并跟随步道.
  • 点击 Android 图标创建android应用程序.
  • 输入 Package Name 它必须与您的应用程序软件包名称相匹配( 您可以在 android/app/AndroidManifest.xml) (中文(简体) ).
  • 点击 Register App
  • 下载 google-services.json 并保存到您的项目 android/app 目录.

添加防火基地 SDK

示范项目在以下几个方面都有此规定: build.gradle (见 此处作为参考) (中文(简体) ).

注意: 大多数启动的 Capacitor 项目都是预配置以加载 google-services.json。 。 。 .

API 参考

检测文本(...)

detectText(options: DetectTextFileOptions | DetectTextBase64Options) => Promise<TextDetections>

在图像中检测文本

参数类型说明
optionsDetectTextFileOptions | DetectTextBase64Options文本检测选项

回返情况: Promise<TextDetections>


接口

文本检测

Prop类型
textDetectionsTextDetection[]

文本检测

Prop类型
bottomLeft[number, number]
bottomRight[number, number]
topLeft[number, number]
topRight[number, number]
textstring

检测文本选项

Prop类型
filenamestring
orientationImageOrientation

检测TextBase64 选项

Prop类型
base64string
orientationImageOrientation

数字

图像方向

成员数值
Up'UP'
Down'DOWN'
Left'LEFT'
Right'RIGHT'

兼容性

图像预计仅采用肖像模式,即文字正对. 它甚至会试图以其他方式处理,但指出它可能导致胡言乱语.

iOS和Android得到支持. 网络不是.

特性欧斯机器人
ML 框架CoreML 愿景火炮基地 MLKit
用静态图像进行文本检测对对
检测文本行对对
文本的边界坐标对对
图像方向是(上,左,右,下)是(上,左,右,下)
扭曲文本对无可靠性
已旋转的文本(%%% 45deg)对是(但有声音)
在线对对
SDK/ios 版本ios 13.0 或更新目标 API 级别 QQ 16
使用 Gradle QQ 4.1
com.android.tools.build:gradle === 3.2.1 (英语)
编译SdkVersion − 28

许可证

Hippocratic许可证版本2.0.

更多信息请参考LICENSE文件

版本与发布记录

@capacitor-community/image-to-text 共发布 11 个版本,首次发布于 2023/02/24;过去 12 个月发布了 1 个版本。

版本发布日期距今
8.0.0latest2026/01/129 个月前
7.0.02025/02/171.7 年前
6.0.12024/04/172 年前
6.0.02024/04/162 年前
5.0.32023/10/303 年前
5.0.22023/09/083 年前

关于 @capacitor-community/image-to-text 的常见问题

@capacitor-community/image-to-text 是什么?

图像到 Capacitor 的文本插件

如何安装 @capacitor-community/image-to-text?

在项目目录运行 npm install @capacitor-community/image-to-text,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@capacitor/core(>=8.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@capacitor-community/image-to-text 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@capacitor-community/image-to-text 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@capacitor-community/image-to-text 可以商用吗?

@capacitor-community/image-to-text 使用 Hippocratic License Version 2.0 许可。声明的许可为 Hippocratic License Version 2.0,请阅读许可原文确认使用条件。以上为概括,不构成法律意见,请以许可原文为准。

@capacitor-community/image-to-text 的下载量有多少?

根据 npm 官方下载统计,@capacitor-community/image-to-text 在 2026/10/09 – 2026/11/07 这 30 天内被下载 14,075 次,日均约 469 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@capacitor-community/image-to-text 还在维护吗?

最新版本 8.0.0 发布于 2026/01/12(9 个月前);至今共发布 11 个版本,其中过去 12 个月发布了 1 个;首次发布于 2023/02/24。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。