Namespace ScanbotSDK.MAUI.Common
Classes
- ActionBarConfiguration
Configuration of the buttons available in the action bar.
- AspectRatio
Aspect ratio is the ratio of the width to the height of an image or screen.
- BackgroundStyle
Configuration of the background appearance for buttons and hints.
- BadgeStyle
Configuration of the badge.
- BadgedButton
Configuration of the button with a badge.
- BarButtonConfiguration
Configuration of the button located on a bar.
- BaseViewFinderConfiguration
Base configuration of the scanning interface’s viewfinder, serving as guidance to the user.
- BasicImageLoadOptions
Basic options for loading image.
- BufferImageLoadOptions
Options for loading image from buffer.
- BufferLoadModeConverter
Image Ref Buffer Load Mode.
- ButtonConfiguration
Configuration of the button.
- CameraConfiguration
Configuration of the camera settings to be used while scanning.
- CameraModuleConverter
Determines which camera module to use on start-up.
- CameraPermissionScreen
Configuration of the camera permission request view.
- CameraPreviewModeConverter
Configuration of the camera preview mode.
- CommonFieldTypeConverter
Common field types.
- EdgeInsets
Represents the insets of a rectangle.
- EncodeImageOptions
Options for encoding image.
- EncodingFormatConverter
Image Encoding Format.
- EncryptionModeConverter
Encryption/Decryption mode to be used when an image is loaded/saved.
- Field
Generic document field.
- FieldDataFormatConverter
Type of parsing applied to field.
- FieldParsedData
Parsed data.
- FieldType
Generic Document Type.
- FieldValidationStatusConverter
Field validation status.
Optical character recognition (OCR) invariably introduces errors in the recognized text. There are numerous ways to verify that what has been recognized is, in fact, what was written in the document.
The best way to validate the value of a field is for it to have a known format or validation logic. For example, an IBAN number has a known format and two check digits that make it very unlikely that a value with OCR errors will pass validation. Fields with known validation rules will have a validation status of either VALID or INVALID.
Fields whose value can be inferred from other fields, or from domain knowledge (for example, the field may have the same value in every instance of this type of document), will have the status INFERRED. Inferring the value of a field is a strong validation method, provided that there are no unexpected changes to the document format.
Fields that do not have validation rules and cannot be inferred can still be validated by checking whether the same value is recognized from multiple attempts, e.g. across multiple frames of a camera stream. If the same value is recognized in multiple frames, the value is considered CONFIRMED, otherwise it will have the status NONE. This is the least strict validation method, as it does not protect from systemic OCR errors, but in practice it still provides good results for most fields.
- FinderCorneredStyle
A variant of the viewfinder displaying only the four corners of the scanning area.
- FinderStrokedStyle
A variant of the viewfinder displaying a full outline of the scanning area.
- FinderStyle
The visual appearance of the viewfinder.
- ForegroundStyle
Configuration of the appearance for foreground elements (e.g. text and/or icons, etc).
- GenericDocument
Generic document.
- GenericDocumentType
Generic Document Type.
- IconButton
Configuration of the icon appearance on a button.
- IconStyle
Configuration of the icon appearance.
- IconUserGuidanceConfiguration
Configuration of the hint (containing an icon) guiding users through the scanning process.
- ImageInfo
Image Info.
- ImageProfile
ImageRef profile part specific to image information.
- ImageRefPoolSnapshot
Snapshot of all alive ImageRefs.
- ImageRefPoolSnapshotsDiff
difference between two snapshots.
- ImageRefProfile
ImageRef profile which provides detailed information about stored object.
- ImageRotationConverter
Image rotation.
- ImageSource
Description of source from which the ImageRef was created.
- ImageSourceTypeConverter
The type of source which originated the underlying image.
- LineSegmentFloat
Represents a line segment in 2D space.
- LineSegmentInt
Represents a line segment in 2D space.
- NavigationBarModeConverter
The visual mode used for the navigation bar icons. Android only.
- OcrResult
Result of OCR text recognition.
- OrientationLockModeConverter
Configure the orientation of the interface.
- Palette
Value palette describing the colors of the scanner screens.
- PathImageLoadOptions
Options for loading image from path.
- PathLoadModeConverter
Image Ref Path Load Mode.
- PermanentViewFinderConfiguration
Configuration of the scanning interface’s viewfinder, which is always visible to guide the user.
- PolygonStyle
Configuration of the polygon appearance.
- PopupMenuItem
Configuration for the popup menu items.
- RawImageLoadOptions
Options for loading images that come from sensor.
- RefCountedObjectProfile
Profile info of a reference-counted stored object.
- RoundButton
Configuration of the round button.
- SaveImageOptions
Options for saving image to a path.
- ScanbotAlertDialog
Configuration of the standard alert dialog.
- Sound
Configuration for the sound.
- SoundTypeConverter
Determines the successful detection sound.
- StatusBarModeConverter
The visual mode used for the status bar icons.
- StyledText
Configuration of the text field appearance.
- Timeouts
Configuration of timeouts.
- TopBarConfiguration
Configuration of the top bar's appearance.
- TopBarModeConverter
The visual mode used for the top bar.
- UserGuidanceConfiguration
Configuration of the hint guiding users through the scanning process.
- Vibration
Configure the vibration.
- ViewFinderConfiguration
Configuration of the scanning interface’s viewfinder, allowing it to be shown or hidden as guidance to the user.