BcmDeviceCalibration

A calibration result object is provided by BcmCalibrationActivity or BcmCalibrationFragment to IBcmCalibrationDelegate.

Interface

data class BcmDeviceCalibration(
    /**
     * Unique device name.
     * "MODEL(MANUFACTURER)"
     */
    val deviceName: String,

    /**
     * Danger, W.R.! Attempting to use a too large frame resolution could exceed the camera
     * bus' bandwidth limitation, result in gorgeous previews but the storage of garbage capture data.
     */
    val cameraFrameFrameResolution: BcmCameraConfig.CameraFrameResolution,

    /**
     * This factor is used for the fixed focus distance.
     * By default (0.0), the nearest point will used for the fixed focus distance.
     * This can be changed to a value in the range [0.0, 1.0].
     */
    val focusLensPositionFactor: Float,

    /**
     * The camera dpi value is mandatory for the correct image scaling.
     * The dpi value is different for each device and depends on the device camera.
     * There are pre-calculated dpi values for the most used devices in the SDK.
     * The device can be manually calibrated with the calibration API (BcmSdkCalibrationActivity, BcmSdkCalibrationFragment)
     */
    val dpi: Float,

    /**
     * The finger score weights are used for the scan auto termination algorithm.
     * The algorithm is based on a threshold. This threshold have to be reached to terminate a scan.
     * Due to the fact that the finger score is different for each finger, we've added a score weight.
     * This score weight is a factor for relevance of the finger for the scan auto termination.
     */
    val autoScanTerminationFingerWeights: FingerScoreWeights = FingerScoreWeights(),

    /**
     * The finger score threshold is used for the auto termination algorithm.
     * This threshold have to be reached to terminate a scan.
     * This property is used if the "scanTerminationOption" is set to "SCORE_WITH_TIMEOUT"
     */
    val autoScanTerminationThreshold: Float = 0.15f)

Usage

BcmDeviceCalibration is used for the IBcmCalibrationDelegate.calibrationResult() callback, when the calibration is finished.