Schema for SDK JSON configurations
No Additional PropertiesAn optional description for the entire ScanView configuration.
Schema for SDK Camera Configuration
No Additional PropertiesThe preferred resolution for video capture (720, 720p, 1080, 1080p). This resolution is used to process images for scanning.
The preferred resolution for taking images (720, 720p, 1080, 1080p).
The preferred camera of the device (FRONT, BACK, EXTERNAL, EXTERNAL_FRONT).
This flag enables or disables the zoom gesture if supported.
The focal length.
The zoom ratio.
The maximum zoom ratio.
The maximum focal length.
Optional cameras to fall back if the defaultCamera is not found.
No Additional ItemsSchema for SDK Flash Configuration
No Additional PropertiesThe flash mode.
The alignment of the flash button.
An optional offset (in dp) for the flash button.
No Additional PropertiesThe asset name of the icon to be displayed when the flash is on.
The asset name of the icon to be displayed when the flash is off.
The asset name of the icon to be displayed when the flash is set to auto.
Schema for SDK ViewPlugin Configuration
No Additional PropertiesGeneral configuration for scan plugins
No Additional PropertiesSets a name for the scan plugin.
Sets whether or not to continue scanning once a result is found.
Sets an initial time period where scanned frames are not processed as results.
Value must be greater or equal to 0 and lesser or equal to 1000000
Allows to fine-tune a list of options for plugins.
No Additional ItemsDescribes a start variable for fine-tuning plugins.
No Additional PropertiesThe key of the variable.
The value of the variable.
Configuration for scanning barcodes
No Additional PropertiesSetting this to 'true' will enable reading multiple barcodes per frame.
If this option is set, barcodes parsed according to the AAMVA standard. This only works for PDF417 codes on driving licenses.
If this option is set, allows consecutive barcode results of the same barcode when scanning continuously.
Sets whether or not to disable advanced barcode scanning even if the license supports it.
Set this to filter which barcode formats should be scanned. Setting 'ALL' will enable scanning all supported formats.
Must contain a minimum of 1 items
Configuration for scanning meters
No Additional PropertiesDetermines which types of meters to scan.
Sets a minimum confidence which has to be reached in order to trigger a scan result.
Defines the maximum number of read decimal digits for values >=0. Negative values mean all decimal digits are read. Currently implemented only for the "autoanalogdigital_meter" scan mode.
Sets a regular expression which the scanned text needs to match in order to trigger a scan result.
Configuration for scanning odometers
No Additional PropertiesSets a minimum confidence which has to be reached in order to trigger a scan result.The value has to be between 0 and 100. Defaults to 60.
Value must be greater or equal to 0 and lesser or equal to 100
Sets a regular expression which the scanned text needs to match in order to trigger a scan result.
Configuration for scanning all kinds of identification documents
No Additional PropertiesSets a specific character set.
Specifies the document types to be scanned and optionally further specifies which types of layout are scanned per type.
No Additional PropertiesSets a set of layouts to be included by the scanner. If none are set, every supported layout is included.
No Additional Items([A-Z]{2}(-[A-Z]{2,3})?_[A-Z]{3}_[A-Z]+_[A-Z0-9]+(-[A-Z0-9]+)*_(F|B)(_v[0-9])?) Sets a set of layouts to be included by the scanner. If none are set, every supported layout is included.
Same definition as mrzSets a set of layouts to be included by the scanner. If none are set, every supported layout is included.
Same definition as mrzSets a set of layouts to be included by the scanner. If none are set, every supported layout is included.
Same definition as mrzContains all the supported field scan options for MRZ.
No Additional PropertiesConfigures scanning options for ID fields in order to fine-tune the ID scanner.
No Additional PropertiesThe scanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior. Default behavior is one of the other three that yields the best recall results with all layouts enabled.
Set the minConfidence which has to be reached in order to trigger a scan result. The value has to be between 0 and 100. Defaults to 60.
Value must be greater or equal to 0 and lesser or equal to 100
Configures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressContains all the supported field scan options for driving licenses.
No Additional PropertiesConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressContains all the supported field scan options for ID front cards.
No Additional PropertiesConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressContains all the supported field scan options for insurance cards.
No Additional PropertiesConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressConfigures scanning options for ID fields in order to fine-tune the ID scanner.
Same definition as vizAddressSets whether the face detection approach is enabled.
Configuration for scanning machine-readable zones (MRZ) of passports and other IDs
No Additional PropertiesThe fieldmrzScanOptions configure which text fields shall be captured mandatory, optional or not at all.
No Additional PropertiesThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.
Same definition as surnameThe minFieldConfidences configure which fields must reach which confidence thresholds in order to be part of the scan result.
No Additional PropertiesThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Value must be greater or equal to 0 and lesser or equal to 100
The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.
Same definition as surnameThe strictMode determines whether or not the MRZ must follow the ICAO standard.
The cropAndTransformID determines whether or not the image shall be cropped and transformed.
Sets a minimum confidence which has to be reached in order to trigger a scan result.
Value must be greater or equal to 0 and lesser or equal to 100
Sets whether the face detection approach is enabled.
Configuration for scanning japanese landing permission tickets
Field option for JLP fields
The scanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior. Default behavior is one of the other three that yields the best recall results with all layouts enabled.
Set the minConfidence between 0 and 100. Otherwise, it's defaulted.
Configuration for scanning Vehicle Registration Certificates
No Additional PropertiesContains all the supported field scan options for vehicle registration certificates.
No Additional PropertiesThe DocumentNumber Field
No Additional PropertiesThe scanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior. Default behavior is one of the other three that yields the best recall results with all layouts enabled.
Set the minConfidence between 0 and 100. Otherwise, it's defaulted.
Value must be greater or equal to 0 and lesser or equal to 100
Configuration for scanning license plates
No Additional PropertiesSpecifies a country or location of which license plates shall be scanned.
Sets a minimum confidence which has to be reached in order to trigger a scan result.
Sets a regular expression per country. Expected format: "'countrycode':^regex$, 'othercountrycode':^otherregex$". The country code needs to be provided in the international vehicle registration code format that is visible on the license plate (for example 'A' for Austria). Note: not available for the scanModes unitedstates and africa.
Select if the visual inspection sticker should be scanned. If OPTIONAL, the visual inspection sticker will only be returned if found successfully. If MANDATORY the scan will only return if found successfully. Not available on africa and unitedstates.
Configuration for scanning TIN numbers
No Additional PropertiesSets the mode to scan universal TIN numbers ('UNIVERSAL') or TIN numbers of any length starting with DOT ('DOT').
Sets whether the text shall also be scanned upside-down.
Sets a minimum confidence which has to be reached in order to trigger a scan result.
Sets whether the production date validation is enabled. If it is set to false the scan result is also returned for invalid and missing dates.
Sets a regular expression which the TIN text needs to match in order to trigger a scan result.
Configuration for scanning Tire Size Specifications
No Additional PropertiesSets whether the text shall also be scanned upside-down.
Sets a minimum confidence which has to be reached in order to trigger a scan result.
Sets a regular expression which the tire size text needs to match in order to trigger a scan result.
Configuration for scanning commercial Tire IDs
No Additional PropertiesSets whether the text shall also be scanned upside-down.
Sets a minimum confidence which has to be reached in order to trigger a scan result.
Sets a regular expression which the commercial tire id text needs to match in order to trigger a scan result.
Configuration for scanning Tire Makes
No Additional PropertiesSets whether the text shall also be scanned upside-down.
Sets a minimum confidence which has to be reached in order to trigger a scan result.
Sets a regular expression which the tire make text needs to match in order to trigger a scan result. E.g. "(Continental|Dunlop)" will only trigger on Continental or Dunlop tires.
Configuration for scanning vehicle identification numbers (VIN)
No Additional PropertiesSets a regular expression which the scanned text needs to match in order to trigger a scan result.
Restricts the scanner to a set of characters to be detected.
Configuration for scanning shipping container numbers
No Additional PropertiesDetermines if container numbers shall be scanned horizontally or vertically.
Sets a minimum confidence which has to be reached in order to trigger a scan result.
Sets a regular expression which the scanned text needs to match in order to trigger a scan result.
Configuration for general OCR scanning use-cases
No Additional PropertiesSets whether to scan single-line texts, multi-line texts in a grid-formation or finds text automatically.
Sets one or more custom Anyline models. The files have to be located in the project and point to a path relative from the project root. If no customCmdFile is set, only a maximum of one model is valid. If a customCmdFile is set, it depends whether or not the customCmdFile requires multiple models or not. Please check the official documentation for more details.
No Additional ItemsSets a custom Anyline script. The file has to be located in the project and point to a path relative from the project root. Please check the official documentation for more details.
Sets a sharpnes factor (0-100) to rule out blurry images.
Sets the number of characters in each text line for 'grid' mode.
Sets the number of text lines for 'grid' mode.
Defines the average horizontal distance between two characters in 'grid' mode, measured in percentage of the characters width.
Defines the average vertical distance between two characters in 'grid' mode, measured in percentage of the characters height.
Sets a minimum confidence which has to be reached in order to trigger a scan result.
Sets a minimum character height (in pixels) to be considered in the scanning process.
Sets a maximum character height (in pixels) to be considered in the scanning process.
Sets a regular expression which the scanned text needs to match in order to trigger a scan result.
Restricts the scanner to a set of characters to be detected.
Schema for SDK Cutout Configuration
No Additional PropertiesThe alignment of the cutout area.
The preferred width in pixels, relating to the camera resolution. If not specified or 0, the maximum possible width will be chosen.
The maximum width in percent (0-100), relating to the size of the view.
The maximum height in percent (0-100), relating to the size of the view.
A size constraining the ratio of width / height. If set to 0, the ratio will be equal to the full frame. For the optimal ratio for each technical capability have a look at the Technical Capabilities section at documentation.anyline.com.
No Additional PropertiesThe stroke width of the cutout. If set to 0, the line will be invisible.
The hex string (RRGGBB) of the stroke color. (e.g. 00CCFF).
The hex string (RRGGBB) of the stroke color for visual feedback. (e.g. 00CCFF).
Radius of the corners of the cutout.
Background color as a 6-digit (RRGGBB) or 8-digit (AARRGGBB) hex string.
Optional transparency factor for the outer color (0.0 - 1.0).
Value must be greater or equal to 0 and lesser or equal to 1
Position offset of the cutout, used in conjunction with alignment.
Same definition as offsetAnimation type for the cutout when initially displayed. Values: none, fade, zoom
Amount of padding to be applied to the cutout (NOTE: use positive amounts only). A crop padding truncates the visual area represented by the cutout used in optimizing scan performance for some plugins. Define as an x-y point structure.
Same definition as offsetUsed in conjunction with cropPadding. This offset further adjusts the crop position after the padding is applied. Define as an x-y point structure.
Same definition as offsetSchema for SDK ScanFeedback Configuration
No Additional PropertiesThe style of the feedback.
The animation style of the feedback.
The timeout to redraw the visual feedback in milliseconds.
The corner radius of the visual feedback.
The duration of the animation in milliseconds.
The stroke width.
The stroke color.
The fill color.
If true, make a beep sound when a result is found.
If true, flash the view when a result is found.
If true, vibrate the device when a result is found.
General configuration for UI Feedback elements
Elements inside UIFeedbackConfig.
No Additional ItemsConfiguration for uiFeedback element
Sets the id of the element.
Sets the view type of the element.
Configuration for UI Feedback content
Sets the content of the element.
Sets the duration of the element.
Value must be greater or equal to 0 and lesser or equal to 1000000
Sets the priority of the element.
Value must be greater or equal to 0 and lesser or equal to 100
Sets whether the view is clickable.
Sets a tag for the element.
Configuration attributes for UI Feedback view elements
Sets the text alignment.
Sets the text color.
Sets the background color.
Sets the image scale type.
Trigger configuration for UI Feedback
Allows to watch scanInfo events.
No Additional ItemsConfiguration for triggering UI Feedback on ScanInfo events
Configuration for triggering UI Feedback on ScanInfo events
Sets whether the trigger must apply defaultContent.
Sets whether the trigger must apply defaultAttributes.
Configuration attributes for UI Feedback view elements
Same definition as defaultAttributesSets the ScanInfo variable name to be watched.
Sets the ScanInfo variable value to be watched.
Allows to watch runSkipped events.
No Additional ItemsConfiguration for triggering UI Feedback on RunSkipped events
Configuration for triggering UI Feedback on RunSkipped events
Sets whether the trigger must apply defaultContent.
Sets whether the trigger must apply defaultAttributes.
Configuration attributes for UI Feedback view elements
Same definition as defaultAttributesSets the runSkipped code to be watched.
Configuration for uiFeedback preset.
Name of the preset.
Attributes inside preset.
No Additional ItemsConfiguration for uiFeedback preset attribute.
Name of the attribute declared in the preset definition.
Sets the value of the attribute.
Configuration for UI Feedback overlays
Sets the source of the overlay.
Sets the anchor of the overlay.
Sets the size dimension of the overlay.
Sets the scale for x axis of the overlay.
Sets the scale value of the overlay.
Sets the scale type of the overlay.
Allows to use overlay presets.
No Additional ItemsAllows to use element presets.
No Additional ItemsPreset definitions inside UIFeedbackConfig.
No Additional ItemsConfiguration for uiFeedback preset definition.
If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"presetElementOverlay" If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"presetElementTrigger" If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"presetElement" If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.
"preset" Sets the name of the preset definition.
Sets the preset definition type.
Attributes inside preset definition.
No Additional ItemsConfiguration for uiFeedback preset definition attribute.
Sets the name of the attribute.
Sets the name of the element of the attribute.
Sets the preset definition attribute element type.
Configuration for uiFeedback preset content definition.
Allows to use presets.
No Additional ItemsSchema for SDK ViewPlugin Configuration
No Additional PropertiesThe ID (name) of the workflow.
The processing mode of the workflow (parallel, sequential, parallelFirstScan).
The ordered list of viewPlugins, each as JSON object with a given viewPluginConfig.
Must contain a minimum of 1 items