-
-
- Version 11.x -
- Version 10.x -
- Version 9.x -
- Version 8.x -
- Version 7.6.1 and below +
- Release Notes + -
- License Initialization +
- License Initialization
- Migrate from v10 to v11
- Migrate from v9 to v11 +
- FAQ +
- OTHER EDITIONS
- Choose a Language
-
From df6e79610f655fd4799f5ccfe13fc073dcb186ce Mon Sep 17 00:00:00 2001
From: Dynamsoft-Henry <78675724+Dynamsoft-Henry@users.noreply.github.com>
Date: Fri, 13 Feb 2026 10:19:52 +0800
Subject: [PATCH 02/72] Update main.yml
---
.github/workflows/main.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index efdd66b2..0dbfd069 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -8,7 +8,7 @@ on:
push:
branches:
- main
- #- preview
+ - preview
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
From d891a85127d345720a988458a52a0dd6a13bde16 Mon Sep 17 00:00:00 2001
From: Dynamsoft-Henry <78675724+Dynamsoft-Henry@users.noreply.github.com>
Date: Tue, 24 Feb 2026 17:47:21 +0800
Subject: [PATCH 03/72] Updating Android Sidelist
---
.../programming-android.html | 91 +++++++-------
.../capabilities/config-barcode-format.md | 113 ++++++++++++++++++
.../capabilities/read-from-an-image.md | 70 +++++++++++
.../user-guide/concept/barcode-format.md | 45 +++++++
.../concept/parameters-and-templates.md | 110 +++++++++++++++++
5 files changed, 384 insertions(+), 45 deletions(-)
create mode 100644 programming/android/user-guide/capabilities/config-barcode-format.md
create mode 100644 programming/android/user-guide/capabilities/read-from-an-image.md
create mode 100644 programming/android/user-guide/concept/barcode-format.md
create mode 100644 programming/android/user-guide/concept/parameters-and-templates.md
diff --git a/_includes/sidelist-programming/programming-android.html b/_includes/sidelist-programming/programming-android.html
index cf30afb1..f8a9fd51 100644
--- a/_includes/sidelist-programming/programming-android.html
+++ b/_includes/sidelist-programming/programming-android.html
@@ -1,59 +1,40 @@
-
- Develop With Ready-to-use UI - -
- User Guide +
- DEVELOPMENT +
- Get Started -
- Demo & Samples -
- API References
-
-
-
- Classes +
- Core Concepts + + + +
- Capabilities + - - -
- Develop With Foundational APIs - -
- User Guide
-
-
-
- Build Your First APP -
- Read from an Image -
- Understand Barcode Results +
- Control the Scanning Process -
- Parameter Settings & Templates -
- Specify barcode formats and count -
- Read a specific area/region -
- Customize the UI -
- Handle Challenging Barcodes +
- Decode Challenging Barcodes
- Read inverted barcodes
- Read deformed barcodes @@ -70,8 +51,28 @@
- Use format specific configurations
+ - Customize the UI
+
+
+
- Demo & Samples
- Foundational APIs @@ -696,8 +697,8 @@
- License Initialization -
- Migrate from v10 to v11 -
- Migrate from v9 to v11 +
- Migrate from v10 to v11 +
- Migrate from v9 to v11
- FAQ diff --git a/programming/android/user-guide/capabilities/config-barcode-format.md b/programming/android/user-guide/capabilities/config-barcode-format.md new file mode 100644 index 00000000..cdb764ce --- /dev/null +++ b/programming/android/user-guide/capabilities/config-barcode-format.md @@ -0,0 +1,113 @@ +--- +layout: default-layout +title: Barcode Formats - Dynamsoft Barcode Reader for Android User Guide +description: This page introduces the barcode format configuration feature of Dynamsoft Barcode Reader Android SDK. +keywords: barcode formats, Android, java, kotlin +noTitleIndex: true +needGenerateH3Content: true +needAutoGenerateSidebar: true +--- + +# Configure Barcode Formats + +Here are 2 ways for configuring barcode formats: + +- Configure formats in code. +- Configure formats together with other settings in the template. + +## Configure Formats in Your Code + +You specify barcode formats using a combined value of [`EnumBarcodeFormat`]({{ site.dbr_android_api }}enum/barcode-format.html). + +- Use bitwise OR (`|`) to combine multiple formats. +- `EnumBarcodeFormat.BF_DEFAULT` includes all common formats. (BF_ONED, BF_GS1_DATABAR, BF_PDF417, BF_QR_CODE, BF_DATAMATRIX, BF_AZTEC, BF_MAXICODE, BF_MICRO_QR, BF_MICRO_PDF417, BF_GS1_COMPOSITE) +- Use `EnumBarcodeFormat.BF_ALL` to enable all supported formats. +- Use group values like `EnumBarcodeFormat.BF_ONED` when appropriate. + +### BarcodeScanner API + +- `BarcodeScannerConfig.setBarcodeFormats(long format)` + +Example: + +```java +BarcodeScannerConfig config = new BarcodeScannerConfig(); +// QR Code + DataMatrix +config.setBarcodeFormats(EnumBarcodeFormat.BF_QR_CODE | EnumBarcodeFormat.BF_DATAMATRIX); +``` + +### Foundational API + +- `SimplifiedCaptureVisionSettings.barcodeSettings.barcodeFormatIds` + +Example: + +```java +try { + SimplifiedCaptureVisionSettings settings = mRouter.getSimplifiedSettings(EnumPresetTemplate.PT_READ_BARCODES); + SimplifiedBarcodeReaderSettings barcodeSettings = settings.barcodeSettings; + // Only read QR Code. + barcodeSettings.barcodeFormatIds = EnumBarcodeFormat.BF_QR_CODE | EnumBarcodeFormat.BF_DATAMATRIX; + mRouter.updateSettings(EnumPresetTemplate.PT_READ_BARCODES, settings); +} catch (CaptureVisionRouterException e) { + throw new RuntimeException(e); +} +``` + +> [!Note] +> If you are already using a customized template, you usually don't need to specify formats again in code. Read more about [Use a Customized Template](parameters-and-templates.md#use-a-customized-template). + +## Configure Formats in a Template + +Barcode formats are specified in `BarcodeFormatIds` of `BarcodeReaderTaskSettingOptions`. For example: + +```json +{ + "CaptureVisionTemplates": [ + { + "ImageROIProcessingNameArray": [ "ROI_2D" ], + "Name": "ReadCommon2D", + } + ], + "TargetROIDefOptions": [ + { + "Name": "ROI_2D", + "TaskSettingNameArray": [ "Task_2D" ] + } + ], + "BarcodeReaderTaskSettingOptions": [ + { + "Name": "Task_2D", + "BarcodeFormatIds": [ "BF_QR_CODE", "BF_DATAMATRIX", "BF_PDF417", "BF_MAXICODE" ], + "SectionArray": [ + { + "Section": "ST_BARCODE_LOCALIZATION", + "ImageParameterName": "ip" + }, + { + "Section": "ST_BARCODE_DECODING", + "ImageParameterName": "ip" + } + ] + } + ], + "ImageParameterOptions": [ + { + "Name": "ip" + } + ] +} +``` + +For common formats, you can download and use the preset templates below: + +| Barcode Format(s) | Template | +| ----------------- | -------- | +| EAN13, EAN8, UPC_A, UPC_E, GS1 Databar | [ReadOneDRetail.json](https://github.com/Dynamsoft/barcode-reader-mobile-samples/blob/main/android/BarcodeScannerAPISamples/ScenarioOrientedSamples/src/main/assets/Templates/ReadOneDRetail.json) | +| Code128, Code39, ITF, Codabar, MSI Code | [ReadOneDIndustrial.json](https://github.com/Dynamsoft/barcode-reader-mobile-samples/blob/main/android/BarcodeScannerAPISamples/ScenarioOrientedSamples/src/main/assets/Templates/ReadOneDIndustrial.json) | +| QR Code | [ReadQR.json](https://github.com/Dynamsoft/barcode-reader-mobile-samples/blob/main/android/BarcodeScannerAPISamples/ScenarioOrientedSamples/src/main/assets/Templates/ReadQR.json) | +| Data Matrix | [ReadDataMatrix.json](https://github.com/Dynamsoft/barcode-reader-mobile-samples/blob/main/android/BarcodeScannerAPISamples/ScenarioOrientedSamples/src/main/assets/Templates/ReadDataMatrix.json) | +| PDF417 | [ReadPDF417.json](https://github.com/Dynamsoft/barcode-reader-mobile-samples/blob/main/android/BarcodeScannerAPISamples/ScenarioOrientedSamples/src/main/assets/Templates/ReadPDF417.json) | +| Aztec | [ReadAztec.json](https://github.com/Dynamsoft/barcode-reader-mobile-samples/blob/main/android/BarcodeScannerAPISamples/ScenarioOrientedSamples/src/main/assets/Templates/ReadAztec.json) | +| QR Code, Data Matrix, PDF417 | [ReadCommon2D.json](https://github.com/Dynamsoft/barcode-reader-mobile-samples/blob/main/android/BarcodeScannerAPISamples/ScenarioOrientedSamples/src/main/assets/Templates/ReadCommon2D.json) | +| DotCode | [ReadDotCode.json](https://github.com/Dynamsoft/barcode-reader-mobile-samples/blob/main/android/BarcodeScannerAPISamples/ScenarioOrientedSamples/src/main/assets/Templates/ReadDotCode.json) | diff --git a/programming/android/user-guide/capabilities/read-from-an-image.md b/programming/android/user-guide/capabilities/read-from-an-image.md new file mode 100644 index 00000000..6281544a --- /dev/null +++ b/programming/android/user-guide/capabilities/read-from-an-image.md @@ -0,0 +1,70 @@ +--- +layout: default-layout +title: Read from an Image - Dynamsoft Barcode Reader for Android User Guide +description: This page explores how to read barcodes from an image with Dynamsoft Barcode Reader Android SDK. +keywords: user guide, read from an image, Android, java, kotlin +noTitleIndex: true +needGenerateH3Content: true +needAutoGenerateSidebar: true +--- + +# How to Read Barcodes from an Image + +> [!Note] +> Reference the [DecodeFromAnImage sample](https://github.com/Dynamsoft/barcode-reader-mobile-samples/tree/main/android/FoundationalAPISamples/DecodeFromAnImage){:target="_blank"} for how to decode from the album. + +The `capture` methods of `CaptureVisionRouter` class are designed to process a single image. + +```java +CapturedResult capture(String filePath, String templateName) {} +CapturedResult capture(byte[] fileBytes, String templateName) {} +CapturedResult capture(Bitmap bitmap, String templateName) {} +CapturedResult capture(ImageData imageData, String templateName) {} +``` + +## Supported Image Types + +The following image types are supported: + +1. Image with the file path. +2. Image in memory (file bytes). +3. `android.graphics.Bitmap` +4. [com.dynamsoft.core.basic_structures.ImageData]({{ site.dcvb_android_api }}core/basic-structures/image-data.html) + +> [!Note] +> When decoding with a file path, you should input the full file path with the extension name. Supported extensions: ".bmp", ".jpg", ".png", ".gif" or one-page ".tiff". + +## How to Specify Template Name + +When using the capture method, a `templateName` is required. You can specify either a preset template or the name a custom template. + +### Use a Preset Template + +`EnumPresetTemplate.PT_READ_BARCODES_READ_RATE_FIRST` is suggested for the template name when processing an image. + +```java +CapturedResult capturedResult = mRouter.capture("Your-file-path",EnumPresetTemplate.PT_READ_BARCODES_READ_RATE_FIRST); +``` + +### Use Customized Template + +View [Parameters and Settings - Use a Customized Template](parameters-and-settings.md#use-a-customized-template) for details. + +## Code Snippet + +```java +CapturedResult capturedResult = mRouter.capture("Your file path",EnumPresetTemplate.PT_READ_BARCODES_READ_RATE_FIRST); +DecodedBarcodesResult decodedBarcodesResult = capturedResult.getDecodedBarcodesResult(); +BarcodeResultItem[] barcodeResultItems = decodedBarcodesResult.getItems(); +for(BarcodeResultItem barcodeResultItem: barcodeResultItems) +{ + String barcodeText = barcodeResultItem.getText(); + String barcodeFormatString = barcodeResultItem.getFormatString(); +} +``` + +- `CapturedResult`: The biggest set of image processing results. `DecodedBarcodesResult` is one of the subsets of the `CapturedResult`. +- `DecodedBarcodesResult`: The set of barcode-type results. It contains an array of `BarcodeResultItem` and additional information. +- `BarcodeResultItem`: Object that represents a single decoded barcode. + +Read [Understand Barcode Decoding Results](../understand-decoded-barcodes-results.md) for more information. diff --git a/programming/android/user-guide/concept/barcode-format.md b/programming/android/user-guide/concept/barcode-format.md new file mode 100644 index 00000000..b667426b --- /dev/null +++ b/programming/android/user-guide/concept/barcode-format.md @@ -0,0 +1,45 @@ +--- +layout: default-layout +title: Barcode Formats - Dynamsoft Barcode Reader for Android User Guide +description: This page introduces the barcode format configuration feature of Dynamsoft Barcode Reader Android SDK. +keywords: barcode formats, Android, java, kotlin +noTitleIndex: true +needGenerateH3Content: true +needAutoGenerateSidebar: true +--- + +# Barcode Formats + +The Dynamsoft Barcode Reader SDK is designed to recognize different types of barcodes, including linear barcodes, 2-dimensional barcodes such as QR Code, PDF417, DataMatrix, MaxiCode, and Aztec Code, DataBar, GS1 Composite symbologies, Pharmacode, Patch Code, and various types of postal codes. + +## How Barcode Format Affects the Decoding Process + +During decoding, the SDK attempts to match the input image against all enabled barcode formats. Each format represents a distinct decoding logic and structural rule set. + +Enabling more formats means: + +- More decoding branches are evaluated +- More pattern checks are performed +- Higher chance of cross-format interpretation in edge cases + +This makes format configuration an important factor in both performance and accuracy. + +## Why Configure Barcode Formats? + +1. Improve the speed + - Fewer enabled formats reduce the number of decoding attempts per frame or image. + +2. Reduce misreads + - Similar symbologies (especially among 1D formats) may produce cross-decoding results when multiple formats are enabled. + +3. Align with license capability + - Some licenses enable only a subset of formats. + +## Supported Formats + +- See the introduction of [supported barcode formats](https://www.dynamsoft.com/barcode-reader/barcode-types/){:target="_blank"} +- View the full list in the enumeration [`EnumBarcodeFormat`]({{ site.dbr_android_api }}enum/barcode-format.html). + +## Next Step + +- [How to Configure Barcode Formats]({{ site.android }}user-guide/capabilities/config-barcode-format.html) diff --git a/programming/android/user-guide/concept/parameters-and-templates.md b/programming/android/user-guide/concept/parameters-and-templates.md new file mode 100644 index 00000000..90bae63a --- /dev/null +++ b/programming/android/user-guide/concept/parameters-and-templates.md @@ -0,0 +1,110 @@ +--- +layout: default-layout +title: Parameters & Settings - Dynamsoft Barcode Reader for Android User Guide +description: This page explores how to use the parameters and settings with Dynamsoft Barcode Reader Android SDK. +keywords: user guide, parameters, settings, Android, java, kotlin +noTitleIndex: true +needGenerateH3Content: true +needAutoGenerateSidebar: true +--- + +# Parameters, Settings & Templates + +- `Parameteres`: The algorithm `parameters` that determines how to process the images. (`LocalizationModes`, `DeblurModes` for example.) +- `Settings`: The APIs for you to quickly access the `parameters`. (`SimplifiedCaptureVisionSettings`, `SimplifiedBarcodeReaderSettings` for example.) +- `Templates`: JSON objects that can define all available `parameters`. +- `Preset Templates`: The preset templates for users to quick start. You can use the members of `EnumPresetTemplate` to specify the preset templates. +- `Customized Templates`: Template with customized parameters to maximize the efficiency. [Contact us for a customized template](https://www.dynamsoft.com/company/customer-service/#contact). + +### How to use Settings + +`SimplifiedCaptureVisionSettings` is a subset of the parameter template for users to quickly access. + +| SimplifiedCaptureVisionSettings | +| ------------------------------- | +| *Quadrilateral* roi
*int* minImageCaptureInterval
*int* maxParallelTasks
*int* timeout
*SimplifiedBarcodeReaderSettings* barcodeSettings
…… | + +Typical barcode decoding parameters are available in `SimplifiedBarcodeReaderSettings`, which you can access via `SimplifiedCaptureVisionSettings.barcodeSettings`. + +| SimplifiedBarcodeReaderSettings | +| ------------------------------- | +| *long* barcodeFormatIds
*int* expectedBarcodesCount
*int[]* localizationModes
*int[]* deblurModes
*int[]* grayscaleTransformationModes
*String* barcodeTextRegExPattern
…… | + +The steps to use `SimplifiedCaptureVisionSettings` are as follows: + +1. Get the `SimplifiedCaptureVisionSettings` object via [`DynamsoftCaptureVisionRouter.getSimplifiedSettings`]({{ site.dcvb_android_api }}capture-vision-router/settings.html). +2. Configure the simplified settings object. +3. Update the settings via `updateSettings`. + +```java +try { + // Here we use preset template PT_READ_BARCODES as an example. + SimplifiedCaptureVisionSettings simplifiedCaptureVisionSettings = mRouter.getSimplifiedSettings(EnumPresetTemplate.PT_READ_BARCODES); + simplifiedCaptureVisionSettings.minImageCaptureInterval = 200; + simplifiedCaptureVisionSettings.timeout = 200; + SimplifiedBarcodeReaderSettings simplifiedBarcodeReaderSettings = simplifiedCaptureVisionSettings.barcodeSettings; + simplifiedBarcodeReaderSettings.barcodeFormatIds = EnumBarcodeFormat.BF_QR_CODE | EnumBarcodeFormat.BF_DATAMATRIX; + simplifiedBarcodeReaderSettings.expectedBarcodesCount = 1; + simplifiedBarcodeReaderSettings.localizationModes = new int[]{EnumLocalizationMode.LM_CONNECTED_BLOCKS,EnumLocalizationMode.LM_NEURAL_NETWORK}; + simplifiedBarcodeReaderSettings.deblurModes = new int[]{EnumDeblurMode.DM_BASED_ON_LOC_BIN, EnumDeblurMode.DM_DIRECT_BINARIZATION, EnumDeblurMode.DM_DEEP_ANALYSIS}; + simplifiedBarcodeReaderSettings.grayscaleTransformationModes = new int[]{EnumGrayscaleTransformationMode.GTM_ORIGINAL,EnumGrayscaleTransformationMode.GTM_INVERTED}; + // You must trigger the updateSettings method to confirm the changes. + mRouter.updateSettings(EnumPresetTemplate.PT_READ_BARCODES, simplifiedCaptureVisionSettings); +} catch (CaptureVisionRouterException e) { + throw new RuntimeException(e); +} +``` + +> [!Important] +> The same `templateName` should be used in `getSimplifiedSettings`, `updateSettings` and `startCapturing` methods. + +```java +mRouter.startCapturing(EnumPresetTemplate.PT_READ_BARCODES, new CompletionListener() { + @Override + public void onSuccess() { + + } + + @Override + public void onFailure(int errorCode, String errorString) { + + } +}); +``` + +## How to Use a Template + +Add a **Templates** folder to the assets folder of your project at **src\main\assets\Templates**. Put your JSON file in the **Templates** folder. Here we use a **ReadQRCodes.json** file as an example. + +++ +Add the following code to initialize the template: + +```java +try { + mRouter.initSettingsFromFile("ReadQRCodes.json"); +} catch (CaptureVisionRouterException e) { + throw new RuntimeException(e); +} +``` + +To use your template, you have to specify the template name in the `startCapturing` or `capture` method. The template name is the name of `CaptureVisionTemplates` in your template file (see in the image of step 3). + +For example: + +```java +mRouter.startCapturing("ReadQRCodes", new CompletionListener() { + @Override + public void onSuccess() { + // Add code to run when the capture is successfully started. + } + + @Override + public void onFailure(int errorCode, String errorString) { + // Add code to run when the capture fails. + } +}); +``` From 366781f2d5f48d28a39767e91b220792d90e2b91 Mon Sep 17 00:00:00 2001 From: Dynamsoft-Henry <78675724+Dynamsoft-Henry@users.noreply.github.com> Date: Wed, 25 Feb 2026 09:58:00 +0800 Subject: [PATCH 04/72] Update programming-android.html --- .../programming-android.html | 527 +++++++++--------- 1 file changed, 264 insertions(+), 263 deletions(-) diff --git a/_includes/sidelist-programming/programming-android.html b/_includes/sidelist-programming/programming-android.html index f8a9fd51..a5002890 100644 --- a/_includes/sidelist-programming/programming-android.html +++ b/_includes/sidelist-programming/programming-android.html @@ -55,311 +55,311 @@
+
Template Example
+
-
-
- - Demo & Samples - -
- Foundational APIs
-
-
-
-
- DynamsoftCaptureVisionRouter
-
-
-
- CaptureVisionRouter - - -
- Classes +
- Classes - -
- Interfaces -
- Enumerations
-
- - DynamsoftBarcodeReader +
- Foundational APIs
-
-
- Classes +
- DynamsoftCaptureVisionRouter
-
-
- AztecDetails -
- BarcodeDetails -
- BarcodeReaderModule -
- BarcodeResultItem -
- CandidateBarcodeZonesUnit -
- CandidateBarcodeZone -
- ComplementedBarcodeImageUnit -
- DataMatrixDetails -
- DecodedBarcodeElement -
- DecodedBarcodesResult -
- DecodedBarcodesUnit -
- DeformationResistedBarcodeImageUnit -
- DeformationResistedBarcode -
- ECISegment -
- ExtendedBarcodeResult -
- LocalizedBarcodesUnit -
- LocalizedBarcodesElement -
- OneDCodeDetails -
- PDF417Details -
- QRCodeDetails -
- ScaledUpBarcodeImageUnit -
- SimplifiedBarcodeReaderSettings -
- - Enumerations
-
-
-
- BarcodeFormat -
- DeblurMode -
- ExtendedBarcodeResultType -
- LocalizationMode -
- QRCodeErrorCorrectionLevel +
- CaptureVisionRouter + + +
- Classes + + +
- Interfaces + + +
- Enumerations
+
-
+
- CaptureState +
- PresetTemplate +
-
- - DynamsoftCore
-
-
-
- Classes +
- DynamsoftBarcodeReader
-
-
- AuxiliaryRegionElement -
- BinaryImageUnit -
- CapturedResultBase -
- CapturedResultItem -
- ColourImageUnit -
- ContoursUnit -
- Contour -
- CoreModule -
- Corner -
- DSRect -
- Edge -
- EnhancedGrayscaleImageUnit -
- FileImageTag -
- GrayscaleImageUnit -
- ImageData -
- ImageSourceAdapter -
- ImageTag -
- IntermediateResultExtraInfo -
- IntermediateResultUnit -
- IntermediateResult -
- LineSegmentsUnit -
- LineSegment -
- ObservationParameters -
- OriginalImageResultItem -
- PredetectedRegionElement -
- PredetectedRegionsUnit -
- Quadrilateral -
- RegionObjectElement -
- ScaledColourImageUnit -
- ShortLinesUnit -
- TextRemovedBinaryImageUnit -
- TextureDetectionResultUnit -
- TextureRemovedBinaryImageUnit -
- TextureRemovedGrayscaleImageUnit -
- TextZonesUnit -
- TransformedGrayscaleImageUnit -
- Vector4 -
- VideoFrameTag +
- Classes
+
-
+
- AztecDetails +
- BarcodeDetails +
- BarcodeReaderModule +
- BarcodeResultItem +
- CandidateBarcodeZonesUnit +
- CandidateBarcodeZone +
- ComplementedBarcodeImageUnit +
- DataMatrixDetails +
- DecodedBarcodeElement +
- DecodedBarcodesResult +
- DecodedBarcodesUnit +
- DeformationResistedBarcodeImageUnit +
- DeformationResistedBarcode +
- ECISegment +
- ExtendedBarcodeResult +
- LocalizedBarcodesUnit +
- LocalizedBarcodesElement +
- OneDCodeDetails +
- PDF417Details +
- QRCodeDetails +
- ScaledUpBarcodeImageUnit +
- SimplifiedBarcodeReaderSettings +
+ - Enumerations + +
-
- - Interfaces +
- DynamsoftCore - +
- Classes
+
-
+
- AuxiliaryRegionElement +
- BinaryImageUnit +
- CapturedResultBase +
- CapturedResultItem +
- ColourImageUnit +
- ContoursUnit +
- Contour +
- CoreModule +
- Corner +
- DSRect +
- Edge +
- EnhancedGrayscaleImageUnit +
- FileImageTag +
- GrayscaleImageUnit +
- ImageData +
- ImageSourceAdapter +
- ImageTag +
- IntermediateResultExtraInfo +
- IntermediateResultUnit +
- IntermediateResult +
- LineSegmentsUnit +
- LineSegment +
- ObservationParameters +
- OriginalImageResultItem +
- PredetectedRegionElement +
- PredetectedRegionsUnit +
- Quadrilateral +
- RegionObjectElement +
- ScaledColourImageUnit +
- ShortLinesUnit +
- TextRemovedBinaryImageUnit +
- TextureDetectionResultUnit +
- TextureRemovedBinaryImageUnit +
- TextureRemovedGrayscaleImageUnit +
- TextZonesUnit +
- TransformedGrayscaleImageUnit +
- Vector4 +
- VideoFrameTag +
+
+ - Interfaces + + -
- Enumerations
-
-
-
- BufferOverflowProtectionMode -
- CapturedResultItemType -
- ColourChannelUsageType -
- CornerType -
- ErrorCode -
- GrayscaleEnhancementMode -
- GrayscaleTransformationMode -
- ImageCaptureDistanceMode -
- ImageFileFormat -
- ImagePixelFormat -
- ImageSourceState -
- ImageTagType -
- IntermediateResultUnitType -
- LogMode -
- RegionObjectElementType -
- SectionType -
- TransformMatrixType -
- VideoFrameQuality -
-
- - DynamsoftLicense
-
-
-
- Classes
-
-
-
- LicenseManager -
- LicenseModule -
- - Interfaces - - -
- - Classes
-
- DynamsoftUtility
-
-
-
-
- Classes
-
-
-
- CrossVerificationCriteria -
- DirectoryFetcher -
- FileFetcher -
- ImageDrawer -
- ImageIO -
- ImageProcessor -
- MultiFrameResultCrossFilter -
- ProactiveImageSourceAdapter -
- UtilityException -
- UtilityModule +
- Enumerations
+
-
+
- BufferOverflowProtectionMode +
- CapturedResultItemType +
- ColourChannelUsageType +
- CornerType +
- ErrorCode +
- GrayscaleEnhancementMode +
- GrayscaleTransformationMode +
- ImageCaptureDistanceMode +
- ImageFileFormat +
- ImagePixelFormat +
- ImageSourceState +
- ImageTagType +
- IntermediateResultUnitType +
- LogMode +
- RegionObjectElementType +
- SectionType +
- TransformMatrixType +
- VideoFrameQuality +
- - Enumerations +
- DynamsoftLicense
-
-
- EnumFilterType +
- Classes
+
-
+
- LicenseManager +
- LicenseModule +
+ - Interfaces + +
-
- - Classes
-
- DynamsoftIdentityUtility
-
-
-
- Classes +
- DynamsoftUtility - -
- - DynamsoftCodeParser
-
-
-
- Supported Code Types - + -
- Classes +
- DynamsoftIdentityUtility
-
-
- CodeParser -
- CodeParserModule -
- ParsedResultItem -
- ParsedResult +
- Classes + +
- - Enumerations +
- DynamsoftCodeParser
-
-
- CodeType -
- MappingStatus -
- ValiadtionStatus +
- Supported Code Types + + +
- Classes + + +
- Enumerations
+
-
+
- CodeType +
- MappingStatus +
- ValiadtionStatus +
-
- - DynamsoftCameraEnhancer
-
-
-
- Classes - - -
- Interfaces - - -
- Enumerations +
- DynamsoftCameraEnhancer
-
-
- EnumCameraPosition -
- EnumCameraState -
- EnumCoordinateBase -
- EnumDrawingItemMediaType -
- EnumDrawingItemState -
- EnumEnhancedFeatures -
- EnumFocusMode -
- EnumResolution +
- Classes + + +
- Interfaces + + +
- Enumerations + +
+
- - DynamsoftCaptureVisionRouter
-
- UNDERSTANDING DBR +
- Engine Architecture & Optimization
- Performance -
- Parameters +
- Parameters System
- CaptureVisionTemplate Object
-
@@ -686,6 +686,7 @@
- USEFUL RESOURCES +
- Demo & Samples
- Release Notes
- Version 11.x @@ -715,4 +716,4 @@
- .NET
- JS
\ No newline at end of file
+
From a535b2f3c0d9ed87432669b7f6b9b02c9d7f9e10 Mon Sep 17 00:00:00 2001
From: Dynamsoft-Henry <78675724+Dynamsoft-Henry@users.noreply.github.com>
Date: Wed, 25 Feb 2026 10:00:12 +0800
Subject: [PATCH 05/72] Update programming-android.html
---
_includes/sidelist-programming/programming-android.html | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/_includes/sidelist-programming/programming-android.html b/_includes/sidelist-programming/programming-android.html
index a5002890..c5f1cce2 100644
--- a/_includes/sidelist-programming/programming-android.html
+++ b/_includes/sidelist-programming/programming-android.html
@@ -359,7 +359,7 @@
- CaptureVisionTemplate Object
- - Engine Architecture & Optimization +
- ENGINE ARCHITECTURE & OPTIMIZATION
- Performance
- Speed From ba1a5d00156543d01946014ffd7391db09e091b4 Mon Sep 17 00:00:00 2001 From: Dynamsoft-Henry <78675724+Dynamsoft-Henry@users.noreply.github.com> Date: Wed, 25 Feb 2026 10:25:13 +0800 Subject: [PATCH 06/72] Updating side lists --- .../programming-android.html | 2 +- .../concept/parameters-and-templates.md | 43 +++++++++++++++---- .../user-guide/understand-barcode-results.md | 16 ------- 3 files changed, 36 insertions(+), 25 deletions(-) diff --git a/_includes/sidelist-programming/programming-android.html b/_includes/sidelist-programming/programming-android.html index c5f1cce2..1e32a072 100644 --- a/_includes/sidelist-programming/programming-android.html +++ b/_includes/sidelist-programming/programming-android.html @@ -8,7 +8,7 @@
- Core Concepts diff --git a/programming/android/user-guide/concept/parameters-and-templates.md b/programming/android/user-guide/concept/parameters-and-templates.md index 90bae63a..c9db0ef5 100644 --- a/programming/android/user-guide/concept/parameters-and-templates.md +++ b/programming/android/user-guide/concept/parameters-and-templates.md @@ -10,14 +10,41 @@ needAutoGenerateSidebar: true # Parameters, Settings & Templates -- `Parameteres`: The algorithm `parameters` that determines how to process the images. (`LocalizationModes`, `DeblurModes` for example.) -- `Settings`: The APIs for you to quickly access the `parameters`. (`SimplifiedCaptureVisionSettings`, `SimplifiedBarcodeReaderSettings` for example.) +- `Parameteres`: Algorithm `parameters` that determines how to process the images. +- `Settings`: APIs for you to quickly access the `parameters`. - `Templates`: JSON objects that can define all available `parameters`. -- `Preset Templates`: The preset templates for users to quick start. You can use the members of `EnumPresetTemplate` to specify the preset templates. -- `Customized Templates`: Template with customized parameters to maximize the efficiency. [Contact us for a customized template](https://www.dynamsoft.com/company/customer-service/#contact). +- `Preset Templates`: Quick-start templates. Available via `EnumPresetTemplate`. +- `Customized Templates`: Customized templates in a JSON file. -### How to use Settings +### When to use Settings +Settings are intergated under `SimplifiedCaptureVisionSettings`, which is a subset of the parameter template. Simple and common parameters are available in `SimplifiedCaptureVisionSettings` so that you can quickly access the parameters. + +Available settings: + +- Barcode formats +- Expected barcodes count +- ROI +- Timeout +- Image capture interval + +Generally, settings are used together with `Preset Templates`. + +Common Steps: + +1. Select a `Preset Template`. +2. Minor optimization with `SimplifiedCaptureVisionSettings`. + +### When to use a Customized Templates + +If you are not satisfied with the curent performance, you can contact us for a fully customization. Then, you receive a customized template. + +### Next Step + +- [`SimplifiedCaptureVisionSettings`]({{ site.dcvb_android_api }}capture-vision-router/simplified-capture-vision-settings.html) API references +- How to use customized templates - [initSettingsFromFile]({{ site.dcvb_android_api }}capture-vision-router/settings.html#initsettingsfromfile) + + + diff --git a/programming/android/user-guide/understand-barcode-results.md b/programming/android/user-guide/understand-barcode-results.md index 2bd88839..f6900cb8 100644 --- a/programming/android/user-guide/understand-barcode-results.md +++ b/programming/android/user-guide/understand-barcode-results.md @@ -19,22 +19,6 @@ It contains: - Error information when a failure occurs. - A rotation transformation matrix if the original image includes rotation info. -```java -mRouter.addResultReceiver(new CapturedResultReceiver() { - @Override - public void onDecodedBarcodesReceived(@NonNull DecodedBarcodesResult result) { - if (result.getItems().length!=0) - { - for(BarcodeResultItem item:result.getItems()) - { - String barcodeText = barcodeResultItem.getText(); - String barcodeFormatString = barcodeResultItem.getFormatString(); - } - } - } -}); -``` - ## How to Use ### Check Error Messages From 85a42cdd03ad67ecd85f76ddc329336026510f02 Mon Sep 17 00:00:00 2001 From: Dynamsoft-Henry <78675724+Dynamsoft-Henry@users.noreply.github.com> Date: Wed, 25 Feb 2026 10:35:02 +0800 Subject: [PATCH 07/72] Update index.md --- programming/android/index.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/programming/android/index.md b/programming/android/index.md index 1abbac2f..443fe32a 100644 --- a/programming/android/index.md +++ b/programming/android/index.md @@ -17,12 +17,16 @@ You can either get a quick start with the [BarcodeScanner APIs](api-reference/ba | | Develop with BarcodeScanner APIs | Develop with Foundational APIs | | -- | ------------------------------ | ------------------------------ | | Lines of Code | 15+ lines | 60+ lines | -| UI | Preset | Fully customizable | +| UI | Preset UI only | Custom UI (DIY) | | Decode from Live Video | ✔ | ✔ | -| Decode from an Image | X | ✔ | +| Return Multiple Barcodes | ✔ | ✔ | +| Specify Barcode Formats | ✔ | ✔ | | Performance Customization | ✔ | ✔ | | Camera Control | Limited | ✔ | -| Intermediate Results | X | ✔ | +| Decode from an Image | X | ✔ | +| Save Original Image | X | ✔ | +| Continuous Scan | X | ✔ | +| Parse Barcode Text (e.g. Driver's license) | X | ✔ | ## Develop with BarcodeScanner APIs From 0d526f7f6b9d56419f71e9e8645c6bab4ab74ecb Mon Sep 17 00:00:00 2001 From: Dynamsoft-Henry <78675724+Dynamsoft-Henry@users.noreply.github.com> Date: Wed, 25 Feb 2026 10:42:33 +0800 Subject: [PATCH 08/72] Updating side list --- _includes/sidelist-programming/programming-android.html | 2 +- .../android/user-guide/capabilities/read-from-camera.md | 9 +++++++++ 2 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 programming/android/user-guide/capabilities/read-from-camera.md diff --git a/_includes/sidelist-programming/programming-android.html b/_includes/sidelist-programming/programming-android.html index 1e32a072..5735deee 100644 --- a/_includes/sidelist-programming/programming-android.html +++ b/_includes/sidelist-programming/programming-android.html @@ -19,7 +19,7 @@
- Input
- Working with Results diff --git a/programming/android/user-guide/capabilities/read-from-camera.md b/programming/android/user-guide/capabilities/read-from-camera.md new file mode 100644 index 00000000..4222148e --- /dev/null +++ b/programming/android/user-guide/capabilities/read-from-camera.md @@ -0,0 +1,9 @@ +--- +layout: default-layout +title: Read from camera - Dynamsoft Barcode Reader for Android User Guide +description: This page explores how to read barcodes from camera with Dynamsoft Barcode Reader Android SDK. +keywords: user guide, read from camera, Android, java, kotlin +noTitleIndex: true +needGenerateH3Content: true +needAutoGenerateSidebar: true +--- From 4274f6c62835620d7dfd33ceb1d18bfbcf5576ca Mon Sep 17 00:00:00 2001 From: Dynamsoft-Henry <78675724+Dynamsoft-Henry@users.noreply.github.com> Date: Wed, 25 Feb 2026 10:44:17 +0800 Subject: [PATCH 09/72] Update programming-android.html --- _includes/sidelist-programming/programming-android.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/sidelist-programming/programming-android.html b/_includes/sidelist-programming/programming-android.html index 5735deee..e0368fc0 100644 --- a/_includes/sidelist-programming/programming-android.html +++ b/_includes/sidelist-programming/programming-android.html @@ -30,7 +30,7 @@
- Control the Scanning Process From 5f233caf50ad8b1a05b18599a2c1ca1f16c47b64 Mon Sep 17 00:00:00 2001 From: Dynamsoft-Henry <78675724+Dynamsoft-Henry@users.noreply.github.com> Date: Thu, 5 Mar 2026 16:35:56 +0800 Subject: [PATCH 10/72] Updating android side list --- .../programming-android.html | 13 +- ...g-barcode-format.md => barcode-formats.md} | 26 +-- .../config-simplified-settings.md | 62 ++++++ .../user-guide/capabilities/customize-ui.md | 149 ++++++++++++++ .../user-guide/capabilities/feedback.md | 59 ++++++ .../capabilities/init-customized-template.md | 66 +++++++ .../capabilities/read-from-an-image.md | 33 ++-- .../capabilities/read-from-camera.md | 83 +++++++- .../capabilities/read-specific-area.md | 183 ++++++++++++++++++ .../capabilities/single-multiple.md | 135 +++++++++++++ .../user-guide/capabilities/zoom-control.md | 117 +++++++++++ .../user-guide/concept/barcode-format.md | 20 +- .../concept/parameters-and-templates.md | 116 ++--------- .../understand-barcode-results.md | 37 +--- .../understand-barcode-scan-results.md | 9 +- .../user-guide/explore-features/index.md | 2 +- .../user-guide/scanner-barcode-formats.md | 118 +++++++++-- .../user-guide/scanner-customize-ui.md | 112 ++++++++++- .../user-guide/scanner-improve-performance.md | 1 + .../android/user-guide/use-cases/index.md | 2 +- 20 files changed, 1129 insertions(+), 214 deletions(-) rename programming/android/user-guide/capabilities/{config-barcode-format.md => barcode-formats.md} (74%) create mode 100644 programming/android/user-guide/capabilities/config-simplified-settings.md create mode 100644 programming/android/user-guide/capabilities/customize-ui.md create mode 100644 programming/android/user-guide/capabilities/feedback.md create mode 100644 programming/android/user-guide/capabilities/init-customized-template.md create mode 100644 programming/android/user-guide/capabilities/read-specific-area.md create mode 100644 programming/android/user-guide/capabilities/single-multiple.md create mode 100644 programming/android/user-guide/capabilities/zoom-control.md rename programming/android/user-guide/{ => concept}/understand-barcode-results.md (74%) rename programming/android/user-guide/{ => concept}/understand-barcode-scan-results.md (85%) diff --git a/_includes/sidelist-programming/programming-android.html b/_includes/sidelist-programming/programming-android.html index e0368fc0..16094dd6 100644 --- a/_includes/sidelist-programming/programming-android.html +++ b/_includes/sidelist-programming/programming-android.html @@ -22,16 +22,21 @@
- Read from Image
- - Working with Results +
- Working with Results -
- Control the Scanning Process +
- Control the Scanning Process
- Decode Challenging Barcodes
diff --git a/programming/android/user-guide/capabilities/config-barcode-format.md b/programming/android/user-guide/capabilities/barcode-formats.md
similarity index 74%
rename from programming/android/user-guide/capabilities/config-barcode-format.md
rename to programming/android/user-guide/capabilities/barcode-formats.md
index cdb764ce..2b34b21a 100644
--- a/programming/android/user-guide/capabilities/config-barcode-format.md
+++ b/programming/android/user-guide/capabilities/barcode-formats.md
@@ -1,7 +1,7 @@
---
layout: default-layout
-title: Barcode Formats - Dynamsoft Barcode Reader for Android User Guide
-description: This page introduces the barcode format configuration feature of Dynamsoft Barcode Reader Android SDK.
+title: Configure Barcode Formats - Dynamsoft Barcode Reader Android
+description: Learn how to configure barcode formats in the Dynamsoft Barcode Reader Android SDK.
keywords: barcode formats, Android, java, kotlin
noTitleIndex: true
needGenerateH3Content: true
@@ -10,17 +10,17 @@ needAutoGenerateSidebar: true
# Configure Barcode Formats
-Here are 2 ways for configuring barcode formats:
+There are two ways to configure barcode formats:
- Configure formats in code.
- Configure formats together with other settings in the template.
## Configure Formats in Your Code
-You specify barcode formats using a combined value of [`EnumBarcodeFormat`]({{ site.dbr_android_api }}enum/barcode-format.html).
+Specify barcode formats using a combined value of [`EnumBarcodeFormat`]({{ site.dbr_android_api }}enum/barcode-format.html).
- Use bitwise OR (`|`) to combine multiple formats.
-- `EnumBarcodeFormat.BF_DEFAULT` includes all common formats. (BF_ONED, BF_GS1_DATABAR, BF_PDF417, BF_QR_CODE, BF_DATAMATRIX, BF_AZTEC, BF_MAXICODE, BF_MICRO_QR, BF_MICRO_PDF417, BF_GS1_COMPOSITE)
+- `EnumBarcodeFormat.BF_DEFAULT` includes all common formats (`BF_ONED`, `BF_GS1_DATABAR`, `BF_PDF417`, `BF_QR_CODE`, `BF_DATAMATRIX`, `BF_AZTEC`, `BF_MAXICODE`, `BF_MICRO_QR`, `BF_MICRO_PDF417`, and `BF_GS1_COMPOSITE`).
- Use `EnumBarcodeFormat.BF_ALL` to enable all supported formats.
- Use group values like `EnumBarcodeFormat.BF_ONED` when appropriate.
@@ -44,22 +44,22 @@ Example:
```java
try {
- SimplifiedCaptureVisionSettings settings = mRouter.getSimplifiedSettings(EnumPresetTemplate.PT_READ_BARCODES);
- SimplifiedBarcodeReaderSettings barcodeSettings = settings.barcodeSettings;
- // Only read QR Code.
- barcodeSettings.barcodeFormatIds = EnumBarcodeFormat.BF_QR_CODE | EnumBarcodeFormat.BF_DATAMATRIX;
- mRouter.updateSettings(EnumPresetTemplate.PT_READ_BARCODES, settings);
+ SimplifiedCaptureVisionSettings settings = mRouter.getSimplifiedSettings(EnumPresetTemplate.PT_READ_BARCODES);
+ SimplifiedBarcodeReaderSettings barcodeSettings = settings.barcodeSettings;
+ // Only read QR Code.
+ barcodeSettings.barcodeFormatIds = EnumBarcodeFormat.BF_QR_CODE | EnumBarcodeFormat.BF_DATAMATRIX;
+ mRouter.updateSettings(EnumPresetTemplate.PT_READ_BARCODES, settings);
} catch (CaptureVisionRouterException e) {
- throw new RuntimeException(e);
+ throw new RuntimeException(e);
}
```
> [!Note]
-> If you are already using a customized template, you usually don't need to specify formats again in code. Read more about [Use a Customized Template](parameters-and-templates.md#use-a-customized-template).
+> If you are already using a customized template, you usually do not need to specify formats again in code. See [Use a Customized Template](parameters-and-templates.md#use-a-customized-template) for details.
## Configure Formats in a Template
-Barcode formats are specified in `BarcodeFormatIds` of `BarcodeReaderTaskSettingOptions`. For example:
+Barcode formats are specified in `BarcodeFormatIds` under `BarcodeReaderTaskSettingOptions`. For example:
```json
{
diff --git a/programming/android/user-guide/capabilities/config-simplified-settings.md b/programming/android/user-guide/capabilities/config-simplified-settings.md
new file mode 100644
index 00000000..e32bd4aa
--- /dev/null
+++ b/programming/android/user-guide/capabilities/config-simplified-settings.md
@@ -0,0 +1,62 @@
+---
+layout: default-layout
+title: Configuring Simplified Settings - Dynamsoft Barcode Reader Android
+description: Learn how to configure simplified settings in the Dynamsoft Barcode Reader Android SDK.
+keywords: simplified settings, Android, java, kotlin
+noTitleIndex: true
+needGenerateH3Content: true
+needAutoGenerateSidebar: true
+---
+
+# How to Configure Simplified Settings
+
+> [!Important]
+> Features on this page are only available for the **Foundational APIs**.
+
+This page explores how to configure basic image processing settings with `SimplifiedCaptureVisionSettings`. The following APIs will be used:
+
+1. `getSimplifiedSettings`: Get the settings of the specified `template`.
+2. `updateSettings`: Update the settings to the specified `template`.
+
+
+>- Java
+>- Kotlin
+>
+>1.
+```java
+CaptureVisionRouter mRouter;
+mRouter = new CaptureVisionRouter();
+try {
+ // Obtain current runtime settings.
+ SimplifiedCaptureVisionSettings simplifiedCaptureVisionSettings = mRouter.getSimplifiedSettings(EnumPresetTemplate.PT_READ_BARCODES);
+ simplifiedCaptureVisionSettings.minImageCaptureInterval = 200;
+ simplifiedCaptureVisionSettings.timeout = 200;
+ SimplifiedBarcodeReaderSettings simplifiedBarcodeReaderSettings = simplifiedCaptureVisionSettings.barcodeSettings;
+ simplifiedBarcodeReaderSettings.barcodeFormatIds = EnumBarcodeFormat.BF_QR_CODE | EnumBarcodeFormat.BF_DATAMATRIX;
+ simplifiedBarcodeReaderSettings.expectedBarcodesCount = 1;
+ // Update settings. Here you must specify the same template name you used when getting the settings.
+ mRouter.updateSettings(EnumPresetTemplate.PT_READ_BARCODES, simplifiedCaptureVisionSettings);
+} catch (CaptureVisionRouterException e) {
+ throw new RuntimeException(e);
+}
+```
+2.
+```kotlin
+val mRouter: CaptureVisionRouter? = CaptureVisionRouter()
+try {
+ // Obtain current runtime settings.
+ val simplifiedCaptureVisionSettings = mRouter?.getSimplifiedSettings(EnumPresetTemplate.PT_READ_BARCODES)
+ simplifiedCaptureVisionSettings?.minImageCaptureInterval = 200
+ simplifiedCaptureVisionSettings?.timeout = 200
+ val simplifiedBarcodeReaderSettings = simplifiedCaptureVisionSettings?.barcodeSettings
+ simplifiedBarcodeReaderSettings!!.barcodeFormatIds = EnumBarcodeFormat.BF_QR_CODE or EnumBarcodeFormat.BF_DATAMATRIX
+ simplifiedBarcodeReaderSettings.expectedBarcodesCount = 1
+ // Update settings. Here you must specify the same template name you used when getting the settings.
+ mRouter?.updateSettings(EnumPresetTemplate.PT_READ_BARCODES, simplifiedCaptureVisionSettings)
+} catch (e: CaptureVisionRouterException) {
+ throw RuntimeException(e)
+}
+```
+
+> [!Note]
+> To use the settings you have configured, you must specify the same template name when triggering the `startCapturing` or `capture` methods.
diff --git a/programming/android/user-guide/capabilities/customize-ui.md b/programming/android/user-guide/capabilities/customize-ui.md
new file mode 100644
index 00000000..f27be7da
--- /dev/null
+++ b/programming/android/user-guide/capabilities/customize-ui.md
@@ -0,0 +1,149 @@
+---
+layout: default-layout
+title: Customize the UI of BarcodeScanner - Dynamsoft Barcode Reader for Android
+description: Learn how to customize the BarcodeScanner UI on Android.
+keywords: BarcodeScanner, scanner, Android, scan region, torch button, close button, scan laser
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+noTitleIndex: true
+---
+
+# Configure the UI Elements
+
+| Available UI Elements |
+| ------------------- |
+| Scan region |
+| Scan Laser |
+| Torch button |
+| Camera toggle button |
+| Close button (BarcodeScanner API only) |
+
+BarcodeScanner provides a set of UI elements that you can easily customize.
+
+++ +- Close button: Stops barcode scanning and returns to the previous activity. +- Scan region: Sets a region of interest so the algorithm focuses only on that area. This can significantly improve processing speed. For special barcode types such as DotCode, the scan region can also improve the read rate. +- Scan laser: A line that moves up and down. Its movement is limited to the scan region. +- Torch button: A clickable button that turns the torch on or off. + +## Scan Region & Scan Laser + +### Configure with BarcodeScanner APIs + + +>- Java +>- Kotlin +> +>1. +```java +BarcodeScannerConfig config = new BarcodeScannerConfig(); +// Margin left 15%, margin top 30%, margin right 85%, margin bottom 70% +config.setScanRegion(new DSRect(0.15f, 0.25f, 0.85f, 0.65f, true)); +config.setScanLaserVisible(true); +``` +2. +```kotlin +val config = BarcodeScannerConfig().apply { + // Margin left 15%, margin top 30%, margin right 85%, margin bottom 70% + scanRegion = DSRect(0.15f, 0.3f, 0.85f, 0.7f, true) + scanLaserVisible = true +} +``` + +**Related APIs** + +- [`BarcodeScannerConfig`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html) + - [`setScanRegion`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setscanregion) + - [`setScanLaserVisible`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setscanlaservisible) + +### Configure with Foundational APIs + + +>- Java +>- Kotlin +> +>1. +```java +CameraView cameraView = findViewById(R.id.camera_view); +CameraEnhancer mCamera = new CameraEnhancer(cameraView, this); +try { + mCamera.setScanRegion(new DSRect(0.15f, 0.25f, 0.85f, 0.65f, true)); +} catch (CameraEnhancerException e) { + throw new RuntimeException(e); +} +cameraView.setScanLaserVisible(true); +``` +2. +```kotlin +val cameraView = findViewById
+
Barcode Scanner UI Components
+(R.id.camera_view) +val mCamera = CameraEnhancer(this) +mCamera.scanRegion = DSRect(0.15f, 0.25f, 0.85f, 0.65f, true) +cameraView.isScanLaserVisible = true +``` + +**Related APIs** + +- [`CameraEnhancer`]({{ site.dbr_android_api }}camera-enhancer/camera-enhancer.html) + - [`setScanRegion`]({{ site.dbr_android_api }}camera-enhancer/camera-enhancer.html#setscanregion) +- [`CameraView`]({{ site.dce_android }}auxiliary-api/dcecameraview.html) + - [`setScanLaserVisible`]({{ site.dce_android }}auxiliary-api/dcecameraview.html#setscanlaservisible) + +## Buttons + +### Add Buttons with BarcodeScanner APIs + + +>- Java +>- Kotlin +> +>1. +```java +BarcodeScannerConfig config = new BarcodeScannerConfig(); +config.setTorchButtonVisible(true); +config.setCloseButtonVisible(true); +config.setCameraToggleButtonVisible(true); +``` +2. +```kotlin +val config = BarcodeScannerConfig().apply { + torchButtonVisible = true + closeButtonVisible = true + cameraToggleButtonVisible = true +} +``` + +**Related APIs** + +- [`BarcodeScannerConfig`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html) + - [setTorchButtonVisible]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#settorchbuttonvisible) + - [setCloseButtonVisible]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setclosebuttonvisible) + - [setCameraToggleButtonVisible]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setcameratogglebuttonvisible) + +### Add Buttons with Foundational APIs + + +>- Java +>- Kotlin +> +>1. +```java +CameraView cameraView = findViewById(R.id.camera_view); +cameraView.setTorchButtonVisible(true); +cameraView.setCameraToggleButtonVisible(true); +``` +2. +```kotlin +val cameraView = findViewById (R.id.camera_view) +cameraView.torchButtonVisible = true +cameraView.cameraToggleButtonVisible = true +``` + +**Related APIs** + +- [`CameraView`]({{ site.dce_android }}auxiliary-api/dcecameraview.html) + - [setTorchButtonVisible]({{ site.dce_android }}auxiliary-api/dcecameraview.html#settorchbuttonvisible) + - [setCameraToggleButtonVisible]({{ site.dce_android }}auxiliary-api/dcecameraview.html#setcameratogglebuttonvisible) diff --git a/programming/android/user-guide/capabilities/feedback.md b/programming/android/user-guide/capabilities/feedback.md new file mode 100644 index 00000000..90af130a --- /dev/null +++ b/programming/android/user-guide/capabilities/feedback.md @@ -0,0 +1,59 @@ +--- +layout: default-layout +title: Add Scan Feedback for BarcodeScanner - Dynamsoft Barcode Reader for Android +description: Learn how to enable scan feedback for BarcodeScanner on Android, including beep and vibration. +keywords: BarcodeScanner, scanner, Android, feedback, beep, vibration +needAutoGenerateSidebar: true +needGenerateH3Content: true +noTitleIndex: true +--- + +# Add Scan Feedback + +Trigger a beep sound or vibration when a barcode is scanned successfully. + +### Use BarcodeScanner APIs + + +>- Java +>- Kotlin +> +>1. +```java +BarcodeScannerConfig config = new BarcodeScannerConfig(); +config.setBeepEnabled(true); +config.setVibrateEnabled(true); +``` +2. +```kotlin +val config = BarcodeScannerConfig().apply { + isVibrateEnabled = true + isBeepEnabled = true +} +``` + +**Related API** + +- [`isVibrateEnabled`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#isvibrateenabled) +- [`isBeepEnabled`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#isbeepenabled) + +### Use Foundational APIs + + +>- Java +>- Kotlin +> +>1. +```java +Feedback.beep(); +Feedback.vibrate(); +``` +2. +```kotlin +Feedback.beep() +Feedback.vibrate() +``` + +**Related API** + +- [`Feedback`]({{ site.dce_android }}auxiliary-api/dcefeedback.html) diff --git a/programming/android/user-guide/capabilities/init-customized-template.md b/programming/android/user-guide/capabilities/init-customized-template.md new file mode 100644 index 00000000..5f96e457 --- /dev/null +++ b/programming/android/user-guide/capabilities/init-customized-template.md @@ -0,0 +1,66 @@ +--- +layout: default-layout +title: Initialize Customized Templates - Dynamsoft Barcode Reader Android User Guide +description: Learn how to initialize customized templates in the Dynamsoft Barcode Reader Android SDK. +keywords: customized templates, Android, java, kotlin +noTitleIndex: true +needGenerateH3Content: true +needAutoGenerateSidebar: true +--- + +# How to Initialize Customized Templates + +Using a template file is one of the quickest ways to improve BarcodeScanner performance. A template file is a JSON file (or JSON string) that contains a set of algorithm parameter settings. [Contact us](https://www.dynamsoft.com/company/customer-service/#contact) to get a customized template for your scanner. + +## Preparation + +Add a **Templates** folder under your project's assets directory at **src\main\assets\Templates**. Put your JSON file in the **Templates** folder. Here, we use **ReadQRCode.json** as an example. + + ++ +## Initialize with BarcodeScanner APIs + +Specify the template file with `setTemplateFile`. + + +>- Java +>- Kotlin +> +>1. +```java +BarcodeScannerConfig config = new BarcodeScannerConfig(); +config.setTemplateFile("ReadQRCodes.json"); +``` +2. +```kotlin +val config = BarcodeScannerConfig().apply { + templateFile = "ReadQRCodes.json" +} +``` + +**Related APIs** + +- [`setTemplateFile`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#settemplatefile) + +## Initialize with Foundational APIs + + +>- Java +>- Kotlin +> +>1. +```java +CaptureVisionRouter mRouter = new CaptureVisionRouter(); +try { + mRouter.initSettingsFromFile("ReadQRCodes"); +} catch (CaptureVisionRouterException e) { + throw new RuntimeException(e); +} +``` +2. +```kotlin +val mRouter: CaptureVisionRouter? = CaptureVisionRouter() +mRouter?.initSettingsFromFile("ReadQRCodes") +``` diff --git a/programming/android/user-guide/capabilities/read-from-an-image.md b/programming/android/user-guide/capabilities/read-from-an-image.md index 6281544a..7a90bf7d 100644 --- a/programming/android/user-guide/capabilities/read-from-an-image.md +++ b/programming/android/user-guide/capabilities/read-from-an-image.md @@ -1,7 +1,7 @@ --- layout: default-layout -title: Read from an Image - Dynamsoft Barcode Reader for Android User Guide -description: This page explores how to read barcodes from an image with Dynamsoft Barcode Reader Android SDK. +title: Read from an Image - Dynamsoft Barcode Reader Android +description: Learn how to read barcodes from an image using the Dynamsoft Barcode Reader Android SDK. keywords: user guide, read from an image, Android, java, kotlin noTitleIndex: true needGenerateH3Content: true @@ -10,10 +10,13 @@ needAutoGenerateSidebar: true # How to Read Barcodes from an Image +> [!Important] +> Features on this page are only available for the **Foundational APIs**. + > [!Note] -> Reference the [DecodeFromAnImage sample](https://github.com/Dynamsoft/barcode-reader-mobile-samples/tree/main/android/FoundationalAPISamples/DecodeFromAnImage){:target="_blank"} for how to decode from the album. +> Refer to the [DecodeFromAnImage sample](https://github.com/Dynamsoft/barcode-reader-mobile-samples/tree/main/android/FoundationalAPISamples/DecodeFromAnImage){:target="_blank"} for an example of decoding from the photo gallery. -The `capture` methods of `CaptureVisionRouter` class are designed to process a single image. +The `capture` methods of the `CaptureVisionRouter` class are designed to process a single image. ```java CapturedResult capture(String filePath, String templateName) {} @@ -24,31 +27,31 @@ CapturedResult capture(ImageData imageData, String templateName) {} ## Supported Image Types -The following image types are supported: +The following image input types are supported: -1. Image with the file path. -2. Image in memory (file bytes). +1. An image specified by file path. +2. An image in memory (file bytes). 3. `android.graphics.Bitmap` 4. [com.dynamsoft.core.basic_structures.ImageData]({{ site.dcvb_android_api }}core/basic-structures/image-data.html) > [!Note] -> When decoding with a file path, you should input the full file path with the extension name. Supported extensions: ".bmp", ".jpg", ".png", ".gif" or one-page ".tiff". +> When decoding with a file path, provide the full file path, including the extension. Supported extensions are ".bmp", ".jpg", ".png", ".gif", and single-page ".tiff". ## How to Specify Template Name -When using the capture method, a `templateName` is required. You can specify either a preset template or the name a custom template. +When using a `capture` method, `templateName` is required. You can specify either a preset template or a custom template name. ### Use a Preset Template -`EnumPresetTemplate.PT_READ_BARCODES_READ_RATE_FIRST` is suggested for the template name when processing an image. +`EnumPresetTemplate.PT_READ_BARCODES_READ_RATE_FIRST` is recommended when processing an image. ```java CapturedResult capturedResult = mRouter.capture("Your-file-path",EnumPresetTemplate.PT_READ_BARCODES_READ_RATE_FIRST); ``` -### Use Customized Template +### Use a Customized Template -View [Parameters and Settings - Use a Customized Template](parameters-and-settings.md#use-a-customized-template) for details. +For details, see [Parameters and Settings - Use a Customized Template](parameters-and-settings.md#use-a-customized-template). ## Code Snippet @@ -63,8 +66,8 @@ for(BarcodeResultItem barcodeResultItem: barcodeResultItems) } ``` -- `CapturedResult`: The biggest set of image processing results. `DecodedBarcodesResult` is one of the subsets of the `CapturedResult`. -- `DecodedBarcodesResult`: The set of barcode-type results. It contains an array of `BarcodeResultItem` and additional information. -- `BarcodeResultItem`: Object that represents a single decoded barcode. +- `CapturedResult`: The largest set of image processing results. `DecodedBarcodesResult` is one subset of `CapturedResult`. +- `DecodedBarcodesResult`: The set of barcode results. It contains an array of `BarcodeResultItem` objects and additional information. +- `BarcodeResultItem`: An object that represents a single decoded barcode. Read [Understand Barcode Decoding Results](../understand-decoded-barcodes-results.md) for more information. diff --git a/programming/android/user-guide/capabilities/read-from-camera.md b/programming/android/user-guide/capabilities/read-from-camera.md index 4222148e..283669a6 100644 --- a/programming/android/user-guide/capabilities/read-from-camera.md +++ b/programming/android/user-guide/capabilities/read-from-camera.md @@ -1,9 +1,88 @@ --- layout: default-layout -title: Read from camera - Dynamsoft Barcode Reader for Android User Guide -description: This page explores how to read barcodes from camera with Dynamsoft Barcode Reader Android SDK. +title: Read from camera - Dynamsoft Barcode Reader Android +description: Learn how to read barcodes from the camera using the Dynamsoft Barcode Reader Android SDK. keywords: user guide, read from camera, Android, java, kotlin noTitleIndex: true needGenerateH3Content: true needAutoGenerateSidebar: true --- + +# Read from camera + +Follow these three steps to read barcodes from the camera: + +1. Set input +2. Register result receiver +3. Start capturing + +## Set input + +### CameraEnhancer - Dynamsoft Standard Camera Input + +1. Add `CameraView` to your layout. + + ```xml +
++ ``` + +2. Create a `CameraEnhancer` object and bind it to `CameraView`. + + ```java + CameraEnhancer mCamera; + CameraView cameraView = findViewById(R.id.camera_view); + mCamera = new CameraEnhancer(cameraView, this); + ``` + +3. Use `CaptureVisionRouter.setInput` to set the `CameraEnhancer` object as the input source. + + ```java + CaptureVisionRouter mRouter; + mRouter = new CaptureVisionRouter(); + try { + mRouter.setInput(mCamera); + } catch (CaptureVisionRouterException e) { + throw new RuntimeException(e); + } + ``` + +### Other Camera Input + +> Note: +> If you are using CameraX, refer to the [`DecodeWithCameraX`](https://github.com/Dynamsoft/barcode-reader-mobile-samples/tree/main/android/FoundationalAPISamples/DecodeWithCameraX) sample for camera input integration. + +To use another camera source, complete the following steps so the library can process the input: + +1. Receive the camera input. +2. Convert the raw camera input to a `com.dynamsoft.core.basic_structures.ImageData` object. +3. Use `addImageToBuffer` to add the `ImageData` object to the buffer. + +## Result receiver + +Use `CapturedResultReceiver` to receive capture results. The callback is triggered each time an image is processed, regardless of whether a barcode is decoded. + +```java +mRouter.addResultReceiver(new CapturedResultReceiver() { + @Override + public void onDecodedBarcodesReceived(@NonNull DecodedBarcodesResult result) { + } +}); +``` + +## Start capturing + +Use `startCapturing` and `stopCapturing` to control when barcode decoding starts and stops. + +```java +mRouter.startCapturing("ReadBarcodes_Default", new CompletionListener() { + @Override + public void onSuccess() { + } + @Override + public void onFailure(int errorCode, String errorString) { + } +}); +``` diff --git a/programming/android/user-guide/capabilities/read-specific-area.md b/programming/android/user-guide/capabilities/read-specific-area.md new file mode 100644 index 00000000..268e1850 --- /dev/null +++ b/programming/android/user-guide/capabilities/read-specific-area.md @@ -0,0 +1,183 @@ +--- +layout: default-layout +title: Read from a Specific Area - Dynamsoft Barcode Reader Android +description: Learn how to read from a specific area using the Dynamsoft Barcode Reader Android SDK. +keywords: user guide, read specific area, Android, java, kotlin +noTitleIndex: true +needGenerateH3Content: true +needAutoGenerateSidebar: true +--- + +# Read from a Specific Area + +## Set a Scan Region on Camera + +### Work with BarcodeScanner APIs + + +>- Java +>- Kotlin +> +>1. +```java +BarcodeScannerConfig config = new BarcodeScannerConfig(); +// Margin left 15%, margin top 30%, margin right 85%, margin bottom 70% +config.setScanRegion(new DSRect(0.15f, 0.25f, 0.85f, 0.65f, true)); +``` +2. +```kotlin +val config = BarcodeScannerConfig().apply { + // Margin left 15%, margin top 30%, margin right 85%, margin bottom 70% + scanRegion = DSRect(0.15f, 0.3f, 0.85f, 0.7f, true) +} +``` + +**Related APIs** + +- [`BarcodeScannerConfig`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html) + - [`setScanRegion`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setscanregion) + +### Work with Foundational APIs + + +>- Java +>- Kotlin +> +>1. +```java +CameraView cameraView = findViewById(R.id.camera_view); +CameraEnhancer mCamera = new CameraEnhancer(cameraView, this); +try { + mCamera.setScanRegion(new DSRect(0.15f, 0.25f, 0.85f, 0.65f, true)); +} catch (CameraEnhancerException e) { + throw new RuntimeException(e); +} +``` +2. +```kotlin +val cameraView = findViewById (R.id.camera_view) +val mCamera = CameraEnhancer(this) +mCamera.scanRegion = DSRect(0.15f, 0.25f, 0.85f, 0.65f, true) +``` + +**Related APIs** + +- [`CameraEnhancer`]({{ site.dbr_android_api }}camera-enhancer/camera-enhancer.html) + - [`setScanRegion`]({{ site.dbr_android_api }}camera-enhancer/camera-enhancer.html#setscanregion) + +## Set an ROI via SimplifiedCaptureVisionSettings + +> [!Important] +> This feature is only available for the **Foundational APIs**. + + +>- Java +>- Kotlin +> +>1. +```java +CaptureVisionRouter mRouter = new CaptureVisionRouter(); +try { + SimplifiedCaptureVisionSettings captureVisionSettings = mRouter.getSimplifiedSettings(EnumPresetTemplate.PT_READ_BARCODES); + Quadrilateral roiQuad = new Quadrilateral(); + roiQuad.points[0] = new Point(15,30); + roiQuad.points[1] = new Point(85,30); + roiQuad.points[2] = new Point(85,70); + roiQuad.points[3] = new Point(15,70); + captureVisionSettings.roi = roiQuad; + captureVisionSettings.roiMeasuredInPercentage = true; + mRouter.updateSettings(EnumPresetTemplate.PT_READ_BARCODES, captureVisionSettings); +} catch (CaptureVisionRouterException e) { + e.printStackTrace(); +} +``` +2. +```kotlin +val mRouter: CaptureVisionRouter? = CaptureVisionRouter() +try { + val captureVisionSettings = mRouter.getSimplifiedSettings(EnumPresetTemplate.PT_READ_BARCODES) + val roiQuad = Quadrilateral() + roiQuad.points[0] = Point(15, 30) + roiQuad.points[1] = Point(85, 30) + roiQuad.points[2] = Point(85, 70) + roiQuad.points[3] = Point(15, 70) + captureVisionSettings.roi = roiQuad + captureVisionSettings.roiMeasuredInPercentage = true + mRouter.updateSettings(EnumPresetTemplate.PT_READ_BARCODES, captureVisionSettings) +} catch (e: CaptureVisionRouterException) { + e.printStackTrace() +} +``` + +## Set ROIs in Customized Template + +Define a single ROI: + +```json +{ + "CaptureVisionTemplates": [ + { + "Name" : "CV_0", + "ImageROIProcessingNameArray": ["barcode-decoding-roi-1" ] + } + ], + "TargetROIDefOptions" : [ + { + "Name" : "barcode-decoding-roi-1", + "TaskSettingNameArray": ["barcode-decoding-task-1"], + "Location": + { + "Offset": { + "MeasuredByPercentage" : 1, + "FirstPoint" : [ 15, 30 ], + "SecondPoint" : [ 85, 30 ], + "ThirdPoint" : [ 85, 70 ], + "FourthPoint" : [ 15, 70 ], + } + } + } + ] +} +``` + +You can define multiple ROIs in `TargetROIDefOptions`. For each ROI, you can assign a different task or reuse the same task. + +```json +{ + "CaptureVisionTemplates": [ + { + "Name" : "CV_0", + "ImageROIProcessingNameArray": ["barcode-decoding-roi-1","barcode-decoding-roi-2" ] + } + ], + "TargetROIDefOptions" : [ + { + "Name" : "barcode-decoding-roi-1", + "TaskSettingNameArray": ["barcode-decoding-task-1"], + "Location": + { + "Offset": { + "MeasuredByPercentage" : 1, + "FirstPoint" : [ 15, 20 ], + "SecondPoint" : [ 85, 40 ], + "ThirdPoint" : [ 85, 40 ], + "FourthPoint" : [ 15, 20 ] + } + } + },{ + "Name" : "barcode-decoding-roi-2", + "TaskSettingNameArray": ["barcode-decoding-task-1"], + "Location": + { + "Offset": { + "MeasuredByPercentage" : 1, + "FirstPoint" : [ 15, 60 ], + "SecondPoint" : [ 85, 80 ], + "ThirdPoint" : [ 85, 80 ], + "FourthPoint" : [ 15, 60 ] + } + } + } + ] +} +``` diff --git a/programming/android/user-guide/capabilities/single-multiple.md b/programming/android/user-guide/capabilities/single-multiple.md new file mode 100644 index 00000000..3bf2f4a1 --- /dev/null +++ b/programming/android/user-guide/capabilities/single-multiple.md @@ -0,0 +1,135 @@ +--- +layout: default-layout +title: Scan Multiple Barcodes with BarcodeScanner - Dynamsoft Barcode Reader for Android +description: Use BarcodeScanner Android edition to scan multiple barcodes +keywords: Multiple barcodes, Android +needAutoGenerateSidebar: true +needGenerateH3Content: true +noTitleIndex: true +--- + +# Single & Multiple Barcode Scanning + +This article explains how to switch between single-barcode scanning mode and multi-barcode scanning mode. + +## Work with BarcodeScanner APIs + +### How to Switch Scanning Modes + +Use the `setScanningMode` method to switch between single-barcode and multi-barcode scanning modes. + +- `SM_MULTIPLE`: Multi-barcode scanning mode. +- `SM_SINGLE`: (Default) Single-barcode scanning mode. + +**Code Snippet** + +```java +BarcodeScannerConfig config = new BarcodeScannerConfig(); +config.setScanningMode(EnumScanningMode.SM_MULTIPLE); +``` + +### Configure the Auto-Stop Conditions + +For multi-barcode scanning, there are two automatic stop conditions: + +- The number of successfully decoded barcodes reaches the `expectedBarcodesCount`. +- There are no new decoding results for N consecutive frames. The value of N can be set using `setMaxConsecutiveStableFramesToExit`. + +For example, apply the following settings: + +```java +BarcodeScannerConfig config = new BarcodeScannerConfig(); +config.setScanningMode(EnumScanningMode.SM_MULTIPLE); +config.setExpectedBarcodesCount(10); +config.setMaxConsecutiveStableFramesToExit(15); +``` + +If at least 10 barcodes are decoded, scanning stops. Otherwise, scanning continues for up to 15 consecutive stable frames. If no new decoding results are found within those 15 frames, scanning stops. + +**Related APIs** + +- [`setScanningMode`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setscanningmode) +- [`setExpectedBarcodesCount`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setexpectedbarcodescount) +- [`setMaxConsecutiveStableFramesToExit`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setmaxconsecutivestableframestoexit) + +## Work with Foundational APIs + +### Configure Expected Barcodes Count + +- `expectedBarcodesCount` = 1: Scan a single barcode. +- `expectedBarcodesCount` = 0: Allows the library to return more than one result, but it does not aggressively optimize for decoding multiple barcodes. +- `expectedBarcodesCount` = 999 or any other number: Makes every effort to decode up to the specified number of barcodes, when possible. + + +>- Java +>- Kotlin +> +>1. +```java +CaptureVisionRouter mRouter; +mRouter = new CaptureVisionRouter(); +try { + SimplifiedCaptureVisionSettings simplifiedCaptureVisionSettings = mRouter.getSimplifiedSettings(EnumPresetTemplate.PT_READ_BARCODES); + SimplifiedBarcodeReaderSettings simplifiedBarcodeReaderSettings = simplifiedCaptureVisionSettings.barcodeSettings; + simplifiedBarcodeReaderSettings.expectedBarcodesCount = 1; + mRouter.updateSettings(EnumPresetTemplate.PT_READ_BARCODES, simplifiedCaptureVisionSettings); +} catch (CaptureVisionRouterException e) { + throw new RuntimeException(e); +} +``` +2. +```kotlin +val mRouter: CaptureVisionRouter? = CaptureVisionRouter() +try { + val simplifiedCaptureVisionSettings = mRouter?.getSimplifiedSettings(EnumPresetTemplate.PT_READ_BARCODES) + val simplifiedBarcodeReaderSettings = simplifiedCaptureVisionSettings?.barcodeSettings + simplifiedBarcodeReaderSettings.expectedBarcodesCount = 1 + mRouter?.updateSettings(EnumPresetTemplate.PT_READ_BARCODES, simplifiedCaptureVisionSettings) +} catch (e: CaptureVisionRouterException) { + throw RuntimeException(e) +} +``` + +**Related APIs** + +- [`simplifiedCaptureVisionSettings`]({{ site.dcvb_android_api }}capture-vision-router/auxiliary-classes/simplified-capture-vision-settings.html) +- [`simplifiedBarcodeReaderSettings`]({{ site.dbr_android_api }}simplified-barcode-reader-settings.html) + +## Comparisons + +If you are looking for a solution to scan large batches of barcodes, refer to [`BatchBarcodeScanner`](https://www.dynamsoft.com/use-cases/batch-barcode-scanning/){:target="_blank"}. `BatchBarcodeScanner` is much more capable of large-volume barcode scanning and provides a highly interactive UI for previewing, editing, saving, reusing, and sharing results. + + + +
diff --git a/programming/android/user-guide/capabilities/zoom-control.md b/programming/android/user-guide/capabilities/zoom-control.md new file mode 100644 index 00000000..195022f1 --- /dev/null +++ b/programming/android/user-guide/capabilities/zoom-control.md @@ -0,0 +1,117 @@ +--- +layout: default-layout +title: Zoom Control for BarcodeScanner - Dynamsoft Barcode Reader for Android +description: Learn how to configure zoom control for BarcodeScanner on Android, including auto-zoom and zoom factor. +keywords: BarcodeScanner, scanner, Android, auto-zoom, zoom +needAutoGenerateSidebar: true +needGenerateH3Content: true +noTitleIndex: true +--- + +# Zoom Control + +Zoom control is commonly used when processing small barcodes or scanning from a long distance. There are two zoom control features: + +- Auto-zoom: Lets the library determine whether to zoom in. +- Zoom factor: Lets you set the zoom factor directly. This is commonly used when focusing on small barcodes. + +## Auto Zoom + +Enable auto-zoom so the camera can zoom in automatically. + ++ + ++ BarcodeScanner Single Mode +BarcodeScanner Multi Mode +BatchBarcodeScanner ++ +Dependencies +DynamsoftBarcodeReaderBundle +DynamsoftBarcodeReaderBundle +DynamsoftBatchBarcodeReaderBundle ++ +Scan Ability +Decodes at least one barcode available in the latest frame. +Decodes all barcodes available in the latest frame. +Decodes all barcodes available in the latest frame (TTL Overlap Mode) +
or
decodes all barcodes available in the first frame (TTS Overlap Mode)
or
decodes all barcodes that appear during capture (Panorama Mode).+ +Result +Always returns one barcode result. If more than one barcode is decoded, users are asked to select one. +All decoded barcodes +All decoded barcodes, plus a PanoramicImage that highlights all of them. ++ +Result Editor +Not available +Not available +Supports the following operations +
1. Extend the current result with all available image sources.
2. Manually add new results or edit existing results.
3. Save to history.
4. Export as files (.png, .csv, etc.).++ +### Use BarcodeScanner APIs + + +>- Java +>- Kotlin +> +>1. +```java +BarcodeScannerConfig config = new BarcodeScannerConfig(); +config.setAutoZoomEnabled(true); +``` +2. +```kotlin +val config = BarcodeScannerConfig().apply { + isAutoZoomEnabled = true +} +``` + +**Related API** + +- [`setAutoZoomEnabled`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setautozoomenabled) + +### Use Foundational APIs + + +>- Java +>- Kotlin +> +>1. +```java +CameraEnhancer mCamera = new CameraEnhancer(this); +try { + mCamera.enableEnhancedFeatures(EnumEnhancerFeatures.EF_AUTO_ZOOM); +} catch (CameraEnhancerException e) { + throw new RuntimeException(e); +} +``` +2. +```kotlin +val mCamera = CameraEnhancer(this) +mCamera.enableEnhancedFeatures(EnumEnhancerFeatures.EF_AUTO_ZOOM) +``` + +**Related API** + +- [`enableEnhancedFeatures`]({{ site.dce_android }}primary-api/camera-enhancer.html#enableenhancedfeatures) + +## Zoom Factor + +### Use BarcodeScanner APIs + + +>- Java +>- Kotlin +> +>1. +```java +BarcodeScannerConfig config = new BarcodeScannerConfig(); +config.setZoomFactor(2.0f); +``` +2. +```kotlin +val config = BarcodeScannerConfig().apply { + zoomFactor = 2.0f +} +``` + +**Related API** + +- [`setZoomFactor`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setzoomfactor) + +### Use Foundational APIs + + +>- Java +>- Kotlin +> +>1. +```java +CameraEnhancer mCamera = new CameraEnhancer(this); +mCamera.setZoomFactor(2.0f); +``` +2. +```kotlin +val mCamera = CameraEnhancer(this) +mCamera.zoomFactor = 2.0f +``` + +**Related API** + +- [`setZoomFactor`]({{ site.dce_android }}primary-api/camera-enhancer.html#setzoomfactor) diff --git a/programming/android/user-guide/concept/barcode-format.md b/programming/android/user-guide/concept/barcode-format.md index b667426b..76c94d84 100644 --- a/programming/android/user-guide/concept/barcode-format.md +++ b/programming/android/user-guide/concept/barcode-format.md @@ -1,7 +1,7 @@ --- layout: default-layout -title: Barcode Formats - Dynamsoft Barcode Reader for Android User Guide -description: This page introduces the barcode format configuration feature of Dynamsoft Barcode Reader Android SDK. +title: Barcode Formats - Dynamsoft Barcode Reader Android +description: Learn how barcode format configuration affects performance and accuracy in the Dynamsoft Barcode Reader Android SDK. keywords: barcode formats, Android, java, kotlin noTitleIndex: true needGenerateH3Content: true @@ -12,34 +12,34 @@ needAutoGenerateSidebar: true The Dynamsoft Barcode Reader SDK is designed to recognize different types of barcodes, including linear barcodes, 2-dimensional barcodes such as QR Code, PDF417, DataMatrix, MaxiCode, and Aztec Code, DataBar, GS1 Composite symbologies, Pharmacode, Patch Code, and various types of postal codes. -## How Barcode Format Affects the Decoding Process +## How Barcode Formats Affect the Decoding Process During decoding, the SDK attempts to match the input image against all enabled barcode formats. Each format represents a distinct decoding logic and structural rule set. Enabling more formats means: -- More decoding branches are evaluated -- More pattern checks are performed -- Higher chance of cross-format interpretation in edge cases +- More decoding branches are evaluated. +- More pattern checks are performed. +- A higher chance of cross-format interpretation in edge cases. This makes format configuration an important factor in both performance and accuracy. ## Why Configure Barcode Formats? -1. Improve the speed +1. Improve speed - Fewer enabled formats reduce the number of decoding attempts per frame or image. 2. Reduce misreads - Similar symbologies (especially among 1D formats) may produce cross-decoding results when multiple formats are enabled. -3. Align with license capability +3. Align with license capabilities - Some licenses enable only a subset of formats. ## Supported Formats -- See the introduction of [supported barcode formats](https://www.dynamsoft.com/barcode-reader/barcode-types/){:target="_blank"} +- See an introduction to [supported barcode formats](https://www.dynamsoft.com/barcode-reader/barcode-types/){:target="_blank"}. - View the full list in the enumeration [`EnumBarcodeFormat`]({{ site.dbr_android_api }}enum/barcode-format.html). ## Next Step -- [How to Configure Barcode Formats]({{ site.android }}user-guide/capabilities/config-barcode-format.html) +- [How to Configure Barcode Formats]({{ site.android }}user-guide/capabilities/barcode-formats.html) diff --git a/programming/android/user-guide/concept/parameters-and-templates.md b/programming/android/user-guide/concept/parameters-and-templates.md index c9db0ef5..218063b2 100644 --- a/programming/android/user-guide/concept/parameters-and-templates.md +++ b/programming/android/user-guide/concept/parameters-and-templates.md @@ -1,7 +1,7 @@ --- layout: default-layout -title: Parameters & Settings - Dynamsoft Barcode Reader for Android User Guide -description: This page explores how to use the parameters and settings with Dynamsoft Barcode Reader Android SDK. +title: Parameters & Settings - Dynamsoft Barcode Reader Android +description: Learn how to use parameters, settings, and templates in the Dynamsoft Barcode Reader Android SDK. keywords: user guide, parameters, settings, Android, java, kotlin noTitleIndex: true needGenerateH3Content: true @@ -10,17 +10,17 @@ needAutoGenerateSidebar: true # Parameters, Settings & Templates -- `Parameteres`: Algorithm `parameters` that determines how to process the images. -- `Settings`: APIs for you to quickly access the `parameters`. +- `Parameters`: Algorithm `parameters` that determine how images are processed. +- `Settings`: APIs that let you quickly access `parameters`. - `Templates`: JSON objects that can define all available `parameters`. - `Preset Templates`: Quick-start templates. Available via `EnumPresetTemplate`. - `Customized Templates`: Customized templates in a JSON file. -### When to use Settings +### When to Use Settings -Settings are intergated under `SimplifiedCaptureVisionSettings`, which is a subset of the parameter template. Simple and common parameters are available in `SimplifiedCaptureVisionSettings` so that you can quickly access the parameters. +Settings are integrated under `SimplifiedCaptureVisionSettings`, which is a subset of the parameter template. Commonly used parameters are exposed in `SimplifiedCaptureVisionSettings` so you can access them quickly. -Available settings: +Available setting examples: - Barcode formats - Expected barcodes count @@ -30,108 +30,16 @@ Available settings: Generally, settings are used together with `Preset Templates`. -Common Steps: +Common steps: 1. Select a `Preset Template`. -2. Minor optimization with `SimplifiedCaptureVisionSettings`. +2. Apply minor optimizations with `SimplifiedCaptureVisionSettings`. -### When to use a Customized Templates +### When to Use a Customized Template -If you are not satisfied with the curent performance, you can contact us for a fully customization. Then, you receive a customized template. +If you are not satisfied with the current performance, you can contact us for full customization. You will then receive a customized template. -### Next Step +### Next Steps - [`SimplifiedCaptureVisionSettings`]({{ site.dcvb_android_api }}capture-vision-router/simplified-capture-vision-settings.html) API references - How to use customized templates - [initSettingsFromFile]({{ site.dcvb_android_api }}capture-vision-router/settings.html#initsettingsfromfile) - - - diff --git a/programming/android/user-guide/understand-barcode-results.md b/programming/android/user-guide/concept/understand-barcode-results.md similarity index 74% rename from programming/android/user-guide/understand-barcode-results.md rename to programming/android/user-guide/concept/understand-barcode-results.md index f6900cb8..a0f4d611 100644 --- a/programming/android/user-guide/understand-barcode-results.md +++ b/programming/android/user-guide/concept/understand-barcode-results.md @@ -1,7 +1,7 @@ --- layout: default-layout title: Understand Barcode Results - Dynamsoft Barcode Reader for Android -description: Understand the structure of the barcode decoding results of Dynamsoft Barcode Reader Android. +description: Understand the structure of barcode decoding results in Dynamsoft Barcode Reader Android. keywords: understand results, Android needAutoGenerateSidebar: true needGenerateH3Content: true @@ -10,14 +10,14 @@ noTitleIndex: true # Understanding Barcode Results -`DecodedBarcodesResult` is the barcode-type result returned by the Dynamsoft Barcode Reader SDK. It represents all barcode-related information captured from a single image or video frame. +`DecodedBarcodesResult` is the barcode result type returned by the Dynamsoft Barcode Reader SDK. It represents all barcode-related information captured from a single image or video frame. It contains: - All decoded barcodes. - Metadata about the original image. - Error information when a failure occurs. -- A rotation transformation matrix if the original image includes rotation info. +- A rotation transformation matrix if the original image includes rotation information. ## How to Use @@ -26,24 +26,12 @@ It contains: Error messages are typically caused by: - The barcode reading task is not working properly. -- The operation timeout. - -```java -mRouter.addResultReceiver(new CapturedResultReceiver() { - @Override - public void onDecodedBarcodesReceived(@NonNull DecodedBarcodesResult result) { - if (result.getErrorCode()!= EnumErrorCode.EC_OK) - { - // Handle the error. - } - } -}); -``` +- The operation times out. > [!Note] > You might still receive barcode results even when the error message is not empty. -### Access decoded barcodes +### Access Decoded Barcodes Each decoded barcode is a `BarcodeResultItem` from `result.getBarcodes`. The following is an example: @@ -74,22 +62,13 @@ Each decoded barcode is a `BarcodeResultItem` from `result.getBarcodes`. The fol ### Access the Original Image -The original image is not returned by default. In `onDecodedBarcodesReceived`, you receive the original image `HashId`. Use it to fetch the image when needed. - -**Code Snippet** +The original image is not returned by default. In `onDecodedBarcodesReceived`, you receive the original image `HashId`, which you can use to fetch the image when needed. ```java -mRouter.addResultReceiver(new CapturedResultReceiver() { - @Override - public void onDecodedBarcodesReceived(@NonNull DecodedBarcodesResult result) { - ImageData originalImage = mRouter.getIntermediateResultManager().getOriginalImage(result.getOriginalImageHashId()); - } -}); +// Use originalImage within the lifecycle of each `onDecodedBarcodesReceived` callback. Otherwise, it may be released or replaced by a newer image. +ImageData originalImage = mRouter.getIntermediateResultManager().getOriginalImage(result.getOriginalImageHashId()); ``` -> [!Note] -> Use `originalImage` within the lifecycle of each `onDecodedBarcodesReceived` callback. Otherwise, it may be released or replaced by a newer image. - **Related APIs** - [`getOriginalImageHashId`]({{ site.dbr_android_api }}decoded-barcodes-result.html) diff --git a/programming/android/user-guide/understand-barcode-scan-results.md b/programming/android/user-guide/concept/understand-barcode-scan-results.md similarity index 85% rename from programming/android/user-guide/understand-barcode-scan-results.md rename to programming/android/user-guide/concept/understand-barcode-scan-results.md index f9f24dcf..737d64c0 100644 --- a/programming/android/user-guide/understand-barcode-scan-results.md +++ b/programming/android/user-guide/concept/understand-barcode-scan-results.md @@ -1,7 +1,7 @@ --- layout: default-layout title: Understand Barcode Results - Dynamsoft Barcode Reader for Android -description: Understand the structure of the barcode decoding results of Dynamsoft Barcode Reader Android. +description: Understand the structure of barcode scan results in Dynamsoft Barcode Reader Android. keywords: understand results, Android needAutoGenerateSidebar: true needGenerateH3Content: true @@ -10,14 +10,13 @@ noTitleIndex: true # Understanding Barcode Scan Results -`BarcodeScanResult` is the object returned by the `onScanResult` callback when a scanning session finishes, is canceled, or encounters an error. Every `BarcodeScanResult` contains a `resultStatus` and a list of barcodes. -The barcode list is non-empty only when `resultStatus` is `RS_FINISHED`. +`BarcodeScanResult` is returned by the `onScanResult` callback when a scanning session finishes, is canceled, or encounters an error. Each `BarcodeScanResult` contains a `resultStatus` and a list of barcodes. The barcode list is non-empty only when `resultStatus` is `RS_FINISHED`. ```java launcher = registerForActivityResult( new BarcodeScannerActivity.ResultContract(), result -> { - // User code for using the the scan result. + // User code for using the scan result. } ); ``` @@ -36,7 +35,7 @@ Always check `resultStatus` before accessing the decoded barcodes. - You configured an invalid or expired license via `setLicense`. - You configured an invalid template via `setTemplateFile`. -### Access decoded barcodes +### Access Decoded Barcodes Each decoded barcode is a `BarcodeResultItem` from `result.getBarcodes()`. The following is an example of a `BarcodeResultItem`: diff --git a/programming/android/user-guide/explore-features/index.md b/programming/android/user-guide/explore-features/index.md index bb2f0360..56c904e5 100644 --- a/programming/android/user-guide/explore-features/index.md +++ b/programming/android/user-guide/explore-features/index.md @@ -1,6 +1,6 @@ --- layout: default-layout -title: Explore Features - Dynamsoft Barcode Reader for Android User Guide +title: Explore Features - Dynamsoft Barcode Reader Android description: This page lists the topics to explore the features of Dynamsoft Barcode Reader Android SDK. keywords: user guide, explore features, Android, java, kotlin breadcrumbText: Explore Features diff --git a/programming/android/user-guide/scanner-barcode-formats.md b/programming/android/user-guide/scanner-barcode-formats.md index 66ca13dd..e59cfb9f 100644 --- a/programming/android/user-guide/scanner-barcode-formats.md +++ b/programming/android/user-guide/scanner-barcode-formats.md @@ -1,35 +1,113 @@ --- layout: default-layout -title: Specify barcode formats for BarcodeScanner - Dynamsoft Barcode Reader for Android -description: Customize the UI of BarcodeScanner on Android platform. -keywords: BarcodeScanner, scanner, Android, barcode formats -needAutoGenerateSidebar: true -needGenerateH3Content: true +title: Barcode Formats - Dynamsoft Barcode Reader Android +description: Learn how to configure barcode formats in the Dynamsoft Barcode Reader Android SDK. +keywords: barcode formats, Android, java, kotlin noTitleIndex: true +needGenerateH3Content: true +needAutoGenerateSidebar: true --- -# Specify Barcode Formats +# Configure Barcode Formats + +There are two ways to configure barcode formats: + +- Configure formats in code. +- Configure formats together with other settings in the template. -Set the supported barcode format is always the first step when configuring the BarcodeScanner. You can specify the barcode format via the method `setBarcodeFormats`. +## Configure Formats in Your Code -**Code Snippet** +Specify barcode formats using a combined value of [`EnumBarcodeFormat`]({{ site.dbr_android_api }}enum/barcode-format.html). + +- Use bitwise OR (`|`) to combine multiple formats. +- `EnumBarcodeFormat.BF_DEFAULT` includes all common formats (`BF_ONED`, `BF_GS1_DATABAR`, `BF_PDF417`, `BF_QR_CODE`, `BF_DATAMATRIX`, `BF_AZTEC`, `BF_MAXICODE`, `BF_MICRO_QR`, `BF_MICRO_PDF417`, and `BF_GS1_COMPOSITE`). +- Use `EnumBarcodeFormat.BF_ALL` to enable all supported formats. +- Use group values like `EnumBarcodeFormat.BF_ONED` when appropriate. + +### BarcodeScanner API + +- `BarcodeScannerConfig.setBarcodeFormats(long format)` + +Example: - ->- Java ->- Kotlin -> ->1. ```java BarcodeScannerConfig config = new BarcodeScannerConfig(); -config.setBarcodeFormats(EnumBarcodeFormat.BF_ONED | EnumBarcodeFormat.BF_QR_CODE); +// QR Code + DataMatrix +config.setBarcodeFormats(EnumBarcodeFormat.BF_QR_CODE | EnumBarcodeFormat.BF_DATAMATRIX); ``` -2. -```kotlin -val config = BarcodeScannerConfig().apply { - barcodeFormats = EnumBarcodeFormat.BF_ONED or EnumBarcodeFormat.BF_QR_CODE + +### Foundational API + +- `SimplifiedCaptureVisionSettings.barcodeSettings.barcodeFormatIds` + +Example: + +```java +try { + SimplifiedCaptureVisionSettings settings = mRouter.getSimplifiedSettings(EnumPresetTemplate.PT_READ_BARCODES); + SimplifiedBarcodeReaderSettings barcodeSettings = settings.barcodeSettings; + // Only read QR Code. + barcodeSettings.barcodeFormatIds = EnumBarcodeFormat.BF_QR_CODE | EnumBarcodeFormat.BF_DATAMATRIX; + mRouter.updateSettings(EnumPresetTemplate.PT_READ_BARCODES, settings); +} catch (CaptureVisionRouterException e) { + throw new RuntimeException(e); +} +``` + +> [!Note] +> If you are already using a customized template, you usually do not need to specify formats again in code. See [Use a Customized Template](parameters-and-templates.md#use-a-customized-template) for details. + +## Configure Formats in a Template + +Barcode formats are specified in `BarcodeFormatIds` under `BarcodeReaderTaskSettingOptions`. For example: + +```json +{ + "CaptureVisionTemplates": [ + { + "ImageROIProcessingNameArray": [ "ROI_2D" ], + "Name": "ReadCommon2D", + } + ], + "TargetROIDefOptions": [ + { + "Name": "ROI_2D", + "TaskSettingNameArray": [ "Task_2D" ] + } + ], + "BarcodeReaderTaskSettingOptions": [ + { + "Name": "Task_2D", + "BarcodeFormatIds": [ "BF_QR_CODE", "BF_DATAMATRIX", "BF_PDF417", "BF_MAXICODE" ], + "SectionArray": [ + { + "Section": "ST_BARCODE_LOCALIZATION", + "ImageParameterName": "ip" + }, + { + "Section": "ST_BARCODE_DECODING", + "ImageParameterName": "ip" + } + ] + } + ], + "ImageParameterOptions": [ + { + "Name": "ip" + } + ] } ``` -**Related APIs** +For common formats, you can download and use the preset templates below: -- [`setBarcodeFormats`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setbarcodeformats) +| Barcode Format(s) | Template | +| ----------------- | -------- | +| EAN13, EAN8, UPC_A, UPC_E, GS1 Databar | [ReadOneDRetail.json](https://github.com/Dynamsoft/barcode-reader-mobile-samples/blob/main/android/BarcodeScannerAPISamples/ScenarioOrientedSamples/src/main/assets/Templates/ReadOneDRetail.json) | +| Code128, Code39, ITF, Codabar, MSI Code | [ReadOneDIndustrial.json](https://github.com/Dynamsoft/barcode-reader-mobile-samples/blob/main/android/BarcodeScannerAPISamples/ScenarioOrientedSamples/src/main/assets/Templates/ReadOneDIndustrial.json) | +| QR Code | [ReadQR.json](https://github.com/Dynamsoft/barcode-reader-mobile-samples/blob/main/android/BarcodeScannerAPISamples/ScenarioOrientedSamples/src/main/assets/Templates/ReadQR.json) | +| Data Matrix | [ReadDataMatrix.json](https://github.com/Dynamsoft/barcode-reader-mobile-samples/blob/main/android/BarcodeScannerAPISamples/ScenarioOrientedSamples/src/main/assets/Templates/ReadDataMatrix.json) | +| PDF417 | [ReadPDF417.json](https://github.com/Dynamsoft/barcode-reader-mobile-samples/blob/main/android/BarcodeScannerAPISamples/ScenarioOrientedSamples/src/main/assets/Templates/ReadPDF417.json) | +| Aztec | [ReadAztec.json](https://github.com/Dynamsoft/barcode-reader-mobile-samples/blob/main/android/BarcodeScannerAPISamples/ScenarioOrientedSamples/src/main/assets/Templates/ReadAztec.json) | +| QR Code, Data Matrix, PDF417 | [ReadCommon2D.json](https://github.com/Dynamsoft/barcode-reader-mobile-samples/blob/main/android/BarcodeScannerAPISamples/ScenarioOrientedSamples/src/main/assets/Templates/ReadCommon2D.json) | +| DotCode | [ReadDotCode.json](https://github.com/Dynamsoft/barcode-reader-mobile-samples/blob/main/android/BarcodeScannerAPISamples/ScenarioOrientedSamples/src/main/assets/Templates/ReadDotCode.json) | diff --git a/programming/android/user-guide/scanner-customize-ui.md b/programming/android/user-guide/scanner-customize-ui.md index 68c4da0a..2b768080 100644 --- a/programming/android/user-guide/scanner-customize-ui.md +++ b/programming/android/user-guide/scanner-customize-ui.md @@ -10,6 +10,14 @@ noTitleIndex: true # Configure the UI Elements +| Available UI Element| +| ------------------- | +| Scan region | +| Scan Laser | +| Torch button | +| Camera toggle button | +| Close button (BarcodeScanner API only) | + BarcodeScanner provides a set of UI elements that can be easily customized.
+
Auto Zoom
+@@ -19,8 +27,12 @@ BarcodeScanner provides a set of UI elements that can be easily customized. - Close button: Stop barcode scanning and go back to the previous activity. - Scan Region: Set a region of interest so that the algorithm focus on this region only. It can sharpenly improve the processing speed. For some special barcode types like DotCode the scan region improves the read-rate as well. -- Torch button: A clickable button that can turn on/off the torch. - Scan Laser: A line that moving up and down. Its moving area is limited in the scan region. +- Torch button: A clickable button that can turn on/off the torch. + +## Scan Region & Scan Laser + +### Configure with BarcodeScanner APIs >- Java @@ -31,27 +43,107 @@ BarcodeScanner provides a set of UI elements that can be easily customized. BarcodeScannerConfig config = new BarcodeScannerConfig(); // Margin left 15%, margin top 30%, margin right 85%, margin bottom 70% config.setScanRegion(new DSRect(0.15f, 0.25f, 0.85f, 0.65f, true)); -config.setTorchButtonVisible(true); -config.setCloseButtonVisible(true); config.setScanLaserVisible(true); -config.setCameraToggleButtonVisible(true); ``` 2. ```kotlin val config = BarcodeScannerConfig().apply { // Margin left 15%, margin top 30%, margin right 85%, margin bottom 70% scanRegion = DSRect(0.15f, 0.3f, 0.85f, 0.7f, true) + scanLaserVisible = true +} +``` + +**Related APIs** + +- [`BarcodeScannerConfig`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html) + - [`setScanRegion`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setscanregion) + - [`setScanLaserVisible`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setscanlaservisible) + +### Configure with Foundational APIs + + +>- Java +>- Kotlin +> +>1. +```java +CameraView cameraView = findViewById(R.id.camera_view); +CameraEnhancer mCamera = new CameraEnhancer(cameraView, this); +try { + mCamera.setScanRegion(new DSRect(0.15f, 0.25f, 0.85f, 0.65f, true)); +} catch (CameraEnhancerException e) { + throw new RuntimeException(e); +} +cameraView.setScanLaserVisible(true); +``` +2. +```kotlin +val cameraView = findViewById(R.id.camera_view) +val mCamera = CameraEnhancer(this) +mCamera.scanRegion = DSRect(0.15f, 0.25f, 0.85f, 0.65f, true) +cameraView.isScanLaserVisible = true +``` + +**Related APIs** + +- [`CameraEnhancer`]({{ site.dbr_android_api }}camera-enhancer/camera-enhancer.html) + - [`setScanRegion`]({{ site.dbr_android_api }}camera-enhancer/camera-enhancer.html#setscanregion) +- [`CameraView`]({{ site.dce_android }}auxiliary-api/dcecameraview.html) + - [`setScanLaserVisible`]({{ site.dce_android }}auxiliary-api/dcecameraview.html#setscanlaservisible) + +## Buttons + +### Add Buttons with BarcodeScanner APIs + + +>- Java +>- Kotlin +> +>1. +```java +BarcodeScannerConfig config = new BarcodeScannerConfig(); +config.setTorchButtonVisible(true); +config.setCloseButtonVisible(true); +config.setCameraToggleButtonVisible(true); +``` +2. +```kotlin +val config = BarcodeScannerConfig().apply { torchButtonVisible = true closeButtonVisible = true - scanLaserVisible = true cameraToggleButtonVisible = true } ``` **Related APIs** -- [`setScanRegion`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setscanregion) -- [`setTorchButtonVisible`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#settorchbuttonvisible) -- [`setScanLaserVisible`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setscanlaservisible) -- [`setCloseButtonVisible`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setclosebuttonvisible) -- [`setCameraToggleButtonVisible`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setcameratogglebuttonvisible) +- [`BarcodeScannerConfig`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html) + - [setTorchButtonVisible]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#settorchbuttonvisible) + - [setCloseButtonVisible]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setclosebuttonvisible) + - [setCameraToggleButtonVisible]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setcameratogglebuttonvisible) + +### Add Buttons with Foundational APIs + + +>- Java +>- Kotlin +> +>1. +```java +CameraView cameraView = findViewById(R.id.camera_view); +cameraView.setTorchButtonVisible(true); +cameraView.setCameraToggleButtonVisible(true); +``` +2. +```kotlin +val cameraView = findViewById (R.id.camera_view) +cameraView.torchButtonVisible = true +cameraView.cameraToggleButtonVisible = true +``` + +**Related APIs** + +- [`cameraView`]({{ site.dce_android }}auxiliary-api/dcecameraview.html) + - [setTorchButtonVisible]({{ site.dce_android }}auxiliary-api/dcecameraview.html#settorchbuttonvisible) + - [setCameraToggleButtonVisible]({{ site.dce_android }}auxiliary-api/dcecameraview.html#setcameratogglebuttonvisible) diff --git a/programming/android/user-guide/scanner-improve-performance.md b/programming/android/user-guide/scanner-improve-performance.md index 0d401bb2..2336eaf4 100644 --- a/programming/android/user-guide/scanner-improve-performance.md +++ b/programming/android/user-guide/scanner-improve-performance.md @@ -6,6 +6,7 @@ keywords: BarcodeScanner, scanner, Android, template file needAutoGenerateSidebar: true needGenerateH3Content: true noTitleIndex: true +ignore: true --- # Improve the Performance of BarcodeScanner diff --git a/programming/android/user-guide/use-cases/index.md b/programming/android/user-guide/use-cases/index.md index 1d2bb1dc..70154b2a 100644 --- a/programming/android/user-guide/use-cases/index.md +++ b/programming/android/user-guide/use-cases/index.md @@ -1,6 +1,6 @@ --- layout: default-layout -title: Use Cases - Dynamsoft Barcode Reader for Android User Guide +title: Use Cases - Dynamsoft Barcode Reader Android description: This page explores the use cases of Dynamsoft Barcode Reader Android SDK. keywords: user guide, use cases, java, kotlin, android breadcrumbText: Use Cases From d532d645e7f5298acf67d0da655e252ff7f02c9e Mon Sep 17 00:00:00 2001 From: Dynamsoft-Henry <78675724+Dynamsoft-Henry@users.noreply.github.com> Date: Thu, 5 Mar 2026 18:20:50 +0800 Subject: [PATCH 11/72] Updating side lists --- .../programming-android.html | 16 +- programming/android/user-guide.md | 2 +- .../capabilities/add-functional-buttons.md | 82 ++++++++++ .../user-guide/capabilities/add-graphics.md | 66 ++++++++ .../user-guide/capabilities/customize-ui.md | 149 ------------------ .../user-guide/capabilities/zoom-control.md | 2 +- .../concept/understand-barcode-results.md | 2 +- programming/assets/buttons.png | Bin 0 -> 44183 bytes 8 files changed, 162 insertions(+), 157 deletions(-) create mode 100644 programming/android/user-guide/capabilities/add-functional-buttons.md create mode 100644 programming/android/user-guide/capabilities/add-graphics.md delete mode 100644 programming/android/user-guide/capabilities/customize-ui.md create mode 100644 programming/assets/buttons.png diff --git a/_includes/sidelist-programming/programming-android.html b/_includes/sidelist-programming/programming-android.html index 16094dd6..468570c1 100644 --- a/_includes/sidelist-programming/programming-android.html +++ b/_includes/sidelist-programming/programming-android.html @@ -6,15 +6,15 @@ - - Core Concepts +
- Core Concepts
-- Capabilities +
- Capabilities
- Input
-
@@ -25,13 +25,14 @@
- Working with Results
- Control the Scanning Process -
- Customize the UI +
- Customize the UI + +
diff --git a/programming/android/user-guide.md b/programming/android/user-guide.md
index 56e6664e..373e3e6a 100644
--- a/programming/android/user-guide.md
+++ b/programming/android/user-guide.md
@@ -8,7 +8,7 @@ needGenerateH3Content: true
noTitleIndex: true
---
-# BarcodeScanner Android User Guide
+# Quick Start with BarcodeScanner Component
This user guide will walk through the [ScanSingleBarcode](https://github.com/Dynamsoft/barcode-reader-mobile-samples/tree/main/android/BarcodeScannerAPISamples/ScanSingleBarcode/) sample app. When creating your own project, please use this sample as a reference. This guide uses [`BarcodeScanner`](api-reference/barcode-scanner/index.md) API which aim to elevate the UI creation process with less code and offer a more pleasant and intuitive UI for your app.
diff --git a/programming/android/user-guide/capabilities/add-functional-buttons.md b/programming/android/user-guide/capabilities/add-functional-buttons.md
new file mode 100644
index 00000000..fb8b8652
--- /dev/null
+++ b/programming/android/user-guide/capabilities/add-functional-buttons.md
@@ -0,0 +1,82 @@
+---
+layout: default-layout
+title: Customize the UI of BarcodeScanner - Dynamsoft Barcode Reader for Android
+description: Learn how to customize the BarcodeScanner UI on Android.
+keywords: BarcodeScanner, scanner, Android, scan region, torch button, close button, scan laser
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+noTitleIndex: true
+---
+
+# Configure the UI Elements
+
+| Available Buttons |
+| ----------------- |
+| Torch button |
+| Camera toggle button |
+| Close button (BarcodeScanner API only) |
+
+BarcodeScanner provides a set of UI elements that you can easily customize.
+
+
++ +- Torch button: A clickable button that turns the torch on or off. +- Camera toggle button: A clickable button that switches the front/back-facing camera. +- Close button: Stops barcode scanning and returns to the previous activity. + +## Work with BarcodeScanner APIs + + +>- Java +>- Kotlin +> +>1. +```java +BarcodeScannerConfig config = new BarcodeScannerConfig(); +config.setTorchButtonVisible(true); +config.setCloseButtonVisible(true); +config.setCameraToggleButtonVisible(true); +``` +2. +```kotlin +val config = BarcodeScannerConfig().apply { + torchButtonVisible = true + closeButtonVisible = true + cameraToggleButtonVisible = true +} +``` + +**Related APIs** + +- [`BarcodeScannerConfig`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html) + - [setTorchButtonVisible]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#settorchbuttonvisible) + - [setCloseButtonVisible]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setclosebuttonvisible) + - [setCameraToggleButtonVisible]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setcameratogglebuttonvisible) + +## Work with Foundational APIs + + +>- Java +>- Kotlin +> +>1. +```java +CameraView cameraView = findViewById(R.id.camera_view); +cameraView.setTorchButtonVisible(true); +cameraView.setCameraToggleButtonVisible(true); +``` +2. +```kotlin +val cameraView = findViewById
+
Barcode Scanner UI Components
+(R.id.camera_view) +cameraView.torchButtonVisible = true +cameraView.cameraToggleButtonVisible = true +``` + +**Related APIs** + +- [`CameraView`]({{ site.dce_android }}auxiliary-api/dcecameraview.html) + - [setTorchButtonVisible]({{ site.dce_android }}auxiliary-api/dcecameraview.html#settorchbuttonvisible) + - [setCameraToggleButtonVisible]({{ site.dce_android }}auxiliary-api/dcecameraview.html#setcameratogglebuttonvisible) diff --git a/programming/android/user-guide/capabilities/add-graphics.md b/programming/android/user-guide/capabilities/add-graphics.md new file mode 100644 index 00000000..a5950319 --- /dev/null +++ b/programming/android/user-guide/capabilities/add-graphics.md @@ -0,0 +1,66 @@ +--- +layout: default-layout +title: UI Configurations - Dynamsoft Barcode Reader for Android +description: Learn how to add basic UI elements on the DCECameraView for Android edition. +keywords: UI Configurations, Android +needAutoGenerateSidebar: true +needGenerateH3Content: true +noTitleIndex: true +--- + +# UI Configurations + +> [!Important] +> Features on this page are only available for the **Foundational APIs**. + +`CameraView` allows you to define your own graphics diplaying rules with the `Drawing` APIs. + +- `DrawingItem`: Graphics or other UI elements. +- `DrawingLayer`: The layer for displaying the `DrawingItems`. +- `DrawingStyle`: The style for the `DrawingItem`. + +## How to Hide Default Barcode Highlight Overlay + +Barcode highlight overlay is displayed by default. You can set the layer invisible to disable it: + +```java +// Get the layer first. +DrawingLayer layer = cameraView.getDrawingLayer(DrawingLayer.DBR_LAYER_ID); +// Set the visible property to true or false to control the visibility. +layer.setVisible(true); +``` + +## How to Add User Defined DrawingItem(s) + +## How to Change the DrawingStyle + +Set the style of the highlight overlays with a preset style: + +```java +// Get the layer first. +DrawingLayer layer = cameraView.getDrawingLayer(DrawingLayer.DBR_LAYER_ID); +// Change the style of the layer. +layer.setDefaultStyle(DrawingStyleManager.STYLE_BLUE_STROKE); +``` + +Set the style of the highlight overlays with a use defined style: + +1. Create colours in the **values/colours.xml** file. + + ```xml + #FF03DAC5 +#2003DAC5 + ``` + +2. Create your style with the colour and set to the layer. + + ```java + // Get the layer first. + DrawingLayer layer = cameraView.getDrawingLayer(DrawingLayer.DBR_LAYER_ID); + // Create a new DrawingStyle via the DrawingStyleManager. + int teal_200_transparent = ResourcesCompat.getColor(MainActivity.this.getResources(), R.color.teal_200_transparent, null); + int teal_200 = ResourcesCompat.getColor(MainActivity.this.getResources(), R.color.teal_200, null); + int style = DrawingStyleManager.createDrawingStyle(teal_200, 1.0f,teal_200_transparent,teal_200); + // Set the newly created DrawingStyle to the layer. + layer.setDefaultStyle(style); + ``` diff --git a/programming/android/user-guide/capabilities/customize-ui.md b/programming/android/user-guide/capabilities/customize-ui.md deleted file mode 100644 index f27be7da..00000000 --- a/programming/android/user-guide/capabilities/customize-ui.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -layout: default-layout -title: Customize the UI of BarcodeScanner - Dynamsoft Barcode Reader for Android -description: Learn how to customize the BarcodeScanner UI on Android. -keywords: BarcodeScanner, scanner, Android, scan region, torch button, close button, scan laser -needAutoGenerateSidebar: true -needGenerateH3Content: true -noTitleIndex: true ---- - -# Configure the UI Elements - -| Available UI Elements | -| ------------------- | -| Scan region | -| Scan Laser | -| Torch button | -| Camera toggle button | -| Close button (BarcodeScanner API only) | - -BarcodeScanner provides a set of UI elements that you can easily customize. - --- -- Close button: Stops barcode scanning and returns to the previous activity. -- Scan region: Sets a region of interest so the algorithm focuses only on that area. This can significantly improve processing speed. For special barcode types such as DotCode, the scan region can also improve the read rate. -- Scan laser: A line that moves up and down. Its movement is limited to the scan region. -- Torch button: A clickable button that turns the torch on or off. - -## Scan Region & Scan Laser - -### Configure with BarcodeScanner APIs - - ->- Java ->- Kotlin -> ->1. -```java -BarcodeScannerConfig config = new BarcodeScannerConfig(); -// Margin left 15%, margin top 30%, margin right 85%, margin bottom 70% -config.setScanRegion(new DSRect(0.15f, 0.25f, 0.85f, 0.65f, true)); -config.setScanLaserVisible(true); -``` -2. -```kotlin -val config = BarcodeScannerConfig().apply { - // Margin left 15%, margin top 30%, margin right 85%, margin bottom 70% - scanRegion = DSRect(0.15f, 0.3f, 0.85f, 0.7f, true) - scanLaserVisible = true -} -``` - -**Related APIs** - -- [`BarcodeScannerConfig`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html) - - [`setScanRegion`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setscanregion) - - [`setScanLaserVisible`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setscanlaservisible) - -### Configure with Foundational APIs - - ->- Java ->- Kotlin -> ->1. -```java -CameraView cameraView = findViewById(R.id.camera_view); -CameraEnhancer mCamera = new CameraEnhancer(cameraView, this); -try { - mCamera.setScanRegion(new DSRect(0.15f, 0.25f, 0.85f, 0.65f, true)); -} catch (CameraEnhancerException e) { - throw new RuntimeException(e); -} -cameraView.setScanLaserVisible(true); -``` -2. -```kotlin -val cameraView = findViewById
-Barcode Scanner UI Components
-(R.id.camera_view) -val mCamera = CameraEnhancer(this) -mCamera.scanRegion = DSRect(0.15f, 0.25f, 0.85f, 0.65f, true) -cameraView.isScanLaserVisible = true -``` - -**Related APIs** - -- [`CameraEnhancer`]({{ site.dbr_android_api }}camera-enhancer/camera-enhancer.html) - - [`setScanRegion`]({{ site.dbr_android_api }}camera-enhancer/camera-enhancer.html#setscanregion) -- [`CameraView`]({{ site.dce_android }}auxiliary-api/dcecameraview.html) - - [`setScanLaserVisible`]({{ site.dce_android }}auxiliary-api/dcecameraview.html#setscanlaservisible) - -## Buttons - -### Add Buttons with BarcodeScanner APIs - - ->- Java ->- Kotlin -> ->1. -```java -BarcodeScannerConfig config = new BarcodeScannerConfig(); -config.setTorchButtonVisible(true); -config.setCloseButtonVisible(true); -config.setCameraToggleButtonVisible(true); -``` -2. -```kotlin -val config = BarcodeScannerConfig().apply { - torchButtonVisible = true - closeButtonVisible = true - cameraToggleButtonVisible = true -} -``` - -**Related APIs** - -- [`BarcodeScannerConfig`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html) - - [setTorchButtonVisible]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#settorchbuttonvisible) - - [setCloseButtonVisible]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setclosebuttonvisible) - - [setCameraToggleButtonVisible]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setcameratogglebuttonvisible) - -### Add Buttons with Foundational APIs - - ->- Java ->- Kotlin -> ->1. -```java -CameraView cameraView = findViewById(R.id.camera_view); -cameraView.setTorchButtonVisible(true); -cameraView.setCameraToggleButtonVisible(true); -``` -2. -```kotlin -val cameraView = findViewById (R.id.camera_view) -cameraView.torchButtonVisible = true -cameraView.cameraToggleButtonVisible = true -``` - -**Related APIs** - -- [`CameraView`]({{ site.dce_android }}auxiliary-api/dcecameraview.html) - - [setTorchButtonVisible]({{ site.dce_android }}auxiliary-api/dcecameraview.html#settorchbuttonvisible) - - [setCameraToggleButtonVisible]({{ site.dce_android }}auxiliary-api/dcecameraview.html#setcameratogglebuttonvisible) diff --git a/programming/android/user-guide/capabilities/zoom-control.md b/programming/android/user-guide/capabilities/zoom-control.md index 195022f1..996b7930 100644 --- a/programming/android/user-guide/capabilities/zoom-control.md +++ b/programming/android/user-guide/capabilities/zoom-control.md @@ -20,7 +20,7 @@ Zoom control is commonly used when processing small barcodes or scanning from a Enable auto-zoom so the camera can zoom in automatically. -diff --git a/programming/android/user-guide/concept/understand-barcode-results.md b/programming/android/user-guide/concept/understand-barcode-results.md index a0f4d611..a1cde964 100644 --- a/programming/android/user-guide/concept/understand-barcode-results.md +++ b/programming/android/user-guide/concept/understand-barcode-results.md @@ -35,7 +35,7 @@ Error messages are typically caused by: Each decoded barcode is a `BarcodeResultItem` from `result.getBarcodes`. The following is an example: - + | BarcodeResultItem | | | ----------------- | -- | diff --git a/programming/assets/buttons.png b/programming/assets/buttons.png new file mode 100644 index 0000000000000000000000000000000000000000..b4a5ebc8a8cb4701b6d014fda9e4cc931943dcee GIT binary patch literal 44183 zcmcG$2{_bk`!}w-ODdEWNvJ_3TPQnI8I(22GS)OB$)IRP##SjzmT3w@wo=*G!Pr8j z%w#Op*v42Yp=JhIW-P<_e@AuS&+~hp_c;FV@xJeIB+U2vUe|e@=Xss$=YlzBWh%U7 z-xdJ@0pYV}Am;@H*3*Emk
+
Auto Zoom
i_+KoNMqV9=p^O@^;?}vx(=k zVy!G7prj4a1bt1H2gs-s#Kp&Gdtnd)w k7Y_RIRZXw0BlXXm1ud`q6 zJCnNQQ@dip;&tk!4vjNOV~>4G)Ue@m&)R+5x&7aN`q94C;u~0=V;y=^#~s|ms%qyx znYYX1T`pN==z8K$C2YkE_sMw7^aW FnOjqm1>dG{^!_8+1oB9&zNS1#7)>>cLhClAP+C>U4$wecHpx`wk6d#lL+16RDk z*_5b?%kVEV+}%YzM40_O69h!B{>IC*F^IsenVWmE^o&}Lte!Hl&=h4M lyAe`sHT>I#N-R#O-9bKzA)RkBHq|
BkA{~=ASe2Zr=VKk#E%VVNW6J)) zu`9e8imF!AVp@}T=QZZE^zzt-F|F0XCM{FZ{l`~a3n83ck<$Tp0t#Le- PiZaAIXt6W__ zxsp^G`oeVx*ss^6hQZnFrceS;Wk&wN;58odn=Wrq{e3vfLxnl&ua%nMX8m16BObAM zw7S23>Aq=7Y1n9!U@t5-fV90<(^BL+v$SbQ`tDaiG+q%uM(Yp;2@CC|5zV2CvF_^Q znc+Fm;i`JTPOjP*Lm+d?l5`dOQ4x^to>}sJ#44*aJTOateC)87%gXowyEELPRl-9@ zlJ~ +GamW_G;GlS*=6=#~_7ik7C;8J@5FQqW33O?eGb0Bk~} zNK6<>`;WP?tvKb@*jW1}ffL0E ?1xQnU1)l<*P zR@F<1z-@3l=4N5A3YcJ4z}X9DSjL$YYP>_VuCCY9`uNNt6H8_%T{(93Wn;TX*Ctu# z)dA$;ul+iqR>XTlZa`yt?G7X`W8WTjz-42ibg9)duAWU8vD9jOcYpSfNk!R=dY1(4 zs*c=GcBA_q%B1*j?(Jaf5{( @!J)2$b( 7U~=0+8b{{#(y)B2Y|eALG+<2!5auO#7fjyyr! zG>qjbA!!XxE&y^911lT$-2LCzwDf>fxkmR+S~A&fKf4_NLb?=)YXB|-xw8d-qVLig zfYs414u1+n9_|@E4Mo0*YYaFi69Q#S1BgT^e#&alzJ~glRHFg_PbFl*xI?a`YKSCI zi+D)(Yj`$%n;eKv@os(>W&I1v4m5KAe%@i{SACd4^7`>T=)g=m*aD~J#uzU3{#zVB zJpCir#F6n~)fLy*)9IBT(MkBT_ls1@&?XEkN{*oSbhZ98pM6`_X6NcBB0n+MDg`3L zP%}7e$Kh~sQ0F)lzJDbIFaJji)7&`0fNK>&E_9p+NydI(Rrx;7xUf3p`RBa6&cTOC zGmu3_z}ZS9w}6(Kwl3A`b~gn<|AoG+XtY#eUSyE87_HBKbl$h$6bK~OY7tgtKRo}( z(|EqKHrxkzc}TunRJ>a!V$R;@e9nngB;x$gLf?aOa!>QchrDU0Zz3|({VO7n%tG50 zz45gxMQgFVp79zjla0LTwK@y^AOXk_Y?D3@I!y`g7ywFX^K5Ldu55@sV_3)ix2--a zM$0$*DMkYj4!%nyMPUB|zR_f>hh!_eJ9sh&!2MIfZorulxT2RNTd!Q658TM)xG+=M zRox0vLEt0%hIB*I2vw(~9s$^1tZGP{aTJpP4U*vhVFutYB4o(nGO`oC d{{pD%P@Z90Ubi#@M>o zqVVPKXbvzxred^=WU|V|W5qLn4C6zxG=CmY{jJxPt^b&>5INkSH-@!-)1OI`l?bqw zH_oEASu4g{7%9authdLuv@`<_VB@wNJGb8k47jd_VOg2O#gC=f2d_EzQvenVC^hN% z0yoxYC7CN1)8A=MJKmT0hc4h!*ME>j#1(fpU$`F7?|L6$LwbX-*!JwAetHhC;S={U z*>7wC^y^R!);#ih&uutUqw)}#9%?PMwL(oT?#}cv ;-Qwedwy83h954@^@pokC@0N!2u(@nA?Urz#J{Fl%2_R}=qfI9Rp!zkMW zdni>`7<*qKY=N#+rhTv6@A*uXamDc)CyQX3#BFL`4KA@c3G3RD`MBMVKdK6M*`H@5 z04)D+L{#SmOb}k4W01t5(5!eMec6zrjLQK2{W1IG8UO zAY{9&J zi^xLuo4~T#{VF^`?8CVim2Zrz8!{G*!;GpMI1{v1|H;ksBoW-RVX}X3i^zKLM?syQ zYf!>K3VNUQ{AasdNE{%)O)i@GLD1+}`&vRhi#re;-J{zobwvIhGepM{8WuKpsm5_S zId+rCzZW_XZa%W+DjY%9RE0H0(PCdLu-a>z7a1dP|Ng~Z{}xtZR7DI+fHet5%3g5z zMm3E3p+CBEqUxt&x$Kz12u_)Mbj8A$IvgRJNDbbHn%n`+En1kc%ZVb*c5wQPh;Jml zdxK1@MSr@qBH?qJ1Zem0ss%kZ@~Pri-a;Ap6*DR7^X(T&(I(`n#A+ARbh37E!q^=8 zAbEC?lH)GJuqwziNt8S_Hj20~r7^h=vU#xs%J!3XyG$697oii{^CgM6qWMZ>i(Uc` z&LuDA-I4X6%NB4+37>-dy`=N#J})a7bY #DpbEH0{t_zHcr^K$7Cl-dZTH}!CEsZg%yqwNrOL0W!Z2r@>{)=MQ_Swh^=PvKU zOEJAxY`|dPQd;d#FX#7Y#`Tec7|D$llW>SiaM{5vMnU@^!COdf_>+kdn+%4gkj{EU zcu>3~!qvI*T_pPj{wjF_&R22MFh69qvq9L5#a85<7YRa8XhIgR2yWDkV046 C+m*1Ri z56+E^Ys%TYs@ELc>MZ&T5G+wqy=aHdykl$k-b%f)J%oEsIpU;c#@GB- +~*vE;rX(0dR_3;75V~{QwtNAU@ z)w{N?RF$&_%e`{gb-V6$m;Zh|% KGO26y-(#WNxUv;@PqgLZg^^^5ATXjCYth)>|0(2cX;zZq yG_Apr>QcW^OI2r)J)| zH>P0K%D%WVieTn%q5fRP90lZTtwQt<)o@wF e>Hrl_^Y{6y(=0wuUH4TLcKGpTs+{$=^ z-wK)6K~xN%{od{O6CUq0bRcn4hb?Q4>Rh 1pF!oabF=$IL*;w@r zzp@KNGIW&Zej%+X#%IKmh*v;fdY}o=Z~1kDE^Iw2H9+5WDCs*lhDYA9-itK34gISN z0rmu*bXo^l-fv33=6To~x($dDZKC<85d0KpG>@2V_>ys-A9mm= DQx&+Xrl+6u?3KB5EuBT z%c|6Z!Oaws-Ajg52T&HR!O2Tx0SZ^3qOl5qcQ;VLDptVAmpxKdSknn_z$J!YNg^LD z`Ne<}Z^`(^0BXRLtTn#m02}{$%ifEpDf%$!HBjt&CO}Sn@iBhw1w-F|-k1XVl=;sa zhXOFlzi+JX=}oI?i0v6=y`W}x(~~d<`*alOlP9IiizAH(w&S4;J(W*p^cP?@cfo~A zxqW{Rng%Ea_ 6nVXM{E0IF9Bt;=SQszT@Q^#V{M>ntM-%D2=IU#rPdIu=E|LG86UrTPV3|2 z=GSnevfu)Y7Tv&xN$tPHdhQOrAl4P{ $W$%{|P9~@mi3wC-p zpr+MP#YLA6-Qt-&^4bYT&PTsfKyhN(j_2gLsYZ^v_0(!#|8P3oTt|e;#3=*$3bN3j zY-+v{4umIG?!VY{aXWXO`T^_YEitC=c|bHtN#*J9I5xZ`&}^^4wmK&JnY*L5wWpGJ zw`1(g=pUV;g?41&LMJ-DMbj$!N{DYA8>+#L7poPXbZn<|1)U8h%?Wp1z3MIMS}Y~+ z WI&SOhB zqp`8o+A@Kx;f|k{S=jb*;hcIq3lErBI8E@wr`qTS`O3vBKtu-{(%qrGANXp+l; zv(_oUp%IkyHP9^yn{Jvnm71?Xn2l |#Wf?=a{_g`dm)S{zMU33N=dpBkvPi;;An%ah-1~C}IazVSi zOp8O7yh81F%CGCqz?J2cr3RE`sGY%`RWK`$-GC S7o2wD)^ylgb=@YNqKkDS3b0kg zlGsy%bS5yH64C02vt+tnz2}UVPvdK~DsZq;`FGep!ssyTAJ-s(f2$ * z+k7i+8b9b=4SY3&Ld$Q{fZE_+nkc+VFomYXj}7lgT#K=J&