iOS API Reference
DynamsoftBarcodeReader 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. |
setDBRTextResultDelegate |
Set callback function to process text results generated during frame decoding. |
setDBRIntermediateResultDelegate |
Set callback function to process intermediate results generated during frame decoding. |
| Property | Description |
|---|---|
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 3000ms for video barcode decoding. |
Image decoding Methods
| Method | Description |
|---|---|
decodeBuffer |
Decode barcodes from raw buffer. |
decodeFileWithName |
Decode barcodes from a specified image file. |
decodeImage |
Decode barcodes from an image file in memory. |
decodeBase64 |
Decode barcodes from a base64 encoded string. |
License
| Method | Description |
|---|---|
license |
Stores the license used in DynamsoftBarcodeReader. |
initWithLicense |
Read product key and activate the SDK. |
initWithLicenseFromServer |
Initialize license and connect to the specified server for online 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. |
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 |
|---|---|
createIntermediateResult |
Inits an intermediateResult struct with default values. |
getIntermediateResult |
Get intermediate results. |
decodeIntermediateResults |
Decodes barcode from intermediate results. |
Camera Enhancer
| Method | Description |
|---|---|
SetCameraEnhancerParam |
Deprecated, use setCameraEnhancer instead. |
Error Code
Auxiliary Classes
iAztecDetailsiContouriDataMatrixDetailsiDMDLSConnectionParametersiExtendedResultiFurtherModesiImageDataiIntermediateResultiLineSegmentiLocalizationResultiOneDCodeDetailsiPDF417DetailsiPublicRuntimeSettingsiQRCodeDetailsiQuadrilateraliRegionDefinitioniRegionOfInterestiSamplingImageDataiTextResult
Protocol
| Protocol | Description |
|---|---|
DBRTextResultDelegate |
Protocol for a delegate to handle callback when text result returned. |
DBRIntermediateResultDelegate |
Protocol for a delegate to handle callback when intermediate result returned. |
DBRErrorDelegate |
Protocol for a delegate to handle callback when an error returned. |
DBRServerLicenseVerificationDelegate |
Protocol for a delegate to handle callback when license verification message returned. |
DMDLSLicenseVerificationDelegate |
Protocol for a delegate to handle callback when license verification message returned. |
Enumerations
EnumBarcodeColourModeEnumBarcodeComplementModeEnumBarcodeFormatEnumBarcodeFormat_2EnumBinarizationModeEnumColourClusteringModeEnumColourConversionModeEnumConflictModeEnumDeblurModeEnumDeformationResistingModeEnumDPMCodeReadingModeEnumGrayscaleTransformationModeEnumImagePixelFormatEnumImagePreprocessingModeEnumIMResultDataTypeEnumIntermediateResultSavingModeEnumIntermediateResultTypeEnumLocalizationModeEnumPDFReadingModeEnumQRCodeErrorCorrectionLevelEnumRegionPredetectionModeEnumResultCoordinateTypeEnumResultTypeEnumScaleUpModeEnumTerminatePhaseEnumTextFilterModeEnumTextResultOrderModeEnumTextureDetectionMode
Yes
No