commonMain.net.iriscan.sdk.iris.IrisEncoder.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of biometric-sdk Show documentation

Biometric SDK Kotlin Multiplatform library (android + ios)

There is a newer version: 0.6.0

package net.iriscan.sdk.iris

import net.iriscan.sdk.core.image.Image
import net.iriscan.sdk.core.io.DataBytes
import net.iriscan.sdk.core.record.BiometricRecord

/**
 * @author Slava Gornostal
 *
 * Interface for generating template from image with biometric
 */
interface IrisEncoder {
    /**
     * Encodes provided extracted record to biometric template record
     * */
    fun encode(sample: BiometricRecord): BiometricRecord

    /**
     * Extracts and encodes provided image to iris template
     * */
    fun extractAndEncode(sample: BiometricRecord): DataBytes

    /**
     * Encodes provided extracted image to iris template
     * */
    fun encode(sample: Image): DataBytes

    /**
     * Extracts and encodes provided image to iris template
     * */
    fun extractAndEncode(sample: Image): DataBytes?
}