Back to top
Home / Knox Capture / How-to-guides /

Configure scan engine settings

Last updated December 30th, 2024

Scan engine settings define the core Knox Capture behavior, such as how barcodes are scanned, and what happens with the data after each scan. The following settings are available:

Supported barcode types

Knox Capture supports the most commonly used barcode symbologies available. You can configure Knox Capture to scan the following:

Barcode type Supported symbologies Barcode data length Enabled by default
Numeric-only (1D) Codabar 23 No
Numeric-only (1D) EAN13 13 Yes
Numeric-only (1D) EAN8 8 Yes
Numeric-only (1D) Interleaved 2 of 5 (ITF) 50 Yes
Numeric-only (1D) UPCA 12 Yes
Numeric-only (1D) UPCE 8 Yes
Numeric-only (1D) DataBar 14 14 No
Numeric-only (1D) DataBar Limited 14 No
Alphanumeric (1D) Code 128 41 Yes
Alphanumeric (1D) Code 39 33 Yes
Alphanumeric (1D) Code 93 50 No
Alphanumeric (1D) DataBar Expanded 46 numeric or 26 alphanumeric No
2D Data Matrix 3095 Yes
2D PDF417 1661 Yes
2D QR 6738 Yes
2D Aztec 1194 No

All supported barcode data lengths were tested with Samsung Galaxy XCover6 Pro devices. Your data length results may vary depending on your device model, scanning environment, and actual barcode size.

Scanning settings

Scanning settings define how you want barcodes to be scanned when Knox Capture is launched.

Scan mode

Options Description
Single scan Sets Knox Capture to scan and parse one barcode at a time.
Multi scan Sets Knox Capture to scan and parse multiple barcodes in the scan area at the same time.

Single scan preferences

Options Description
Barcode selection: Automatic Captures the first-detected barcode without additional user input.
Barcode selection: Aim and scan Requires the user to aim the camera at a barcode and tap the Scan button to capture barcode data.
Continuous scanning: On or Off Allow device users to scan several barcodes in sequence, and register each scan as a single event. A counter in the top-left corner of the preview window gets updated with each scan. Toggled Off by default.

Multi scan settings

Options Description
Barcode selection: Automatic Captures the first-detected barcode without additional user input.
Barcode selection: Batch Lets the user scan multiple barcodes in a single camera frame using the Scan button.
Barcode selection: Aim and scan Requires the user to aim the camera at each barcode and tap the Scan button to capture its data.
Barcode selection: Tap to select Lets a user aim the camera at multiple barcodes, freeze the scanning overlay, tap each barcode to select, then tap the Scan button to capture data from the selected barcodes.
Scan session limit Defines the number of barcodes a user can scan before the camera preview window closes. A counter in the top-left corner of the preview window gets updated after each scan. Users can exit the camera preview window at any time by tapping Done, regardless of the number of barcodes captured. The default 0 value indicates infinite scans.

Beep after scan

Options Description
On or Off Emits a beep sound after each barcode scan. This is toggled On by default.

Vibrate after scan

Options Description
On or Off Sets the device to vibrate after each barcode scan. This is toggled On by default.

Parse GS1

Options Description
On or Off Parses scanned barcode data based on the GS1 Application Identifier (AI) definitions standard, before sending it to the target business app. For more information, refer to GS1 Application Identifiers. This is toggled Off by default.

Camera settings

These settings control the device’s camera when Knox Capture is launched.

Default camera

Options Description
Back Launches the device’s back camera when a scan is triggered. This is enabled by default.
Front Launches the device’s front camera when a scan is triggered.

Flashlight

Options Description
Off (default) Turns off the flashlight when scanning, and shows a flashlight button in the provided preview window.
On Automatically turns on the flashlight when scanning, and shows a flashlight button in the provided preview window.
Automatic The device monitors the light level and automatically turns the flashlights on or off. No flashlight button is provided in the preview window.

Zoom factor

Options Description
Any value from 1.0 to 4.0 Sets the default zoom level of the camera each time a user launches the scanner. 1.0 represents no zoom, 4.0 represents max zoom. Users can always zoom in and out using pinch gestures on the device. Default value is 1.0 (no zoom).

Barcode highlighting

These settings let you customize the appearance of barcodes when a scan is triggered.

Fill color

Options Description
Enter any hex color value in ARGB format Sets the color inside the box highlighting a recognized barcode. Default color is #00000000 (transparent).

Stroke color

Options Description
Enter any hex color value in ARGB format Sets the border color of the box highlighting a recognized barcode. Default color is #FF1C7980.

Stroke width

Options Description
Enter any value in pixels Sets the line thickness of the box highlighting the recognized barcode in pixels. Set to 3 pixels by default.

Advanced settings

These advanced settings control Knox Capture behavior outside the scope of normal scan mode, camera, or barcode settings.

Extended barcode type settings

Setting Options Description
Inverted color recognition On or Off for each barcode type Toggle on to allow Knox Capture to scan inverted color barcodes. This option is available for every supported barcode type. This option is toggled Off by default for each supported barcode type.
Return as UPCA On or Off Toggle on to allow Knox Capture to scan a UPCE barcode, and return the data to the business app in UPCA format. This option is toggled Off by default, and is only available for UPCE barcode types.
Two Digit Add-On On or Off Toggle on to allow Knox Capture to scan two-digit extension codes. This add-on doesn’t have a check digit. This option is available for EAN-8, EAN-13, UPC-A, and UPC-E barcode types, and it’s toggled Off by default for each supported barcode type.
Five Digit Add-On On or Off Toggle on to allow Knox Capture to scan five-digit extension codes. This add-on doesn’t have a check digit. This option is available for EAN-8, EAN-13, UPC-A, and UPC-E barcode types, and it’s toggled Off by default for each supported barcode type.

Barcode filtering

Setting Options Description
Custom validation Any regular expression (regex) Set a regular expression (regex) used to filter scanned barcodes. Only barcodes that match the provided regular expression will be accepted. See Android’s regex reference for details on crafting an expression. By default, no regex is set.
Highlight rejected codes On or Off Toggle on to enable an overlay in the camera preview window that appears around rejected codes. A Custom validation value must be set to enable this setting. This is toggled Off by default.

Visual cue

Setting Options Description
View finder selection Rectangular (default) Displays a rectangle in the scanning overlay to help users identify the correct barcode to scan. Users must ensure that the barcodes fit inside the rectangle in order to scan.
View finder selection Laser Displays a horizontal line in the scanning overlay to help users identify the correct barcode to scan. Users must ensure that the line covers the entire barcode in order to scan.
Rectangular viewfinder width Any value between 0% and 100% Sets the width of the rectangular viewfinder, specified as a percentage of the screen width. Only active if View finder selection is set to Rectangular. Default value is 90%.
Rectangular viewfinder height Any value between 0% and 100% Sets the height of the rectangular viewfinder, specified as a percentage of the screen height. Only active if View finder selection is set to Rectangular. Default value is 40%.

On this page

Is this page helpful?