Skip to content

Latest commit

 

History

History
225 lines (166 loc) · 14.4 KB

index-v8.9.3.md

File metadata and controls

225 lines (166 loc) · 14.4 KB
Raw
layout title description keywords needAutoGenerateSidebar needGenerateH3Content permalink
default-layout
Main Page - Dynamsoft Barcode Reader SDK Java Edition API Reference
This is the main page of Dynamsoft Barcode Reader SDK Java Edition API Reference.
api reference, java
true
true
/programming/java/api-reference/index-v8.9.3.html

Java API Reference

BarcodeReader Class

Initialize and Destroy

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

License Methods

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.
initDLSConnectionParameters Initializes a DMDLSConnectionParameters struct with default values.
initLicenseFromDLS Initializes the barcode reader license and connects to the specified server for online verification.
getIdleInstancesCount Gets available instances count when charging by concurrent instances count.
initLTSConnectionParameters Deprecated. Use initDLSConnectionParameters instead.
initLicenseFromLTS Deprecated. Use initLicenseFromDLS instead.

Decode Methods

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 imag (bitmap).
initIntermediateResult Inits an intermediateResult struct with default values.
decodeIntermediateResults Decodes barcode from intermediate results.

Basic Settings Methods

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 Settings Methods

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.

Result Methods

Method Description
getIntermediateResults Get intermediate results.

General Methods

Method Description
getVersion Get version information of SDK.

Video Methods

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.

Auxiliary Classes

Enumerations

Format Enumeration

Enumeration Description
[BarcodeFormat]({{ site.java_enumerations }}format-enums.html#barcodeformat) Describes the barcode types in BarcodeFormat group 1.
[BarcodeFormat_2]({{ site.java_enumerations }}format-enums.html#barcodeformat_2) Describes the barcode types in BarcodeFormat group 2.

Parameter Mode Enumeration

Enumeration Description
[BarcodeColourMode]({{ site.java_enumerations }}parameter-mode-enums.html#barcodecolourmode) Describes the barcode colour mode.
[BarcodeComplementMode]({{ site.java_enumerations }}parameter-mode-enums.html#barcodecomplementmode) Describes the barcode complement mode.
[BinarizationMode]({{ site.java_enumerations }}parameter-mode-enums.html#binarizationmode) Describes the binarization mode.
[ColourClusteringMode]({{ site.java_enumerations }}parameter-mode-enums.html#colourclusteringmode) Describes the colour clustering mode.
[ColourConversionMode]({{ site.java_enumerations }}parameter-mode-enums.html#colourconversionmode) Describes the colour conversion mode.
[ConflictMode]({{ site.java_enumerations }}parameter-mode-enums.html#conflictmode) Describes the conflict mode.
[DeblurMode]({{ site.java_enumerations }}parameter-mode-enums.html#deblurmode) Describes the deblur mode.
[DeformationResistingMode]({{ site.java_enumerations }}parameter-mode-enums.html#deformationresistingmode) Describes the deformation resisting mode.
[DPMCodeReadingMode]({{ site.java_enumerations }}parameter-mode-enums.html#dpmcodereadingmode) Describes the DPM code reading mode.
[GrayscaleTransformationMode]({{ site.java_enumerations }}parameter-mode-enums.html#grayscaletransformationmode) Describes the grayscale transformation mode.
[ImagePreprocessingMode]({{ site.java_enumerations }}parameter-mode-enums.html#imagepreprocessingmode) Describes the image preprocessing mode.
[LocalizationMode]({{ site.java_enumerations }}parameter-mode-enums.html#localizationmode) Describes the localization mode.
[PDFReadingMode]({{ site.java_enumerations }}parameter-mode-enums.html#pdfreadingmode) Describes the PDF reading mode.
[RegionPredetectionMode]({{ site.java_enumerations }}parameter-mode-enums.html#regionpredetectionmode) Describes the region predetection mode.
[ScaleUpMode]({{ site.java_enumerations }}parameter-mode-enums.html#scaleupmode) Describes the scale up mode.
[TerminatePhase]({{ site.java_enumerations }}parameter-mode-enums.html#terminatephase) Describes the terminate phase.
[TextFilterMode]({{ site.java_enumerations }}parameter-mode-enums.html#textfiltermode) Describes the text filter mode.
[TextureDetectionMode]({{ site.java_enumerations }}parameter-mode-enums.html#texturedetectionmode) Describes the texture detection mode.

Result Related Enumeration

Enumeration Description
[IMResultDataType]({{ site.java_enumerations }}result-enums.html#imresultdatatype) Describes the intermediate result data type.
[IntermediateResultSavingMode]({{ site.java_enumerations }}result-enums.html#intermediateresultsavingmode) Describes the intermediate result saving mode.
[IntermediateResultType]({{ site.java_enumerations }}result-enums.html#intermediateresulttype) Describes the intermediate result type.
[ResultCoordinateType]({{ site.java_enumerations }}result-enums.html#resultcoordinatetype) Describes the result coordinate type.
[ResultType]({{ site.java_enumerations }}result-enums.html#resulttype) Describes the extended result type.
[TextResultOrderMode]({{ site.java_enumerations }}result-enums.html#textresultordermode) Describes the text result order mode.

Frame Decoding Enumeration

Enumeration Description
[ClarityCalculationMethod]({{ site.java_enumerations }}frame-decoding-enums.html#claritycalculationmethod) Describes the clarity calculation method.
[ClarityFilterMode]({{ site.java_enumerations }}frame-decoding-enums.html#clarityfiltermode) Describes the clarity filter mode.

Other Enumeration

Enumeration Description
[DM_ChargeWay]({{ site.java_enumerations }}other-enums.html#dm_chargeway) Describes the charge way.
[DM_DeploymentType]({{ site.java_enumerations }}other-enums.html#dm_deploymenttype) Describes the deployment type.
[DM_LicenseModule]({{ site.java_enumerations }}other-enums.html#dm_licensemodule) Describes Dynamsoft license modules.
[DM_UUIDGenerationMethod]({{ site.java_enumerations }}other-enums.html#dm_uuidgenerationmethod) Describes the UUID generation method.
[ImagePixelFormat]({{ site.java_enumerations }}other-enums.html#imagepixelformat) Describes the image pixel format.
[QRCodeErrorCorrectionLevel]({{ site.java_enumerations }}other-enums.html#qrcodeerrorcorrectionlevel) Describes the QR Code error correction level.
[Product]({{ site.java_enumerations }}other-enums.html#product) Describes Dynamsoft products.

Interfaces

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