BarcodeReader Class
Initialize
| Method | Description |
|---|---|
BarcodeReader |
Initialization of BarcodeReader object. |
Video Decoding Methods
| Method | Description |
|---|---|
setCameraEnhancer |
Bind a Camera Enhancer instance to the Barcode Reader. |
startScanning |
Start the barcode reading thread. |
stopScanning |
Stop the barcode reading thread. |
setTextResultCallback |
Set callback interface to process text results generated during frame decoding. |
setIntermediateResultCallback |
Set callback interface to process intermediate results generated during frame decoding. |
enableResultVerification |
Enable Result Verification feature to improve the accuracy of barcode results for video streaming barcode decoding. |
enableDuplicateFilter |
Enable Duplicate Filter feature to filter out the duplicate results in the period of 3000ms for video barcode decoding. |
Image Decoding Methods
| Method | Description |
|---|---|
decodeBuffer |
Decode barcodes from raw buffer. |
decodeFile |
Decode barcodes from a specified image file. |
decodeFileInMemory |
Decode barcodes from an image file in memory. |
decodeBase64String |
Decode barcodes from a base64 encoded string. |
decodeBufferedImage |
Decodes barcode from a buffered image (bitmap). |
initIntermediateResult |
Inits an intermediateResult struct with default values. |
decodeIntermediateResults |
Decodes barcode from intermediate results. |
License
| Method | Description |
|---|---|
initLicense |
Read product key and activate the SDK. |
initLicenseFromServer |
Initialize license and connect to the specified server for online verification. |
initLicenseFromLicenseContent |
Initialize license from the license content on client machine for offline verification. |
outputLicenseToString |
Output the license content to a string from the license server. |
initLicenseFromDLS |
Initializes the barcode reader license and connects to the specified server for online verification. |
initLicenseFromLTS |
Deprecated, please use initLicenseFromDLS instead. |
Parameter and Runtime Settings
Basic
| Method | Description |
|---|---|
getRuntimeSettings |
Get current runtime settings. |
updateRuntimeSettings (with struct) |
Modify and update the current runtime settings. |
updateRuntimeSettings (with preset template) |
Update runtime settings from one of the preset templates. |
resetRuntimeSettings |
Reset runtime settings to default. |
Advanced
| Method | Description |
|---|---|
initRuntimeSettingsWithFile |
Initialize runtime settings with the settings in a given JSON file. |
initRuntimeSettingsWithString |
Initialize runtime settings with the settings in a given JSON string. |
appendTplFileToRuntimeSettings |
Append a new template file to the current runtime settings. |
appendTplStringToRuntimeSettings |
Append a new template string to the current runtime settings. |
getAllParameterTemplateNames |
Gets the parameter templates name array. |
outputSettingsToFile |
Output runtime settings to a settings file (JSON file). |
outputSettingsToString |
Output runtime settings to a string. |
setModeArgument |
Set argument value for the specified mode parameter. |
getModeArgument |
Get argument value for the specified mode parameter. |
Result
| Method | Description |
|---|---|
initIntermediateResult |
Inits an intermediateResult struct with default values. |
getIntermediateResults |
Get intermediate results. |
decodeIntermediateResults |
Decodes barcode from intermediate results. |
Status Retrieval
| Method | Description |
|---|---|
getVersion |
Get version information of SDK. |
Camera Enhancer
| Method | Description |
|---|---|
StartCameraEnhancer |
Deprecated, use startScanning instead. |
StopCameraEnhancer |
Deprecated, use stopScanning instead. |
PauseCameraEnhancer |
Deprecated, use stopScanning instead. |
ResumeCameraEnhancer |
Deprecated, use startScanning instead. |
SetCameraEnhancerParam |
Deprecated, use setCameraEnhancer instead. |
Yes
No