Escáner de códigos de Google (solo para Android)

La API de Google Code Scanner proporciona una solución completa para escanear código sin que tu app deba solicitar permiso de la cámara y, al mismo tiempo, preserva la privacidad del usuario. Para ello, se delega la tarea de escanear el código a los Servicios de Google Play y se muestran solo los resultados del escaneo a tu app (video 1). Todo el procesamiento de imágenes se realiza en el dispositivo, y Google no almacena los resultados ni los datos de imagen. La API admite los mismos formatos de código que la API de escaneo de códigos de barras de ML Kit y muestra el mismo objeto Barcode.

Esta API es ideal para apps que requieren un escaneo de código sin problemas sin necesidad de una IU o una experiencia de la cámara personalizadas. La implementación reside por completo en los Servicios de Google Play, lo que garantiza un impacto mínimo en el tamaño de tu app.

A partir de la versión 16.1.0, puedes habilitar el zoom automático para permitir que el escáner de códigos de Google lea automáticamente los códigos de barras que están lejos de la cámara. Cuando los usuarios apuntan sus dispositivos a un código de barras, el escáner lo detectará de forma inteligente y lo acercará. Esto elimina la necesidad de ajustes manuales del zoom, lo que hace que el escaneo de códigos de barras sea más rápido, más preciso y más accesible (consulta el video 2).

Video 1: Integración del escáner de códigos de Google Video 2. Efecto de zoom automático

Para casos de uso más complejos que requieren una IU personalizada, te recomendamos que uses directamente la API de escaneo de códigos de barras de ML Kit.

Si tienes preguntas, quieres enviar un error o necesitas asistencia, consulta la página de la comunidad de ML Kit.

Antes de comenzar

Para preparar tu app, completa los pasos que se indican en las siguientes secciones.

Cómo configurar tu app

  1. En el archivo settings.gradle de nivel superior, incluye el repositorio de Maven de Google y el repositorio central de Maven debajo del bloque dependencyResolutionManagement:

    dependencyResolutionManagement {
      repositories {
        google()
        mavenCentral()
      }
    }
    
  2. Agrega la dependencia de los Servicios de Google Play para el SDK de play-services-code-scanner al archivo de compilación de Gradle de tu módulo, que suele ser app/build.gradle:

    dependencies {
      implementation 'com.google.android.gms:play-services-code-scanner:16.1.0'
    }
    
  3. Puedes configurar tu app para que los Servicios de Google Play descarguen automáticamente el módulo del escáner en el dispositivo mientras se instala la app desde Play Store.

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

    También puedes verificar de forma explícita la disponibilidad del módulo del escáner y solicitar su descarga a través de la API de ModuleInstallClient de los Servicios de Google Play.

    Si no habilitas las descargas de módulos durante el tiempo de instalación ni solicitas descargas explícitas, y el módulo del escáner aún no está instalado para otro caso de uso, los Servicios de Google Play descargarán el módulo del escáner la primera vez que se use.

Escanea un código

Sigue estos pasos para escanear un código de barras.

  1. Opcional: Configura el escáner de códigos.

    Si sabes qué formatos de códigos de barras leerás, puedes configurar el detector de códigos de barras para que solo detecte esos formatos a fin de aumentar su velocidad. Por ejemplo, para detectar solo códigos QR y Aztec, crea un objeto GmsBarcodeScannerOptions como el del siguiente ejemplo:

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

    De forma predeterminada, el zoom automático está desactivado. Para habilitar la función de zoom automático a partir de la versión 16.1.0, llama a enableAutoZoom() como se muestra en el siguiente ejemplo de código.

    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. Obtén una instancia de GmsBarcodeScanner, como se muestra en el ejemplo de código:

    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. Llama a startScan() para solicitar el escaneo de un código.

    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. Controla el Barcode resultante.

    Kotlin

    val rawValue: String? = barcode.rawValue

    Java

    String rawValue = barcode.getRawValue();