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 Android
Public Member Functions | |
SymbologySettings | getSymbologySettings (int symbology, int scanCaseMode) |
void | setSymbologyEnabled (int symbology, boolean enabled) |
void | setSymbologyEnabled (int symbology, boolean enabled, int scanCaseMode) |
void | setScanningAreaHeight (float height) |
void | setScanningAreaHeight (float height, int scanCaseMode) |
ScanSettings | getScanSettings (int scanCaseMode) |
Static Public Member Functions | |
static ScanCaseSettings | create () |
static ScanCaseSettings | createWithJson (JSONObject json) throws JSONParseException |
Protected Member Functions | |
ScanCaseSettings () | |
ScanCaseSettings (JSONObject json) throws JSONParseException | |
Detailed Description
Holds settings that affect the recognition of barcodes (e.g.
enabled barcode symbologies).
The settings are passed to the ScanCase when it is constructed.
- Since
- 5.6.0
Constructor & Destructor Documentation
|
protected |
Initialize a new setting object.
- Returns
- New case settings object. Internal settings for forward and downward scan are the same.
- Since
- 5.6.0
|
protected |
Returns a scan case settings instance initialized with the values contained in JSON object.
- Parameters
-
json JSON object, representing scan settings.
- Returns
- New case settings object, with internal settings for both forward and downward scan initialized with values from the JSON object.
- Exceptions
-
JSONParseException in case the JSON object is invalid.
Member Function Documentation
|
static |
Factory method creating a new scan case setting object.
- Returns
- Default scan case settings. Internal settings for forward and downward scan are the same.
- Since
- 5.6.0
|
static |
Factory method creating a new scan case setting object from a JSON object.
- Parameters
-
json JSON object, representing scan settings.
- Returns
- Scan case settings, with internal settings for both forward and downward scan initialized with values from the JSON object.
- Exceptions
-
JSONParseException in case the JSON object is invalid.
- Since
- 5.6.0
SymbologySettings getSymbologySettings | ( | int | symbology, |
int | scanCaseMode | ||
) |
Retrieve symbology-specific settings for either forward or downward scan.
- Parameters
-
symbology The symbology for which to retrieve the settings. scanCaseMode Scan case mode, one of ScanCase.MODE_FACE_FORWARD or ScanCase.MODE_FACE_DOWNWARD.
- Returns
- The symbology-specific settings object.
- Since
- 5.6.0
void setSymbologyEnabled | ( | int | symbology, |
boolean | enabled | ||
) |
Enable/disable decoding of a certain symbology for both forward and downward scan.
This function provides a convenient shortcut to enabling/disabling decoding of a particular symbology without having to go through SymbologySettings.
Some 1d barcode symbologies allow you to encode variable-length data. By default, the Scandit BarcodeScanner SDK only scans barcodes in a certain length range. If your application requires scanning of one of these symbologies, and the length is falling outside the default range, you may need to adjust the "active symbol counts" for the symbology in addition to enabling it. For details on defaults and how to calculate the symbol counts for each symbology, take a look at the barcode length page.
- Parameters
-
symbology The symbology to be enabled. enabled true when decoding of the symbology should be enabled, false if not.
- Since
- 5.6.0
void setSymbologyEnabled | ( | int | symbology, |
boolean | enabled, | ||
int | scanCaseMode | ||
) |
Enable/disable decoding of a certain symbology for either forward or downward scan.
This function provides a convenient shortcut to enabling/disabling decoding of a particular symbology without having to go through SymbologySettings.
Some 1d barcode symbologies allow you to encode variable-length data. By default, the Scandit BarcodeScanner SDK only scans barcodes in a certain length range. If your application requires scanning of one of these symbologies, and the length is falling outside the default range, you may need to adjust the "active symbol counts" for the symbology in addition to enabling it. For details on defaults and how to calculate the symbol counts for each symbology, take a look at the barcode length page.
- Parameters
-
symbology The symbology to be enabled. enabled true when decoding of the symbology should be enabled, false if not. scanCaseMode Scan case mode, one of ScanCase.MODE_FACE_FORWARD or ScanCase.MODE_FACE_DOWNWARD.
- Since
- 5.6.0
void setScanningAreaHeight | ( | float | height | ) |
Set the active scanning height for both forward and downward scan.
Use this method to set the active scanning height for both forward and downward scan.
- Parameters
-
height New active scanning height
- Since
- 5.6.0
void setScanningAreaHeight | ( | float | height, |
int | scanCaseMode | ||
) |
Set the active scanning height for either forward or downward scan.
Use this method to set the active scanning height for either forward or downward scan.
- Parameters
-
height New active scanning height scanCaseMode Scan case mode, one of ScanCase.MODE_FACE_FORWARD or ScanCase.MODE_FACE_DOWNWARD.
- Since
- 5.6.0
ScanSettings getScanSettings | ( | int | scanCaseMode | ) |
Retrieve the scan settings for either ScanCase.MODE_FACE_FORWARD or ScanCase.MODE_FACE_DOWNWARD.
Use this method to initialize the barcode picker for use with the Scandit Scan case.
- Parameters
-
scanCaseMode Scan case mode, one of ScanCase.MODE_FACE_FORWARD or ScanCase.MODE_FACE_DOWNWARD.
- Returns
- Scan settings object.
- Since
- 5.6.0
The documentation for this class was generated from the following file:
- ScanCaseSettings.java