BarcodeReader Class
Initialize
Method | Description |
---|---|
init |
Create an instance of Dynamsoft Barcode Reader. |
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. |
setDBRTextResultListener |
Set callback function to process text results generated during frame decoding. |
setDBRIntermediateResultListener |
Set callback function to process intermediate results generated during frame decoding. |
setImageSource |
Set the ImageSource as the source of video streaming. |
Property | Description |
---|---|
minImageReadingInterval |
The property indicates the minimum interval between two barcode 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 duplicateForgetTime for video barcode decoding. |
duplicateForgetTime |
The property of duplicateForgetTime , Default value is 3000(ms). |
Note:
setDBRTextResultDelegate
is deprecated, please usesetDBRTextResultListener
instead.setDBRIntermediateResultDelegate
is deprecated, please usesetDBRIntermediateResultListener
instead.
Image Decoding Methods
Method | Description |
---|---|
decodeBuffer(ImageData) |
Decode barcodes from a pixel buffer with width, height, stride and pixel format info. |
decodeBuffer |
Decode barcodes from a pixel buffer with width, height, stride and pixel format info. |
decodeImage |
Decode barcodes from an image file in memory. |
decodeBase64 |
Decode barcodes from a base64 encoded string. |
decodeFileInMemory |
Decode barcodes from a file that is read in the memory. |
License
Method | Description |
---|---|
initLicense |
Read product key and activate the SDK. |
setDeviceFriendlyName |
Sets a human-readable name that identifies the device. |
Note:
The following license activation methods are deprecated:
license
outputLicenseToString
initLicenseFromDLS
initWithLicenseFromServer
Please use
initLicense
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. |
allParameterTemplateNames |
Get the count of the parameter templates. |
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 |
---|---|
getIntermediateResult |
Get intermediate results. |
createIntermediateResult |
Inits an intermediateResult struct with default values. |
decodeIntermediateResults |
Decodes barcode from intermediate results. |
Status Retrieval
Method | Description |
---|---|
getVersion |
Get version information of SDK. |
setLogConfig |
Set the directory and the saving mode of log. It helps you on debugging. |