Android

BCC Finger es una biblioteca de Android destinada a integrarse en una aplicación Android. Esencialmente, abrirá una cámara y capturará huellas dactilares con fines biométricos.

Este manual está actualizado para BCC Finger Photo Android versión 4.3.0.

Requisitos

BCC Finger Photo es una biblioteca de Android y debe importarse en el proyecto Target.

• Versión mínima de Android: Android 6.0 (SDK 23), "Marshmallow".

• Versión mínima de Kotlin: 1.6.0.

• El dispositivo móvil debe tener una cámara.

• La aplicación nativa debe construirse con tecnología Android.

• Entorno de desarrollo: se requiere un IDE de Android, como Android Studio (recomendado)

• Dependencias externas adicionales:

  • Lottie, versión 3.0.0

Instalación

Agregar la Biblioteca en el Proyecto de la App

La biblioteca BCC Finger Photo requiere JNA para Android. Ambas son proporcionadas por Griaule como .aar archivos.

Para agregar las bibliotecas, vaya al directorio de su proyecto, abra la app carpeta y cree los siguientes directorios libs/bccfinger. Luego, agregue la jna.aar y el bccfingerphotolib-release.aar dependencias. La estructura de carpetas debe ser similar a esta:

El siguiente paso es hacer que estos archivos sean visibles para las dependencias de gradle. Para ello, agregue la siguiente línea en el archivo build.gradle (:app) en el objeto dependencies:

dependencies {
	[...]
	implementation fileTree(dir: 'libs/bccfinger', include: ['*.aar'])
}

Dentro del build.gradle (:app) archivo, agregue también las opciones de compilación y establezca Source Compatibility y Target Compatibility para usar 1.8 (Java 8):

compileOptions {
	sourceCompatibility = 1.8
	targetCompatibility = 1.8
}

Configuración de todas las dependencias

Realice los siguientes cambios en el archivo android/app/build.gradle:

dependencies {
	// SUS DEPENDENCIAS //
	// ...

	// BCC FINGER //
	implementation fileTree(dir: 'libs/bccfinger', include:['*.aar'])

	// ANDROIDX //
	implementation 'androidx.appcompat:appcompat:1.1.0'
	implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
	implementation 'com.google.android.material:material:1.1.0'

	// LOTTIE //
	implementation 'com.airbnb.android:lottie:3.0.0'

	// CAMERA X //
	def camerax_version = "1.2.0-rc01"
	// Biblioteca core de CameraX usando la implementación camera2
	implementation "androidx.camera:camera-camera2:$camerax_version"
	// Biblioteca de ciclo de vida de CameraX
	implementation "androidx.camera:camera-lifecycle:$camerax_version"
	// Clase View de CameraX
	implementation "androidx.camera:camera-view:$camerax_version"
}

Uso

Parámetros y constructor

A continuación se muestra un ejemplo simple de uso de la biblioteca:

// Para inicializar una nueva captura
BCCFingerBuilder(this, this).initializeCapture()

La BCCFingerBuilder clase recibe los siguientes parámetros:

• context: Context - El contexto de la aplicación.

• delegate: BCCFingerDelegate - Interfaz responsable de notificar eventos de captura (por ejemplo, falla o éxito).

La BCCFingerBuilder clase es responsable de manejar la configuración de uso para BCCFinger. Los siguientes parámetros se aceptan para configurar la captura biométrica y el comportamiento del software:

• setSkipCaptureOption(enable: Boolean) - Habilita la opción de omitir la captura actual.

• setDebugMode(enable: Boolean) - Habilita el modo de depuración.

• buildCaptureType(type: BCCFingerPhotoCaptureType) - Define el tipo de captura de huellas dactilares. Las opciones son:

  enum class BCCFingerPhotoCaptureType {
  	BOTH_HANDS,
  	ONLY_LEFT_HAND,
  	ONLY_RIGHT_HAND,
  	THUMBS,
  	LEFT_THUMB,
  	RIGHT_THUMB,
  	FULL_HANDS,
  	FULL_LEFT_HAND,
  	FULL_RIGHT_HAND;
  }

  • BOTH_HANDS - Ambas manos sin pulgares.

  • ONLY_LEFT_HAND - Solo mano izquierda, sin pulgares.

  • ONLY_RIGHT_HAND - Solo mano derecha, sin pulgares.

  • THUMBS - Ambos pulgares.

  • LEFT_THUMB - Solo pulgar izquierdo.

  • RIGHT_THUMB - Solo pulgar derecho.

  • FULL_HANDS - Ambas manos con pulgares.

  • FULL_LEFT_HAND - Solo mano izquierda, con pulgar.

  • FULL_RIGHT_HAND - Solo mano derecha, con pulgar.

• buildBeginDelaySeconds(delay: Float) - Define el retraso para iniciar el ajuste automático del umbral.

• buildThreshold - Define los parámetros del umbral.

Como referencia, la lista completa de parámetros y valores predeterminados es:

skipsHandOption: Boolean = false
debugMode: Boolean = false
beginDelaySeconds: Float = 2f
maxQuality: Int = 50
minQuality: Int = 0
totalTime: Float = 20f
stepCount: Int = 20
captureType: BCCFingerPhotoCaptureType = BCCFingerPhotoCaptureType.FULL_HANDS

Valores de retorno

Los resultados de la última captura de huellas dactilares se pueden obtener a través del fingerCaptureDidFinish método de la interfaz BCCFingerDelegate :

fun fingerCaptureDidFinish(
	returnData: BCCFingerReturnData,
	analytics: BCCFingerReturnAnalytics
)

La returnData objeto contiene los siguientes métodos para la recuperación de datos:

• getCapturedFingersIndexes() - Devuelve una lista con el índice de todas las huellas dactilares capturadas:

  enum class BCCFingerIndex(val index: Int) {
  	leftLittle(0),
  	leftRing(1),
  	leftMiddle(2),
  	leftIndex(3),
  	leftThumbs(4),
  	rightThumbs(5),
  	rightIndex(6),
  	rightMiddle(7),
  	rightRing(8),
  	rightLittle(9);
  }

• getCapturedFingers() - Devuelve un mapa que relaciona los índices de los dedos con las biometrías capturadas.

• getCapturedFingersData() - Devuelve la lista de todas las huellas dactilares capturadas:

  data class BCCFingerData(
  	var fingerprintImage: Bitmap,
  	var wsqAsBase64: String?
  )

  • fingerprintImage - Imagen PNG de la huella dactilar en escala de grises.

  • wsqAsBase64 - Imagen WSQ de la huella dactilar codificada en base64.

• getSkippedFingers() - Devuelve la lista de índices de todas las capturas de dedos omitidas.

La BCCFingerReturnData clase también contiene atributos que almacenan la información de la captura agrupada por mano:

class BCCFingerReturnData {
	val leftHand: BCCHandData?
	val rightHand: BCCHandData?
}

Estos atributos pueden ser nulos cuando no se solicitan capturas para cualquiera de las manos.

La HandData clase contiene la siguiente información:

var capturedFingers = mutableMapOf<BCCFingerIndex, BCCFingerData>()
private set

var skippedFingers = mutableListOf<BCCFingerIndex>()
private set

var handsPhoto: Bitmap? = null
private set

var thumbsPhoto: Bitmap? = null
private set

• capturedFingers - Mapa que relaciona el índice del dedo con la imagen de la huella dactilar.

• skippedFingers - Lista de índices de todas las capturas de dedos omitidas.

• handsPhoto - Foto original de la mano de la cual se extrajeron las huellas dactilares.

• thumbPhoto - Foto original del pulgar.

Si el usuario aborta la captura, cerrando antes de capturar las biometrías, se llamará al método fingerCaptureDidAbort Se puede implementar este método para tratar este escenario.

Recuperación de imágenes originales

Es posible obtener las imágenes originales a través de la BCCFingerReturnData clase, como se muestra a continuación:

val leftSlapPhoto = returnData.leftHand?.handsPhoto
val rightSlapPhoto = returnData.rightHand?.handsPhoto
val leftThumbPhoto = returnData.leftHand?.thumbsPhoto
val rightThumbPhoto = returnData.rightHand?.handsPhoto

Proyecto de ejemplo

Este es un proyecto de muestra funcional para una captura de huellas dactilares usando BCC Mobile Finger Android:

package com.example.bccfignerexample

import android.os.Bundle
import androidx.appcompat.app.AppCompatActivity
import com.example.bccfignerexample.databinding.ActivityMainBinding
import com.griaule.bccfingerphotolib.analytics.BCCFingerReturnAnalytics
import com.griaule.bccfingerphotolib.fingerApi.declaration.BCCFingerBuilder
import com.griaule.bccfingerphotolib.fingerApi.declaration.BCCFingerDelegate
import com.griaule.bccfingerphotolib.fingerApi.returnData.BCCFingerReturnData


class MainActivity : AppCompatActivity(), BCCFingerDelegate {

	private lateinit var binding: ActivityMainBinding

	override fun onCreate(savedInstanceState: Bundle?) {
		super.onCreate(savedInstanceState)

		binding = ActivityMainBinding.inflate(layoutInflater)
		setContentView(binding.root)

		setupListeners()
	}

	private fun setupListeners() {
		binding.startCaptureButton.setOnClickListener { startCapture() }
	}

	private fun startCapture() {
		BCCFingerBuilder(this, this).initializeCapture()
	}

	override fun fingerCaptureDidAbort(
		analytics: BCCFingerReturnAnalytics
	) {
		// ...
	}

	override fun fingerCaptureDidFinish(
		returnData: BCCFingerReturnData,
		analytics: BCCFingerReturnAnalytics
	) {
		// ...
	}

}