blinkid-core/com.microblink.blinkid.core.settings

Package-level declarations

Types

data class CroppedImageSettings(var dotsPerInch: UShort, @FloatRange(from = 0.0, to = 1.0) var extensionFactor: Float = 0.0f, var returnDocumentImage: Boolean = false, var returnFaceImage: Boolean = false, var returnSignatureImage: Boolean = false) : Parcelable

Represents the image cropping settings.

DetailedFieldType

data class DetailedFieldType(val fieldType: FieldType, val alphabetType: AlphabetType) : Parcelable

Represents the detailed field type.

DocumentAnonymizationSettings

data class DocumentAnonymizationSettings(var documentFilter: DocumentFilter = DocumentFilter(), var fields: List<FieldType>, var documentNumberAnonymizationSettings: DocumentNumberAnonymizationSettings? = null) : Parcelable

Represents the document anonymization settings.

DocumentFilter

data class DocumentFilter(var country: Country? = null, var region: Region? = null, var type: Type? = null) : Parcelable

Represents the document filter.

DocumentNumberAnonymizationSettings

data class DocumentNumberAnonymizationSettings(val prefixDigitsVisible: UByte, val suffixDigitsVisible: UByte) : Parcelable

Represents the document number annotation settings.

DocumentRules

data class DocumentRules(var documentFilter: DocumentFilter = DocumentFilter(), var fields: List<DetailedFieldType>) : Parcelable

Represents the document rules.

RecognitionModeFilter

@ApiStatus.Experimental

data class RecognitionModeFilter(var enableMrzId: Boolean = true, var enableMrzVisa: Boolean = true, var enableMrzPassport: Boolean = true, var enablePhotoId: Boolean = true, var enableBarcodeId: Boolean = true, var enableFullDocumentRecognition: Boolean = true) : Parcelable

Represents the configuration used to enable/disable recognition of specific document groups.

ScanningSettings

data class ScanningSettings(val blurDetectionLevel: DetectionLevel = DetectionLevel.Mid, val skipImagesWithBlur: Boolean = true, val glareDetectionLevel: DetectionLevel = DetectionLevel.Mid, val skipImagesWithGlare: Boolean = true, val tiltDetectionLevel: DetectionLevel = DetectionLevel.Mid, val skipImagesWithInadequateLightingConditions: Boolean = true, val skipImagesOccludedByHand: Boolean = true, val combineResultsFromMultipleInputImages: Boolean = true, val enableBarcodeScanOnly: Boolean = false, val customDocumentRules: List<DocumentRules> = emptyList(), val anonymizationMode: AnonymizationMode = AnonymizationMode.FullResult, val customDocumentAnonymizationSettings: List<DocumentAnonymizationSettings> = emptyList(), val returnInputImages: Boolean = false, val scanCroppedDocumentImage: Boolean = false, val recognitionModeFilter: RecognitionModeFilter = RecognitionModeFilter(), val enableCharacterValidation: Boolean = true, @FloatRange(from = 0.0, to = 1.0) val inputImageMargin: Float = 0.02f, val scanUnsupportedBack: Boolean = false, val allowUncertainFrontSideScan: Boolean = false, val maxAllowedMismatchesPerField: UInt, val scanPassportDataPageOnly: Boolean = true, val croppedImageSettings: CroppedImageSettings = CroppedImageSettings()) : Parcelable

Represents the configurable settings for scanning a document.