ScanningSettings

data class ScanningSettings(val skipImagesWithBlur: Boolean = true, val tiltDetectionLevel: DetectionLevel = DetectionLevel.Mid, val inputImageMargin: Float = 0.02f, val extractionSettings: ExtractionSettings = ExtractionSettings(), val croppedImageSettings: CroppedImageSettings = CroppedImageSettings(), val livenessSettings: LivenessSettings = LivenessSettings(), val anonymizationSettings: AnonymizationSettings = AnonymizationSettings()) : Parcelable

Represents the configurable settings for scanning a card.

This class defines various parameters and policies related to the scanning process, including image quality handling, data extraction, anonymization, and liveness detection, along with options for frame processing and image extraction.

Constructors

Link copied to clipboard
constructor(skipImagesWithBlur: Boolean = true, tiltDetectionLevel: DetectionLevel = DetectionLevel.Mid, inputImageMargin: Float = 0.02f, extractionSettings: ExtractionSettings = ExtractionSettings(), croppedImageSettings: CroppedImageSettings = CroppedImageSettings(), livenessSettings: LivenessSettings = LivenessSettings(), anonymizationSettings: AnonymizationSettings = AnonymizationSettings())

Properties

Link copied to clipboard

Represents the configurable settings for data anonymization. This defines various parameters and policies related to the anonymization of sensitive data extracted from the payment cards. Defaults to no anonymization.

Link copied to clipboard

Configures the image cropping settings during scanning process. Allows customization of cropped image handling, such as dotsPerInch, extensionFactor, and whether images should be returned for the entire card.

Link copied to clipboard

Controls which fields and images should be extracted from the card. Disabling extraction of unused fields can improve recognition performance or reduce memory usage.

Link copied to clipboard
val inputImageMargin: Float = 0.02f

Defines the minimum required margin (in percentage) between the edge of the input image and the card. Default value is 0.02 (also recommended value). The setting is applicable only when using images from Video source. Defaults to 0.02.

Link copied to clipboard

Represents the configurable settings for liveness detection. This defines various parameters and policies related to the liveness detection process, including checks for hand presence and screen analysis.

Link copied to clipboard

Indicates whether to reject frames if blur is detected on the card image. When true (default), frames with detected blur are skipped to ensure only high-quality images are processed. When false, blurred frames are still processed, and the blur status is reported in the ProcessResult. Defaults to true.

Link copied to clipboard

The level of allowed detected tilt of the card in the image. Defines the severity of allowed detected tilt of the card in the image, as defined in DetectionLevel. Values range from Off (detection turned off) to higher levels of allowed tilt. Defaults to DetectionLevel.Mid.

Functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)