commonMain.net.iriscan.sdk.face.FaceEncoder.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.face

import net.iriscan.sdk.core.image.Image
import net.iriscan.sdk.core.image.NativeImage
import net.iriscan.sdk.core.io.DataBytes
import net.iriscan.sdk.face.record.FaceImageRecord
import net.iriscan.sdk.face.record.FaceTemplateRecord

/**
 * @author Slava Gornostal
 *
 *  Interface for generating template from face image
 */
interface FaceEncoder {
    /**
     * Encodes provided extracted record to biometric template record
     * */
    fun encode(record: FaceImageRecord): FaceTemplateRecord

    /**
     * Extracts and encodes provided record to biometric template record
     * */
    fun extractAndEncode(record: FaceImageRecord): FaceTemplateRecord

    /**
     * Encodes provided image to face template
     * */
    fun encode(sdkImage: Image): DataBytes

    /**
     * Encodes provided image to face template
     * */
    fun encode(nativeImage: NativeImage): DataBytes

    /**
     * Extracts and encodes provided record to face template record
     * */
    fun extractAndEncode(sdkImage: Image): DataBytes?

    /**
     * Extracts and encodes provided record to face template record
     * */
    fun extractAndEncode(nativeImage: NativeImage): DataBytes?
}