Lecteur de code Google (Android uniquement)

L'API Google Code Scanner fournit une solution complète pour scanner des codes sans que votre application ait besoin de demander l'autorisation d'accéder à l'appareil photo, tout en préservant la confidentialité des utilisateurs. Pour ce faire, la tâche d'analyse du code est déléguée aux services Google Play, et seuls les résultats de l'analyse sont renvoyés à votre application (vidéo 1). Le traitement des images s'effectue sur l'appareil, et Google ne stocke pas les résultats ni les données d'image. L'API accepte les mêmes formats de code que l'API ML Kit Barcode Scanning et renvoie le même objet Barcode.

Cette API est idéale pour les applications qui nécessitent une lecture de code fluide sans avoir besoin d'une interface utilisateur ou d'une expérience d'appareil photo personnalisées. L'implémentation réside entièrement dans les services Google Play, ce qui garantit un impact minimal sur la taille de votre application.

À partir de la version 16.1.0, vous pouvez activer le zoom automatique pour permettre au lecteur de code Google de scanner automatiquement les codes-barres éloignés de l'appareil photo. Lorsque les utilisateurs pointent leur appareil vers un code-barres, le lecteur le détecte intelligemment et effectue un zoom avant. Cela élimine le besoin d'ajuster manuellement le zoom, ce qui rend la lecture des codes-barres plus rapide, plus précise et plus accessible (voir la vidéo 2).

Vidéo 1. Intégration du lecteur de code Google Vidéo 2. Effet de zoom automatique

Pour les cas d'utilisation plus complexes nécessitant une UI personnalisée, nous vous recommandons d'utiliser directement l'API ML Kit Barcode Scanning.

Si vous avez des questions, si vous souhaitez signaler un bug ou si vous avez besoin d'aide, consultez la page de la communauté ML Kit.

Avant de commencer

Pour préparer votre application, procédez comme indiqué dans les sections suivantes.

Configurer votre application

  1. Dans le fichier settings.gradle de premier niveau, incluez le dépôt Maven de Google et le répertoire central Maven sous le bloc dependencyResolutionManagement :

    dependencyResolutionManagement {
  repositories {
    google()
    mavenCentral()
  }
}

  2. Ajoutez la dépendance des services Google Play pour le SDK play-services-code-scanner au fichier de compilation Gradle de votre module, qui est généralement app/build.gradle :

    dependencies {
  implementation 'com.google.android.gms:play-services-code-scanner:16.1.0'
}

  3. Vous pouvez configurer votre application pour que les services Google Play téléchargent automatiquement le module de scanner sur l'appareil lorsque votre application est installée depuis le Play Store.

    <application ...>
  ...
  <meta-data
      android:name="com.google.mlkit.vision.DEPENDENCIES"
      android:value="barcode_ui"/>
  ...
</application>

    Vous pouvez également vérifier explicitement la disponibilité du module de scanner et demander le téléchargement via l'API ModuleInstallClient des services Google Play.

    Si vous n'activez pas les téléchargements de modules au moment de l'installation ou ne demandez pas de téléchargements explicites, et que le module de scanner n'est pas déjà installé pour un autre cas d'utilisation, les services Google Play téléchargent le module de scanner lors de sa première utilisation.

Scanner un code

Suivez les étapes ci-dessous pour scanner un code-barres.

  1. Facultatif : Configurez le lecteur de code.

    Si vous connaissez les formats de code-barres que vous souhaitez lire, vous pouvez améliorer la vitesse du détecteur de code-barres en le configurant pour qu'il ne détecte que ces formats. Par exemple, pour ne détecter que les codes Aztec et les QR codes, créez un objet GmsBarcodeScannerOptions comme dans l'exemple suivant :

    Kotlin

    val options = GmsBarcodeScannerOptions.Builder()
   .setBarcodeFormats(
       Barcode.FORMAT_QR_CODE,
       Barcode.FORMAT_AZTEC)
   .build()

    Java

    GmsBarcodeScannerOptions options = new GmsBarcodeScannerOptions.Builder()
   .setBarcodeFormats(
       Barcode.FORMAT_QR_CODE,
       Barcode.FORMAT_AZTEC)
   .build();

    Par défaut, le zoom automatique est désactivé. Pour l'activer à partir de la version 16.1.0, appelez enableAutoZoom() comme indiqué dans l'exemple de code suivant.

    Kotlin

    val options = GmsBarcodeScannerOptions.Builder()
   .setBarcodeFormats(...)
   .enableAutoZoom() // available on 16.1.0 and higher
   .build()

    Java

    GmsBarcodeScannerOptions options = new GmsBarcodeScannerOptions.Builder()
   .setBarcodeFormats(...)
   .enableAutoZoom() // available on 16.1.0 and higher
   .build();

  2. Obtenez une instance de GmsBarcodeScanner, comme indiqué dans l'exemple de code :

    Kotlin

    val scanner = GmsBarcodeScanning.getClient(this)
// Or with a configured options
// val scanner = GmsBarcodeScanning.getClient(this, options)

    Java

    GmsBarcodeScanner scanner = GmsBarcodeScanning.getClient(this);
// Or with a configured options
// GmsBarcodeScanner scanner = GmsBarcodeScanning.getClient(context, options);

  3. Demandez une analyse de code en appelant startScan().

    Kotlin

    scanner.startScan()
   .addOnSuccessListener { barcode ->
       // Task completed successfully
   }
   .addOnCanceledListener {
       // Task canceled
   }
   .addOnFailureListener { e ->
       // Task failed with an exception
   }

    Java

    scanner
   .startScan()
   .addOnSuccessListener(
       barcode -> {
         // Task completed successfully
       })
   .addOnCanceledListener(
       () -> {
         // Task canceled
       })
   .addOnFailureListener(
       e -> {
         // Task failed with an exception
       });

  4. Gérez le Barcode obtenu.

    Kotlin

    val rawValue: String? = barcode.rawValue

    Java

    String rawValue = barcode.getRawValue();