Deprecation warning
Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.
We are deprecating the 5.x API on all platforms (except Linux). Release 5.19 in April 2021 will be our final. Applications running 5.x will continue to work, and we will continue to release critical bug fixes and security patches only, for one year. We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.
You'll find the updated documentation at: Data Capture SDK Documentation for React Native
Classes | |
enum | CameraSwitchVisibility |
enum | GuiStyle |
enum | MatrixScanState |
Detailed Description
Abstract scan UI class.
The ScanOverlay implements the scan UI displayed on top of the video feed. It is responsible for highlighting barcodes and draw the viewfinder rectangle or laser UI.
Class Documentation
enum Scandit::ScanOverlay::CameraSwitchVisibility |
enum Scandit::ScanOverlay::GuiStyle |
Scan UI style.
Class Members | ||
---|---|---|
GUI_STYLE_DEFAULT |
Used with Scandit.BarcodePicker.setGuiStyle() method. A rectangular viewfinder with rounded corners is shown in the specified size. Recognized codes are marked with four corners. | |
GUI_STYLE_LASER |
Used with Scandit.BarcodePicker.setGuiStyle() method. A laser line is shown with the specified width while the height is not changeable. This mode should generally not be used if the recognition is running on the whole screen as it indicates that the code should be placed at the location of the laser line. | |
GUI_STYLE_NONE |
Used with Scandit.BarcodePicker.setGuiStyle() method. No UI is shown to indicate where the barcode should be placed. Be aware that the Scandit logo continues to be displayed as showing it is part of the license agreement. | |
GUI_STYLE_LOCATIONS_ONLY |
Used with Scandit.BarcodePicker.setGuiStyle() method. Like Scandit.ScanOverlay.GuiStyle.GUI_STYLE_NONE, but barcode locations are highlighted in the UI. | |
GUI_STYLE_MATRIX_SCAN |
Used with Scandit.BarcodePicker.setGuiStyle() method. The MatrixScan UI is shown. In order to use this UI, it is required to set ScanSettings.matrixScanEnabled to true. Only available on Android version 11 and up. |
enum Scandit::ScanOverlay::MatrixScanState |
Matrix scan code states.
Class Members | ||
---|---|---|
MATRIX_SCAN_STATE_LOCALIZED |
Used with Scandit.BarcodePicker.setMatrixScanHighlightingColor() method. State for tracked barcodes that have been localized, but not recognized yet. | |
MATRIX_SCAN_STATE_RECOGNIZED |
Used with Scandit.BarcodePicker.setMatrixScanHighlightingColor() method. State for tracked barcodes that have been recognized. | |
MATRIX_SCAN_STATE_REJECTED |
Used with Scandit.BarcodePicker.setMatrixScanHighlightingColor() method. State for tracked barcodes that have been rejected with Scandit.ScanSession.rejectCode(). |