在 Android 上使用 ML Kit 的文件掃描器
使用 ML Kit 文件掃描器 API,即可輕鬆將文件掃描器功能新增至應用程式。
功能 | 詳細資料 |
---|---|
SDK 名稱 | play-services-mlkit-document-scanner |
導入作業 | 模型、掃描邏輯和 UI 流程是由 Google Play 服務動態下載。 |
應用程式大小影響 | 下載大小約增加 300 KB。 |
初始化時間 | 使用者可能必須先等待模型、邏輯和 UI 流程下載完畢,才能開始使用。 |
馬上試試
您可以試用範例應用程式,查看這個 API 的使用範例。
事前準備
在專案層級的
build.gradle
檔案中,請務必在 buildscript 及所有專案區段中納入 Google 的 Maven 存放區。將 ML Kit 文件掃描器程式庫的依附元件新增至模組的應用程式層級 Gradle 檔案,通常為 app/build.gradle:
dependencies {
// …
implementation 'com.google.android.gms:play-services-mlkit-document-scanner:16.0.0-beta1'
}
文件掃描器設定
SDK 提供文件掃描器使用者流程 (包括專屬的觀景窗畫面和預覽畫面)。觀景窗和預覽畫面支援下列可自訂的控制項:
- 從相片庫匯入
- 設定掃描頁數限制
- 掃描器模式 (用於控制流程中的特徵集)
您可以擷取掃描文件的 PDF 和 JPEG 檔案。
將 GmsDocumentScannerOptions
例項化,即可設定掃描器選項:
Kotlin
val options = GmsDocumentScannerOptions.Builder() .setGalleryImportAllowed(false) .setPageLimit(2) .setResultFormats(RESULT_FORMAT_JPEG, RESULT_FORMAT_PDF) .setScannerMode(SCANNER_MODE_FULL) .build()
Java
GmsDocumentScannerOptions options = new GmsDocumentScannerOptions.Builder() .setGalleryImportAllowed(false) .setPageLimit(2) .setResultFormats(RESULT_FORMAT_JPEG, RESULT_FORMAT_PDF) .setScannerMode(SCANNER_MODE_FULL) .build();
掃描文件
建立 GmsDocumentScannerOptions
後,請取得 GmsDocumentScanner
的例項。接著,您就可以按照 AndroidX 中引入的 Activity Result API 啟動掃描器活動。
文件掃描完成後,GmsDocumentScanningResult
物件將可存取掃描的頁面數量、採用 JPEG 格式的圖片 URI 和 PDF 檔案 (因應透過 setResultFormats
的定義):
Kotlin
val scanner = GmsDocumentScanning.getClient(options) val scannerLauncher = registerForActivityResult(StartIntentSenderForResult()) { result -> { if (result.resultCode == RESULT_OK) { val result = GmsDocumentScanningResult.fromActivityResultIntent(result.data) result.getPages()?.let { pages -> for (page in pages) { val imageUri = pages.get(0).getImageUri() } } result.getPdf()?.let { pdf -> val pdfUri = pdf.getUri() val pageCount = pdf.getPageCount() } } } } scanner.getStartScanIntent(activity) .addOnSuccessListener { intentSender -> scannerLauncher.launch(IntentSenderRequest.Builder(intentSender).build()) } .addOnFailureListener { ... }
Java
GmsDocumentScanner scanner = GmsDocumentScanning.getClient(options); ActivityResultLauncher<IntentSenderRequest> scannerLauncher = registerForActivityResult( new StartIntentSenderForResult(), result -> { if (result.getResultCode() == RESULT_OK) { GmsDocumentScanningResult result = GmsDocumentScanningResult.fromActivityResultIntent(result.getData()); for (Page page : result.getPages()) { Uri imageUri = pages.get(0).getImageUri(); } Pdf pdf = result.getPdf(); Uri pdfUri = pdf.getUri(); int pageCount = pdf.getPageCount(); } }); scanner.getStartScanIntent(activity) .addOnSuccessListener(intentSender -> scannerLauncher.launch(new IntentSenderRequest.Builder(intentSender).build())) .addOnFailureListener(...);
提升成效的訣竅
因此,產生文件檔案需要時間且需要處理能力,因此建議您只要求實際所需的輸出格式 (JPEG 和/或 PDF)。