Get Pricing Download 30-Day Trial
Dev Center
Table of contents

Dynamsoft Barcode Reader SDK - Java API Reference

BarcodeReader Methods

Initialize and Destroy

Method Description
BarcodeReader Initialization of BarcodeReader object.
destroy Destroys an instance of BarcodeReader object.

Decode

Method Description
decodeFile Decode barcodes from a specified image file.
decodeFileInMemory Decode barcodes from an image file in memory.
decodeBuffer Decode barcodes from raw buffer.
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.

Parameter and Runtime Settings

Basic

Method Description
setModeArgument Set argument value for the specified mode parameter.
getModeArgument Get argument value for the specified mode parameter.
getRuntimeSettings Get current runtime settings.
updateRuntimeSettings Modify and update the current runtime settings.
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.

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.
initLTSConnectionParameters Initializes a DMLTSConnectionParameters struct with default values.
initLicenseFromLTS Initializes the barcode reader license and connects to the specified server for online verification.

Result

Method Description
getIntermediateResults Get intermediate results.

General

Method Description
getVersion Get version information of SDK.

Video

Decode

Method Description
startFrameDecoding Decode barcodes from inner frame queue.
startFrameDecodingEx Decode barcodes from inner frame queue.
appendFrame Append a frame image buffer to the inner frame queue.
stopFrameDecoding Stop thread used for frame decoding.

Parameter

Method Description
initFrameDecodingParameters Initialize frame decoding parameter.

Callback

Method Description
setErrorCallback Set callback interface to process errors which is triggered when the library finishes decoding a frame.
setTextResultCallback Set callback interface to process text results which is triggered when the library finishes decoding a frame.
setIntermediateResultCallback Set callback interface to process intermediate results which is triggered when the library finishes decoding a frame.

Status retrieval

Method Description
getLengthOfFrameQueue Get length of current inner frame queue.

Interface

Function Description
ErrorCallback Represents the method that will handle the error code returned by the SDK.
IntermediateResultCallback Represents the method that will handle the intermediate result array returned by the SDK.
TextResultCallback Represents the method that will handle the text result array returned by the SDK.

Error Code

Classes

Enumerations

This page is compatible for:

Is this page helpful?

YesYes NoNo

version 8.2.0

  • Latest version
  • Version 10.x
    • Version 10.4.10
    • Version 10.2.10
    • Version 10.2.0
    • Version 10.0.20
    • Version 10.0.10
    • Version 10.0.0
  • Version 9.x
    • Version 9.6.40
    • Version 9.6.30
    • Version 9.6.20
    • Version 9.6.10
    • Version 9.6.0
    • Version 9.4.0
    • Version 9.2.0
    • Version 9.0.0
  • Version 8.x
    • Version 8.8.0
    • Version 8.6.0
    • Version 8.4.0
    • 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
  • Documentation Homepage
Change +