ML Kit 文档扫描器插件

非官方电容插件 ML Kit 文档扫描器[^1]

使用大小写

文档扫描器插件通常用于应用程序需要将纸面文档与相机数字化时,例如:

• 收支记录:让用户扫描收据和发票作为JPEG图像或PDF文件进行费用跟踪.
• 文档存档:将合同、信件和其他文件数字化为多页PDF文件.
• 提交的表格:让用户在您的应用程序中扫描并提交签名的表格或辅助文档.
• 清除文档相片: 使用由ML驱动的图像清理能力去除扫描页上的污点和指头.

兼容性

安装

你可以用我们的 AI 辅助设置 以安装插件. 添加数据 超级技能 至您的 AI 工具,使用以下命令:

npx skills add capawesome-team/skills --skill capacitor-plugins

然后使用下列提示:

Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capacitor-mlkit/document-scanner` plugin in my project.

如果你喜欢 手动设置,通过运行以下命令来安装插件,并遵循下面的平台特定指令:

npm install @capacitor-mlkit/document-scanner
npx cap sync

机器人

变量

如果需要, 您可以在您的应用程序中定义以下工程变量 variables.gradle 要更改依赖的默认版本的文件 :

• $mlkitDocumentScannerVersion 版本 com.google.android.gms:play-services-mlkit-document-scanner (默认 : 16.0.0(中文(简体) )

如果您在工程中遇到其它插件的依赖性冲突, 这会有所帮助 .

使用量

以下例子显示了如何扫描文档以及如何检查并安装Google文档扫描器模块.

扫描文档

启动文档扫描程序,打开ML Kit文档扫描器 UI. 您可以允许图片库导入,限制页面数量,并选择结果格式和扫描器模式. 仅在Android上可用:

import { DocumentScanner } from '@capacitor-mlkit/document-scanner';

const scanDocument = async () => {
  const result = await DocumentScanner.scanDocument({
    galleryImportAllowed: true,
    pageLimit: 5,
    resultFormats: 'JPEG_PDF',
    scannerMode: 'FULL',
  });

  console.log('Scanned images:', result.scannedImages);
  console.log('PDF info:', result.pdf);
};

在Android上,系统可能在扫描仪打开时破坏应用程序. 在这种情况下,承诺永远不会实现。 相反,结果是通过 appRestoredResult 一、导 言 应用插件 当应用程序恢复时:

import { App } from '@capacitor/app';

App.addListener('appRestoredResult', event => {
  if (event.pluginId !== 'DocumentScanner' || event.methodName !== 'scanDocument') {
    return;
  }
  if (event.success) {
    const scannedImages = event.data.scannedImages;
  } else {
    console.error(event.error?.message);
  }
});

检查并安装 Google 文件扫描器模块

文档扫描器模型,扫描逻辑,和UI流被Google Play服务动态下载. 检查模块是否可用, 并在需要时安装 。 安装只从此调用开始 googleDocumentScannerModuleInstallProgress 事件向您通报进展。 仅在Android上可用:

import { DocumentScanner } from '@capacitor-mlkit/document-scanner';

const isGoogleDocumentScannerModuleAvailable = async () => {
  const result = await DocumentScanner.isGoogleDocumentScannerModuleAvailable();
  console.log('Is Google Document Scanner module available:', result.available);
};

const installGoogleDocumentScannerModule = async () => {
  await DocumentScanner.installGoogleDocumentScannerModule();
  console.log('Google Document Scanner module installation started.');
};

DocumentScanner.addListener('googleDocumentScannerModuleInstallProgress', (event) => {
  console.log('Installation progress:', event.progress, '%');
  console.log('Current state:', event.state);
});

API 密码

• scanDocument(...)
• isGoogleDocumentScannerModuleAvailable()
• installGoogleDocumentScannerModule()
• addListener('googleDocumentScannerModuleInstallProgress', ...)
• removeAllListeners()
• 接口
• 数字

扫描文档(...)

scanDocument(options: ScanOptions) => Promise<ScanResult>

开始文档扫描进程.

请注意: 打开 机器人,系统可能在扫描仪打开时破坏应用程序。 在这种情况下,承诺 决不会下定决心 相反,结果是通过 appRestoredResult 一、导 言 应用插件 当应用程序恢复时.

只能从Android上找到.

回返情况: Promise<ScanResult>

自: 7.3.0 (单位:千美元)

是GoogleDocumentScannerModuleAvailable( ) 文档扫描器

isGoogleDocumentScannerModuleAvailable() => Promise<IsGoogleDocumentScannerModuleAvailableResult>

请检查google文档扫描器模块是否可用 .

如果Google文档扫描器模块不可用,您可以通过使用 installGoogleDocumentScannerModule()。 。 。 .

只能从Android上找到.

回返情况: Promise<IsGoogleDocumentScannerModuleAvailableResult>

自: 7.3.0 (单位:千美元)

安装 GoogleDocumentScannerModule ()

installGoogleDocumentScannerModule() => Promise<void>

安装谷歌文档扫描器模块 .

请注意:这只开始安装. 这个 googleDocumentScannerModuleInstallProgress 事件听众会 安装完成后通知您.

只能从Android上找到.

自: 7.3.0 (单位:千美元)

添加倾听器( “ googleDocumentScannerModule Install Progress” ,...)

addListener(eventName: 'googleDocumentScannerModuleInstallProgress', listenerFunc: (event: GoogleDocumentScannerModuleInstallProgressEvent) => void) => Promise<PluginListenerHandle>

当Google文档扫描器模块安装时调用.

只能从Android上找到.

回返情况: Promise<PluginListenerHandle>

自: 7.3.0 (单位:千美元)

删除所有收听器( )

removeAllListeners() => Promise<void>

删除此插件的所有听众 .

只能从Android上找到.

自: 7.3.0 (单位:千美元)

接口

扫描结果

文档扫描操作结果 .

PdfInfo 数据

扫描选项

Is Google DocumentScannerMudule Avail可生效文件

插件听筒

谷歌文档扫描器模块Install ProgressEvent

数字

谷歌文件扫描器模块Install State

页:1

• ML Kit文档扫描器模型,扫描逻辑,和UI流被Google Play服务动态下载. 用户可能必须在第一次使用前等待这些下载. 您可以使用 GoogleDocumentScannerModuleAvailable 并安装 GoogleDocumentScannerModule 方法来检查和安装模块,并听取 GoogleDocumentScannerModule Install 进度更新事件 .
• 这个API需要Android API级别21或以上.
• 它还需要最小的设备总RAM为1.7GB. 如果更低,则返回一个 MlKitException 有错误代码 UNSUPPORTED 当调用 API( 此插件将拒绝承诺) 时 .
• 认为生成文档文件需要时间并需要处理功率,所以仅请求输出格式(JPEG,或PDF,或两者兼用) resultFormats 选项.

财务问题

此插件支持哪些平台 ?

该插件只在Android上可用,因为基础的ML Kit文档扫描器由Google Play服务提供. 所有的方法都拒绝在其他平台上.

为什么文档扫描仪不能首先使用?

ML Kit文档扫描器模型,扫描逻辑,和UI流被Google Play服务动态下载,因此用户可能不得不等下载后再首次使用. 使用 isGoogleDocumentScannerModuleAvailable() 检查模块, installGoogleDocumentScannerModule() 安装,并听 googleDocumentScannerModuleInstallProgress 用于更新进度的事件.

从扫描中可以得到哪些结果格式?

您可以通过 : resultFormats 选项。 然后,结果包含一系列URI,用于扫描图像页面和/或关于生成的PDF的信息,包括其URI和页数. 由于生成文档文件需要时间和处理能力,所以只请求您实际需要的格式.

扫描器模式有什么区别?

这个 BASE 模式提供了基本的编辑能力,如裁剪、旋转和重排页面。 这个 BASE_WITH_FILTER 模式增加了图像过滤器,如灰度和自动图像增强等. 这个 FULL 模式(默认)额外提供由ML驱动的图像清理能力,例如去除污点和指头,并将随着Google Play服务的更新而自动接收未来的主要功能.

是否有设备要求?

是,API要求Android API级别为21级或以上,最低设备总RAM为1.7 GB. API 返回一个 MlKitException 有错误代码 UNSUPPORTED 而插件拒绝承诺.

用户可以导入已有相片而不是扫描吗 ?

是的,设置 galleryImportAllowed 选项到 true 允许从相册中导入页面。 默认已禁用 .

相关插件

• ML Kit 条码扫描:用ML Kit Barcode扫描扫描条码和QR码.
• PDF 查看器: 在全屏本地查看器中显示 PDF 文档.
• 文件打开器: 打开带有默认应用程序的扫描文件.

术语和隐私

此插件使用 Google ML Kit (Google ML Kit) 页面存档备份,存于互联网档案馆数字 :

• 术语和隐私
• Android 数据披露
• iOS 数据披露

通讯

随时更新有关卡帕韦索姆、Capacitor和Ionic生态系统的最新消息和最新消息,因为我们 《卡帕索克通讯》。 。 。 .

更改日志

见 变动情况。 。 。 .

许可证

见 自由主义。 。 。 .

[^1]: 这个项目不附属于Google LLC或其任何子公司或子公司,也不获得其认可、支持、赞助或批准.