Dev Center
Swift
Objective-C
Table of contents

Android API Reference

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 Verify the results before output.
enableDuplicateFiter Output the duplicated result only once for every 3 seconds.

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).

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.

Error Code

Auxiliary Classes

Interfaces

Interfaces Description
TextResultCallback The interface to handle callback when text results are returned.
IntermediateResultCallback The interface to handle callback when intermediate results are returned.
ErrorCallback The interface to handle callback when an error is returned.
DBRServerLicenseVerificationListener The interface to handle callback when license verification messages are returned.
DBRDLSLicenseVerificationListener The interface to handle callback when license verification messages are returned.

Enumerations

This page is compatible for:

Version 7.5.0

Is this page helpful?

YesYes NoNo

In this article:

version 8.9.3

  • Latest version (10.2.10)
  • Version 10.x
    • Version 10.0.21
    • Version 10.0.20
  • Version 9.x
    • Version 9.6.20
    • Version 9.6.11
    • Version 9.6.10
    • Version 9.6.0
    • Version 9.4.0
    • Version 9.2.13
    • Version 9.2.11
    • Version 9.2.10
    • Version 9.0.2
    • Version 9.0.1
    • Version 9.0.0
  • Version 8.x
    • Version 8.9.3
    • Version 8.9.1
    • Version 8.9.0
    • Version 8.8.0
    • Version 8.6.0
    • Version 8.4.0
    • Version 8.2.1
    • Version 8.2.0
    • Version 8.1.2
    • Version 8.1.0
    • Version 8.0.0
  • Version 7.x
    • Version 7.6.0
    • Version 7.5.0
Change +