Android API Reference
BarcodeReader Class
Initialize
Method | Description |
---|---|
BarcodeReader |
Initialization 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). |
Camera Enhancer
Method | Description |
---|---|
StartCameraEnhancer |
Start using Dynamsoft Camera Enhancer |
StopCameraEnhancer |
Stop using Dynamsoft Camera Enhancer |
PauseCameraEnhancer |
Pause the process of Dynamsoft Camera Enhancer |
ResumeCameraEnhancer |
Resume the process of Dynamsoft Camera Enhancer |
SetCameraEnhancerParam |
Set the parameters for Dynamsoft Camera Enhancer in Barcode reader |
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. |
initLicenseFromLTS |
Initializes the barcode reader license and connects to the specified server for online verification. |
Parameter and Runtime Settings
Basic
Method | Description |
---|---|
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. |
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. |
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 generated during frame decoding. |
setTextResultCallback |
Set callback interface to process text results generated during frame decoding. |
setIntermediateResultCallback |
Set callback interface to process intermediate results generated during frame decoding. |
Status retrieval
Method | Description |
---|---|
getLengthOfFrameQueue |
Get length of current inner frame queue. |
Error Code
Auxiliary Classes
AztecDetails
BarcodeReaderException
Contour
DataMatrixDetails
DCESettingParameters
DMLTSConnectionParameters
ExtendedResult
FrameDecodingParameters
FurtherModes
ImageData
IntermediateResult
LineSegment
LocalizationResult
OneDCodeDetails
PDF417Details
PublicRuntimeSettings
QRCodeDetails
Quadrilateral
RegionDefinition
RegionOfInterest
SamplingImageData
TextResult
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. |
DBRLTSLicenseVerificationListener |
The interface to handle callback when license verification messages are returned. |
Enumerations
EnumBarcodeColourMode
EnumBarcodeComplementMode
EnumBarcodeFormat
EnumBarcodeFormat_2
EnumBinarizationMode
EnumColourClusteringMode
EnumColourConversionMode
EnumConflictMode
EnumDeblurMode
EnumDeformationResistingMode
EnumDPMCodeReadingMode
EnumGrayscaleTransformationMode
EnumImagePixelFormat
EnumImagePreprocessingMode
EnumIMResultDataType
EnumIntermediateResultSavingMode
EnumIntermediateResultType
EnumLocalizationMode
EnumPDFReadingMode
EnumQRCodeErrorCorrectionLevel
EnumRegionPredetectionMode
EnumResultCoordinateType
EnumResultType
EnumScaleUpMode
EnumTerminatePhase
EnumTextFilterMode
EnumTextResultOrderMode
EnumTextureDetectionMode