Skip to content

Commit 7923f4c

Browse files
Updating side list and code snippets
1 parent 4ccda85 commit 7923f4c

12 files changed

Lines changed: 20 additions & 316 deletions

File tree

_includes/sidelist-programming/programming-android.html

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<li lang="android"><a href="{{ site.android }}user-guide/index.html" class="otherLinkColour">Getting Started</a>
33
<ul lang="android">
44
<li lang="android"><a href="{{ site.android }}user-guide/license-activation.html" class="otherLinkColour">License Initialization</a></li>
5-
<li lang="android"><a href="{{ site.android }}user-guide.html" class="otherLinkColour">Quick Start: Ready-to-Use Component</a></li>
5+
<li lang="android"><a href="{{ site.android }}user-guide.html" class="otherLinkColour">Quick Start</a></li>
66
<li lang="android"><a href="{{ site.android }}foundational-guide.html" class="otherLinkColour">Full-Feature Development</a></li>
77
</ul>
88
</li>
@@ -32,7 +32,6 @@
3232
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/init-customized-template.html" class="otherLinkColour">Initialize Customized Template</a></li>
3333
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/config-simplified-settings.html" class="otherLinkColour">Configure Simplified Settings</a></li>
3434
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/barcode-formats.html" class="otherLinkColour">Configure Barcode Format</a></li>
35-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/feedback.html" class="otherLinkColour">Add Scan Feedback</a></li>
3635
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/read-specific-area.html" class="otherLinkColour">Read a specific area/region</a></li>
3736
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/single-multiple.html" class="otherLinkColour">Switch Single & Multiple</a></li>
3837
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/zoom-control.html" class="otherLinkColour">Zoom Control</a></li>
@@ -58,6 +57,7 @@
5857
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/add-functional-buttons.html" class="otherLinkColour">Add Functional Buttons</a></li>
5958
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/add-graphics.html" class="otherLinkColour">Add Graphics with DrawingItems</a></li>
6059
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/scan-region-style.html" class="otherLinkColour">Scan Region Style</a></li>
60+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/feedback.html" class="otherLinkColour">User Feedback</a></li>
6161
</ul>
6262
</li>
6363
</ul>
@@ -360,20 +360,9 @@
360360
</ul>
361361
</li>
362362
</ul>
363-
364-
</li>
365-
<li lang="android"><a>DynamsoftIdentityUtility</a>
366-
<ul lang="android">
367-
<li lang="android"><a class="otherLinkColour">Classes</a>
368-
<ul lang="android">
369-
<li lang="android"><a href="{{ site.dcvb_android_api }}identity-utility/identity-processor.html" class="otherLinkColour">IdentityProcessor</a></li>
370-
</ul>
371-
</li>
372-
</ul>
373363
</li>
374364
</ul>
375365
</li>
376-
377366
</ul>
378367
</li>
379368
<li lang="android" class="category">ENGINE ARCHITECTURE & OPTIMIZATION</li>
@@ -719,8 +708,6 @@
719708
<li lang="android" ><a href="{{ site.android }}migrate-from-v9/" class="otherLinkColour">Migrate from v9 to v11</a></li>
720709
</ul>
721710
</li>
722-
723-
<li lang="android" ><a href="{{ site.android }}user-guide/license-activation.html" class="otherLinkColour">License Initialization</a></li>
724711
<li lang="android"><a target="_blank" href="{{ site.faq }}index.html" class="otherLinkColour">FAQ</a></li>
725712

726713
<li lang="android" class="category">OTHER EDITIONS</li>

programming/android/api-reference/index.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,17 @@ This page provides an overview of the various modules and highlights the most es
1313

1414
The Dynamsoft Barcode Reader (DBR) SDK is built on the Dynamsoft Capture Vision (DCV) framework, which includes multiple modules working together to achieve barcode reading. The hierarchical structure diagram below illustrates the various modules of the DBR SDK (with modules at the top depending on those below).
1515

16-
<div align="center">
17-
<p><img src="../../assets/dcv-dbr-dependency.png" width="70%" alt="region-def"></p>
18-
<p>Modules hierarchical of the DBR SDK</p>
19-
</div>
20-
2116
The table below describes details the functionalities of these modules:
2217

2318
| Module | Description |
2419
|:-------|:------------|
2520
| `DynamsoftBarcodeReader`(DBR) | The Dynamsoft Barcode Reader module recognizes and decodes multiple barcode formats such as QR codes, Code 39, Code 128, and Data Matrix, among many others. |
2621
| `DynamsoftCore`(Core) | The Dynamsoft Core module lays the foundation for Dynamsoft SDKs based on the DCV (Dynamsoft Capture Vision) architecture. It encapsulates the basic classes, interfaces, and enumerations shared by these SDKs. |
2722
| `DynamsoftCaptureVisionRouter`(CVR) | The Dynamsoft Capture Vision Router module is the cornerstone of the Dynamsoft Capture Vision (DCV) architecture. It focuses on coordinating batch image processing and provides APIs for setting up image sources and result receivers, configuring workflows with parameters, and controlling processes. |
28-
| `DynamsoftImageProcessing`(DIP) | The Dynamsoft Image Processing module facilitates digital image processing and supports operations for other modules, including the Barcode Reader, Label Recognizer, and Document Normalizer. |
2923
| `DynamsoftLicense`(License) | The Dynamsoft License module manages the licensing aspects of Dynamsoft SDKs based on the DCV (Dynamsoft Capture Vision) architecture. |
3024
| `DynamsoftCameraEnhancer`(DCE) | The Dynamsoft Camera Enhancer module controls the camera, transforming it into an image source for the DCV (Dynamsoft Capture Vision) architecture through ISA implementation. It also enhances image quality during acquisition and provides basic viewers for user interaction. |
3125
| `DynamsoftUtility`(Utility) | The Dynamsoft Utility module defines auxiliary classes, including the ImageManager, and implementations of the CRF (Captured Result Filter) and ISA (Image Source Adapter) . These are shared by all Dynamsoft SDKs based on the DCV (Dynamsoft Capture Vision) architecture. |
3226
| `DynamsoftCodeParser`(DCP) | The Dynamsoft Code Parser module converts data strings, typically encrypted in barcodes and machine-readable zones, into human-readable information. |
33-
| `DynamsoftCodeParserDedicator`(DCPD) | The Dynamsoft Code Parser Dedicator module provides auxiliary functionality to enhance and extend the capabilities of DCP module. |
3427

3528
## Main APIs
3629

programming/android/foundational-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ needGenerateH3Content: true
88
noTitleIndex: true
99
---
1010

11-
# Build Your App with Foundational APIs
11+
# Full-Feature Development
1212

1313
## Requirements
1414

programming/android/user-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ needGenerateH3Content: true
88
noTitleIndex: true
99
---
1010

11-
# Quick Start with BarcodeScanner Component
11+
# Quick Start: Ready-to-Use Component
1212

1313
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.
1414

programming/android/user-guide/capabilities/add-functional-buttons.md

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,6 @@ BarcodeScanner provides a set of UI elements that you can easily customize.
2727
- Camera toggle button: A clickable button that switches the front/back-facing camera.
2828
- Close button: Stops barcode scanning and returns to the previous activity.
2929

30-
## Work with Foundational APIs
31-
3230
<div class="sample-code-prefix"></div>
3331
>- Java
3432
>- Kotlin
@@ -51,32 +49,3 @@ cameraView.cameraToggleButtonVisible = true
5149
- [`CameraView`]({{ site.dce_android }}auxiliary-api/dcecameraview.html)
5250
- [setTorchButtonVisible]({{ site.dce_android }}auxiliary-api/dcecameraview.html#settorchbuttonvisible)
5351
- [setCameraToggleButtonVisible]({{ site.dce_android }}auxiliary-api/dcecameraview.html#setcameratogglebuttonvisible)
54-
55-
## Work with BarcodeScanner APIs
56-
57-
<div class="sample-code-prefix"></div>
58-
>- Java
59-
>- Kotlin
60-
>
61-
>1.
62-
```java
63-
BarcodeScannerConfig config = new BarcodeScannerConfig();
64-
config.setTorchButtonVisible(true);
65-
config.setCloseButtonVisible(true);
66-
config.setCameraToggleButtonVisible(true);
67-
```
68-
2.
69-
```kotlin
70-
val config = BarcodeScannerConfig().apply {
71-
torchButtonVisible = true
72-
closeButtonVisible = true
73-
cameraToggleButtonVisible = true
74-
}
75-
```
76-
77-
**Related APIs**
78-
79-
- [`BarcodeScannerConfig`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html)
80-
- [setTorchButtonVisible]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#settorchbuttonvisible)
81-
- [setCloseButtonVisible]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setclosebuttonvisible)
82-
- [setCameraToggleButtonVisible]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setcameratogglebuttonvisible)

programming/android/user-guide/capabilities/barcode-formats.md

Lines changed: 2 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,6 @@ Specify barcode formats using a combined value of [`EnumBarcodeFormat`]({{ site.
2424
- Use `EnumBarcodeFormat.BF_ALL` to enable all supported formats.
2525
- Use group values like `EnumBarcodeFormat.BF_ONED` when appropriate.
2626

27-
### Use Foundational API
28-
29-
- `SimplifiedCaptureVisionSettings.barcodeSettings.barcodeFormatIds`
30-
3127
Example:
3228

3329
<div class="sample-code-prefix"></div>
@@ -59,31 +55,9 @@ try {
5955
}
6056
```
6157

62-
### Use BarcodeScanner API
63-
64-
- `BarcodeScannerConfig.setBarcodeFormats(long format)`
65-
66-
Example:
67-
68-
<div class="sample-code-prefix"></div>
69-
>- Java
70-
>- Kotlin
71-
>
72-
>1.
73-
```java
74-
BarcodeScannerConfig config = new BarcodeScannerConfig();
75-
// QR Code + DataMatrix
76-
config.setBarcodeFormats(EnumBarcodeFormat.BF_QR_CODE | EnumBarcodeFormat.BF_DATAMATRIX);
77-
```
78-
2.
79-
```kotlin
80-
val config = BarcodeScannerConfig()
81-
// QR Code + DataMatrix
82-
config.barcodeFormats = EnumBarcodeFormat.BF_QR_CODE or EnumBarcodeFormat.BF_DATAMATRIX
83-
```
58+
**Related API(s)**
8459

85-
> [!Note]
86-
> 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.
60+
- [`SimplifiedCaptureVisionSettings.barcodeSettings.barcodeFormatIds`]({{ site.dbr_android_api }}simplified-barcode-reader-settings.html#barcodeformatids)
8761

8862
## Configure Formats in a Template
8963

programming/android/user-guide/capabilities/feedback.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ noTitleIndex: true
1212

1313
Trigger a beep sound or vibration when a barcode is scanned successfully.
1414

15-
### Use Foundational APIs
16-
1715
<div class="sample-code-prefix"></div>
1816
>- Java
1917
>- Kotlin
@@ -32,28 +30,3 @@ Feedback.vibrate()
3230
**Related API**
3331

3432
- [`Feedback`]({{ site.dce_android }}auxiliary-api/dcefeedback.html)
35-
36-
### Use BarcodeScanner APIs
37-
38-
<div class="sample-code-prefix"></div>
39-
>- Java
40-
>- Kotlin
41-
>
42-
>1.
43-
```java
44-
BarcodeScannerConfig config = new BarcodeScannerConfig();
45-
config.setBeepEnabled(true);
46-
config.setVibrateEnabled(true);
47-
```
48-
2.
49-
```kotlin
50-
val config = BarcodeScannerConfig().apply {
51-
isVibrateEnabled = true
52-
isBeepEnabled = true
53-
}
54-
```
55-
56-
**Related API**
57-
58-
- [`isVibrateEnabled`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#isvibrateenabled)
59-
- [`isBeepEnabled`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#isbeepenabled)

programming/android/user-guide/capabilities/index.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,19 @@ Find the feature you need quickly by keyword.
7575
<a class="capability-link-card" href="{{ site.android }}user-guide/capabilities/read-specific-area.html">Read a specific area/region</a>
7676
<a class="capability-link-card" href="{{ site.android }}user-guide/capabilities/single-multiple.html">Switch Single & Multiple</a>
7777
<a class="capability-link-card" href="{{ site.android }}user-guide/capabilities/zoom-control.html">Zoom Control</a>
78-
<a class="capability-link-card" href="{{ site.android }}user-guide/capabilities/feedback.html">Beep & Vibrate</a>
7978
</div>
8079

8180
## Data Parsing
8281

8382
<div class="capabilities-grid">
84-
<a class="otherLinkColour">Get Driver's Info from PDF417</a>
85-
</div>
83+
<a class="capability-link-card" >Get Driver's Info from PDF417</a>
84+
</div>
85+
86+
## UI & UX Customization
87+
88+
<div class="capabilities-grid">
89+
<a class="capability-link-card" href="{{ site.android }}user-guide/capabilities/add-functional-buttons.html">Add Functional Buttons</a>
90+
<a class="capability-link-card" href="{{ site.android }}user-guide/capabilities/add-graphics.html">Add Graphics with DrawingItems</a>
91+
<a class="capability-link-card" href="{{ site.android }}user-guide/capabilities/scan-region-style.html">Scan Region Style</a>
92+
<a class="capability-link-card" href="{{ site.android }}user-guide/capabilities/feedback.html">User Feedback</a>
93+
</div>

programming/android/user-guide/capabilities/init-customized-template.md

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,6 @@ Add a **Templates** folder under your project's assets directory at **src\main\a
2121
<p>init settings</p>
2222
</div>
2323

24-
## Initialize with Foundational APIs
25-
2624
<div class="sample-code-prefix"></div>
2725
>- Java
2826
>- Kotlin
@@ -42,27 +40,6 @@ val mRouter: CaptureVisionRouter? = CaptureVisionRouter()
4240
mRouter?.initSettingsFromFile("ReadQRCodes")
4341
```
4442

45-
## Initialize with BarcodeScanner APIs
46-
47-
Specify the template file with `setTemplateFile`.
48-
49-
<div class="sample-code-prefix"></div>
50-
>- Java
51-
>- Kotlin
52-
>
53-
>1.
54-
```java
55-
BarcodeScannerConfig config = new BarcodeScannerConfig();
56-
config.setTemplateFile("ReadQRCodes.json");
57-
```
58-
2.
59-
```kotlin
60-
val config = BarcodeScannerConfig().apply {
61-
templateFile = "ReadQRCodes.json"
62-
}
63-
```
64-
65-
**Related APIs**
43+
**Related API(s)**
6644

67-
- [`setTemplateFile`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#settemplatefile)
6845
- [`initSettingsFromFile`]({{ site.dcvb_android_api }}capture-vision-router/settings.html#initsettingsfromfile)

programming/android/user-guide/capabilities/read-specific-area.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ needAutoGenerateSidebar: true
1212

1313
## Set a Scan Region on Camera
1414

15-
### Work with Foundational APIs
16-
1715
<div class="sample-code-prefix"></div>
1816
>- Java
1917
>- Kotlin
@@ -40,31 +38,6 @@ mCamera.scanRegion = DSRect(0.15f, 0.25f, 0.85f, 0.65f, true)
4038
- [`CameraEnhancer`]({{ site.dbr_android_api }}camera-enhancer/camera-enhancer.html)
4139
- [`setScanRegion`]({{ site.dbr_android_api }}camera-enhancer/camera-enhancer.html#setscanregion)
4240

43-
### Work with BarcodeScanner APIs
44-
45-
<div class="sample-code-prefix"></div>
46-
>- Java
47-
>- Kotlin
48-
>
49-
>1.
50-
```java
51-
BarcodeScannerConfig config = new BarcodeScannerConfig();
52-
// Margin left 15%, margin top 30%, margin right 85%, margin bottom 70%
53-
config.setScanRegion(new DSRect(0.15f, 0.25f, 0.85f, 0.65f, true));
54-
```
55-
2.
56-
```kotlin
57-
val config = BarcodeScannerConfig().apply {
58-
// Margin left 15%, margin top 30%, margin right 85%, margin bottom 70%
59-
scanRegion = DSRect(0.15f, 0.3f, 0.85f, 0.7f, true)
60-
}
61-
```
62-
63-
**Related APIs**
64-
65-
- [`BarcodeScannerConfig`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html)
66-
- [`setScanRegion`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setscanregion)
67-
6841
## Set an ROI via Simplified Settings
6942

7043
> [!Important]

0 commit comments

Comments
 (0)