Skaner dokumentów z ML Kit na Androidzie

Użyj interfejsu ML Kit Document Scanner API, aby łatwo dodać funkcję skanera dokumentów do aplikacji.

Funkcja Szczegóły
Nazwa pakietu SDK play-services-mlkit-document-scanner
Implementacja Modele, logika skanowania i przepływ interfejsu są pobierane dynamicznie przez usługi Google Play.
Wpływ na rozmiar aplikacji Rozmiar pobierania wzrośnie o ok. 300 KB.
Czas inicjowania Przed pierwszym użyciem użytkownicy mogą musieć poczekać na pobranie modeli, logiki i interfejsu.

Wypróbuj

Wypróbuj przykładową aplikację, aby zobaczyć, jak używać tego interfejsu API.

Zanim zaczniesz

  1. W pliku build.gradle na poziomie projektu dodaj repozytorium Maven firmy Google do sekcji buildscript i allprojects.

  2. Dodaj zależność z biblioteką skanera dokumentów ML Kit do pliku Gradle na poziomie aplikacji modułu, który zwykle znajduje się w folderze app/build.gradle:

dependencies {
   // …
   implementation 'com.google.android.gms:play-services-mlkit-document-scanner:16.0.0-beta1'
}

Konfiguracja skanera dokumentów

Ścieżka użytkownika skanera dokumentów (która obejmuje dedykowany ekran wizjera i ekran podglądu) jest udostępniana przez pakiet SDK. Wizjer i ekran podglądu obsługują te konfigurowalne elementy sterujące:

  • importowanie z galerii zdjęć,
  • ustawienie limitu liczby skanowanych stron,
  • tryb skanera (do kontrolowania zestawów funkcji w procesie);

Zeskanowane dokumenty możesz pobrać w formacie PDF i JPEG.

Utwórz instancję GmsDocumentScannerOptions, aby skonfigurować opcje skanera:

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();

Skanowanie dokumentów

Po utworzeniu GmsDocumentScannerOptions uzyskaj instancję GmsDocumentScanner. Następnie możesz rozpocząć aktywność skanera, korzystając z interfejsów Activity Result API wprowadzonych w Androidzie X.

Po zakończeniu skanowania dokumentu obiekt GmsDocumentScanningResult umożliwi dostęp do liczby zeskanowanych stron, adresów URI obrazów w formacie JPEG i PDF zgodnie z tym, co zostało zdefiniowane za pomocą 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(...);

Wskazówki dotyczące poprawy skuteczności

Pamiętaj, że generowanie plików dokumentów wymaga czasu i mocy obliczeniowej, więc prośby o formaty wyjściowe (JPEG lub PDF albo oba) przesyłaj tylko wtedy, gdy są Ci one potrzebne.