Barcode
Constructors
Properties
An optional array of barcode document formats that act as a detection filter. By default all supported document formats will be detected.
The customer format used in AUSTRALIA_POST codes. Only relevant for format codes 59 and 62. The default value is ALPHA_NUMERIC.
Sets auto close timer in seconds. 0 = disabled and it is the default value.
Accepted barcode formats
The type of barcode image generation.
The extension filter for EAN and UPC barcodes.
The camera module to be used for barcode scanning. The default value is BACK.
Background color of the detection overlay.
Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only
The relative initial zoom level of the camera in the range (0,1), where 0 is zoomed out and 1 is zoomed in. Default value is 0.0.
The range of valid camera zoom factors. Default value is (1.0; 12.0).
String being displayed on the cancel button.
The confirmation dialog configuration.
Freezes a preview after a scan for a given amount of seconds. Defaults to 0 secs. Android only.
Title of the button that opens the screen where the user can allow the usage of the camera by the app.
Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera.
The engine mode to be used for barcode scanning. The default value is NEXT_GEN.
Aspect ratio of finder frame (width \ height), which is used to build actual finder frame. Default is 1 - it is a square frame, which is good for QR capturing.
Foreground color of the detection overlay.
Width of finder frame border. Default is 2.
String being displayed as description.
Foreground color of the description label.
Foreground color of the flash button when flash is off.
Whether flash is toggled on or off.
The GS1 handling mode. The default value is PARSE.
Scanning delay after scanner appearance in seconds. Defaults to 0 secs.
If true, enabled the mode which slightly decreases the scanning quality and the energy consumption, and increases the scanning speed. If false - mode is disabled. The default is false. Android only.
Optional maximum text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
Lock focus distance withing minimum possible range
Optional minimum required quiet zone on the barcode. Measured in modules (the size of minimal bar on the barcode). The default is 10. NOTE - This feature works on ITF barcodes only.
Optional minimum required text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.
The checksum algorithm for MSI Plessey barcodes. The default value is MOD_10.
UI Interface orientation lock mode
The selection overlay configuration.
If true, replaces the cancel button in the top bar with a back arrow icon. The default value is FALSE. Android only.
With this option enabled, the scanner removes checks digits for UPC, EAN and MSI Plessey codes. Has no effect if both single and double digit MSI Plessey checksums are enabled. The default is false
Whether scanner screen should make a sound on successful barcode or MRZ detection.
Background color of the top bar.
Foreground color of the cancel button.
Whether touch-to-focus is enabled on camera preview. Enabled by default. Android only.
Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.
If true, the optional check digit for CODE_11 codes is used in validation. The default is true.
If true, the optional check digit for IATA_2_OF_5 codes is used in validation. The default is true.
Display the region of interest. The default value is TRUE.