Skip to content

Commit fd58b72

Browse files
Updated side lists
1 parent c5cc4ae commit fd58b72

13 files changed

Lines changed: 260 additions & 177 deletions

_includes/sidelist-programming/programming-android.html

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,11 @@
2424
</li>
2525
<li lang="android"><a class="otherLinkColour">Working with Results</a>
2626
<ul lang="android">
27-
<li lang="android"><a href="{{ site.features }}get-detailed-info.html?lang=android" class="otherLinkColour">Get detailed barcode information</a></li>
27+
<li lang="android"><a href="{{ site.features }}filter-and-sort.html?lang=android" class="otherLinkColour">Parameter Based Result Filter</a></li>
28+
<li lang="android"><a href="{{ site.features }}get-detailed-info.html?lang=android" class="otherLinkColour">Get Detailed Barcode Information</a></li>
29+
<li lang="android"><a href="{{ site.features }}get-confidence-rotation.html?lang=android" class="otherLinkColour">Get Barcode Confidence and Rotation</a></li>
30+
<li lang="android"><a href="{{ site.features }}get-barcode-location.html?lang=android" class="otherLinkColour">Get Barcode Location</a></li>
2831
<li lang="android"><a class="otherLinkColour">Multi-Frame Cross Filter</a></li>
29-
<li lang="android"><a href="{{ site.features }}filter-and-sort.html?lang=android" class="otherLinkColour">Filter and sort decoding results</a></li>
3032
</ul>
3133
</li>
3234
<li lang="android"><a class="otherLinkColour">Control the Scanning Process</a>
@@ -60,7 +62,8 @@
6062
<li lang="android"><a class="otherLinkColour">Customize the UI</a>
6163
<ul lang="android">
6264
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/add-functional-buttons.html" class="otherLinkColour">Add Functional Buttons</a></li>
63-
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/add-graphics.html" class="otherLinkColour">Add Graphics</a></li>
65+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/add-graphics.html" class="otherLinkColour">Add Graphics with DrawingItems</a></li>
66+
<li lang="android"><a href="{{ site.android }}user-guide/capabilities/scan-region-style.html" class="otherLinkColour">Scan Region Style</a></li>
6467
</ul>
6568
</li>
6669
</ul>

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

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -27,56 +27,56 @@ 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 BarcodeScanner APIs
30+
## Work with Foundational APIs
3131

3232
<div class="sample-code-prefix"></div>
3333
>- Java
3434
>- Kotlin
3535
>
3636
>1.
3737
```java
38-
BarcodeScannerConfig config = new BarcodeScannerConfig();
39-
config.setTorchButtonVisible(true);
40-
config.setCloseButtonVisible(true);
41-
config.setCameraToggleButtonVisible(true);
38+
CameraView cameraView = findViewById(R.id.camera_view);
39+
cameraView.setTorchButtonVisible(true);
40+
cameraView.setCameraToggleButtonVisible(true);
4241
```
4342
2.
4443
```kotlin
45-
val config = BarcodeScannerConfig().apply {
46-
torchButtonVisible = true
47-
closeButtonVisible = true
48-
cameraToggleButtonVisible = true
49-
}
44+
val cameraView = findViewById<CameraView>(R.id.camera_view)
45+
cameraView.torchButtonVisible = true
46+
cameraView.cameraToggleButtonVisible = true
5047
```
5148

5249
**Related APIs**
5350

54-
- [`BarcodeScannerConfig`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html)
55-
- [setTorchButtonVisible]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#settorchbuttonvisible)
56-
- [setCloseButtonVisible]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setclosebuttonvisible)
57-
- [setCameraToggleButtonVisible]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#setcameratogglebuttonvisible)
51+
- [`CameraView`]({{ site.dce_android }}auxiliary-api/dcecameraview.html)
52+
- [setTorchButtonVisible]({{ site.dce_android }}auxiliary-api/dcecameraview.html#settorchbuttonvisible)
53+
- [setCameraToggleButtonVisible]({{ site.dce_android }}auxiliary-api/dcecameraview.html#setcameratogglebuttonvisible)
5854

59-
## Work with Foundational APIs
55+
## Work with BarcodeScanner APIs
6056

6157
<div class="sample-code-prefix"></div>
6258
>- Java
6359
>- Kotlin
6460
>
6561
>1.
6662
```java
67-
CameraView cameraView = findViewById(R.id.camera_view);
68-
cameraView.setTorchButtonVisible(true);
69-
cameraView.setCameraToggleButtonVisible(true);
63+
BarcodeScannerConfig config = new BarcodeScannerConfig();
64+
config.setTorchButtonVisible(true);
65+
config.setCloseButtonVisible(true);
66+
config.setCameraToggleButtonVisible(true);
7067
```
7168
2.
7269
```kotlin
73-
val cameraView = findViewById<CameraView>(R.id.camera_view)
74-
cameraView.torchButtonVisible = true
75-
cameraView.cameraToggleButtonVisible = true
70+
val config = BarcodeScannerConfig().apply {
71+
torchButtonVisible = true
72+
closeButtonVisible = true
73+
cameraToggleButtonVisible = true
74+
}
7675
```
7776

7877
**Related APIs**
7978

80-
- [`CameraView`]({{ site.dce_android }}auxiliary-api/dcecameraview.html)
81-
- [setTorchButtonVisible]({{ site.dce_android }}auxiliary-api/dcecameraview.html#settorchbuttonvisible)
82-
- [setCameraToggleButtonVisible]({{ site.dce_android }}auxiliary-api/dcecameraview.html#setcameratogglebuttonvisible)
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: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,7 @@ 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-
### BarcodeScanner API
28-
29-
- `BarcodeScannerConfig.setBarcodeFormats(long format)`
30-
31-
Example:
32-
33-
```java
34-
BarcodeScannerConfig config = new BarcodeScannerConfig();
35-
// QR Code + DataMatrix
36-
config.setBarcodeFormats(EnumBarcodeFormat.BF_QR_CODE | EnumBarcodeFormat.BF_DATAMATRIX);
37-
```
38-
39-
### Foundational API
27+
### Use Foundational API
4028

4129
- `SimplifiedCaptureVisionSettings.barcodeSettings.barcodeFormatIds`
4230

@@ -54,6 +42,18 @@ try {
5442
}
5543
```
5644

45+
### Use BarcodeScanner API
46+
47+
- `BarcodeScannerConfig.setBarcodeFormats(long format)`
48+
49+
Example:
50+
51+
```java
52+
BarcodeScannerConfig config = new BarcodeScannerConfig();
53+
// QR Code + DataMatrix
54+
config.setBarcodeFormats(EnumBarcodeFormat.BF_QR_CODE | EnumBarcodeFormat.BF_DATAMATRIX);
55+
```
56+
5757
> [!Note]
5858
> 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.
5959

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

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,48 +12,48 @@ noTitleIndex: true
1212

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

15-
### Use BarcodeScanner APIs
15+
### Use Foundational APIs
1616

1717
<div class="sample-code-prefix"></div>
1818
>- Java
1919
>- Kotlin
2020
>
2121
>1.
2222
```java
23-
BarcodeScannerConfig config = new BarcodeScannerConfig();
24-
config.setBeepEnabled(true);
25-
config.setVibrateEnabled(true);
23+
Feedback.beep();
24+
Feedback.vibrate();
2625
```
2726
2.
2827
```kotlin
29-
val config = BarcodeScannerConfig().apply {
30-
isVibrateEnabled = true
31-
isBeepEnabled = true
32-
}
28+
Feedback.beep()
29+
Feedback.vibrate()
3330
```
3431

3532
**Related API**
3633

37-
- [`isVibrateEnabled`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#isvibrateenabled)
38-
- [`isBeepEnabled`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#isbeepenabled)
34+
- [`Feedback`]({{ site.dce_android }}auxiliary-api/dcefeedback.html)
3935

40-
### Use Foundational APIs
36+
### Use BarcodeScanner APIs
4137

4238
<div class="sample-code-prefix"></div>
4339
>- Java
4440
>- Kotlin
4541
>
4642
>1.
4743
```java
48-
Feedback.beep();
49-
Feedback.vibrate();
44+
BarcodeScannerConfig config = new BarcodeScannerConfig();
45+
config.setBeepEnabled(true);
46+
config.setVibrateEnabled(true);
5047
```
5148
2.
5249
```kotlin
53-
Feedback.beep()
54-
Feedback.vibrate()
50+
val config = BarcodeScannerConfig().apply {
51+
isVibrateEnabled = true
52+
isBeepEnabled = true
53+
}
5554
```
5655

5756
**Related API**
5857

59-
- [`Feedback`]({{ site.dce_android }}auxiliary-api/dcefeedback.html)
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/init-customized-template.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -20,47 +20,47 @@ Add a **Templates** folder under your project's assets directory at **src\main\a
2020
<p><img src="../../../assets/init-settings-from-file-android.png" alt="initSettings" width="50%" /></p>
2121
</div>
2222

23-
## Initialize with BarcodeScanner APIs
24-
25-
Specify the template file with `setTemplateFile`.
23+
## Initialize with Foundational APIs
2624

2725
<div class="sample-code-prefix"></div>
2826
>- Java
2927
>- Kotlin
3028
>
3129
>1.
3230
```java
33-
BarcodeScannerConfig config = new BarcodeScannerConfig();
34-
config.setTemplateFile("ReadQRCodes.json");
31+
CaptureVisionRouter mRouter = new CaptureVisionRouter();
32+
try {
33+
mRouter.initSettingsFromFile("ReadQRCodes");
34+
} catch (CaptureVisionRouterException e) {
35+
throw new RuntimeException(e);
36+
}
3537
```
3638
2.
3739
```kotlin
38-
val config = BarcodeScannerConfig().apply {
39-
templateFile = "ReadQRCodes.json"
40-
}
40+
val mRouter: CaptureVisionRouter? = CaptureVisionRouter()
41+
mRouter?.initSettingsFromFile("ReadQRCodes")
4142
```
4243

43-
**Related APIs**
44-
45-
- [`setTemplateFile`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#settemplatefile)
44+
## Initialize with BarcodeScanner APIs
4645

47-
## Initialize with Foundational APIs
46+
Specify the template file with `setTemplateFile`.
4847

4948
<div class="sample-code-prefix"></div>
5049
>- Java
5150
>- Kotlin
5251
>
5352
>1.
5453
```java
55-
CaptureVisionRouter mRouter = new CaptureVisionRouter();
56-
try {
57-
mRouter.initSettingsFromFile("ReadQRCodes");
58-
} catch (CaptureVisionRouterException e) {
59-
throw new RuntimeException(e);
60-
}
54+
BarcodeScannerConfig config = new BarcodeScannerConfig();
55+
config.setTemplateFile("ReadQRCodes.json");
6156
```
6257
2.
6358
```kotlin
64-
val mRouter: CaptureVisionRouter? = CaptureVisionRouter()
65-
mRouter?.initSettingsFromFile("ReadQRCodes")
59+
val config = BarcodeScannerConfig().apply {
60+
templateFile = "ReadQRCodes.json"
61+
}
6662
```
63+
64+
**Related APIs**
65+
66+
- [`setTemplateFile`]({{ site.dbr_android_api }}barcode-scanner/barcode-scanner-config.html#settemplatefile)

programming/android/user-guide/capabilities/multi-frame-cross-filter.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
---
22
layout: default-layout
33
title: Multi-Frame Cross Filter - Dynamsoft Barcode Reader Android
4-
description: Learn how to use multi-frame cross filter for Dynamsoft Barcode Reader Android.
4+
description: Learn how to use the multi-frame cross filter in Dynamsoft Barcode Reader Android.
55
keywords: filter, Android, multi-frame cross filter
66
needAutoGenerateSidebar: true
77
needGenerateH3Content: true
88
noTitleIndex: true
99
---
1010

11-
# How to use Multi-Frame Cross Filter
11+
# How to Use Multi-Frame Cross Filter
1212

1313
> [!Important]
14-
> Multi-Frame cross filter features are internally implemented in `BarcodeScanner` component and not customizable. This page only introduces how to use them with Foundational APIs.
14+
> Multi-frame cross filter features are internally implemented in the `BarcodeScanner` component and are not customizable. This page explains how to use them with Foundational APIs.
1515
16-
Multi-Frame Cross Filter is a collection of result-filtering features designed for scanning barcodes from the camera. .
16+
Multi-frame cross filter is a collection of result-filtering features designed for camera-based barcode scanning.
1717

1818
| Filter Name | Description |
1919
| ----------- | ----------- |
20-
| Cross Verification | Improve the accuracy. |
21-
| Overlapping | Improve the read-rate of multiple barcode scanning. |
22-
| Deduplication | Remove the duplicate results. |
20+
| Cross Verification | Improves accuracy. |
21+
| Overlapping | Improves read rate for multi-barcode scanning. |
22+
| Deduplication | Removes duplicate results. |
2323

2424
## Cross Verification
2525

@@ -44,8 +44,8 @@ filter.enableResultCrossVerification(EnumCapturedResultItemType.CRIT_BARCODE, tr
4444

4545
### Set Criteria
4646

47-
- Frame Window: How many frames to check for the cross verification. Default is 5.
48-
- Min Consistent Frames: How many frames need to be consistent to pass the cross verification. Default is 2.
47+
- Frame Window: The number of frames used for cross verification. The default is 5.
48+
- Min Consistent Frames: The number of consistent frames required to pass cross verification. The default is 2.
4949

5050
<div class="sample-code-prefix"></div>
5151
>- Java
@@ -123,7 +123,7 @@ val filter: MultiFrameResultCrossFilter = MultiFrameResultCrossFilter()
123123
filter.enableResultDeduplication(EnumCapturedResultItemType.CRIT_BARCODE, true)
124124
```
125125

126-
### Set Duplicate ForgetTime
126+
### Set Duplicate Forget Time
127127

128128
<div class="sample-code-prefix"></div>
129129
>- Java

programming/android/user-guide/capabilities/read-from-camera.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ needAutoGenerateSidebar: true
1010

1111
# Read from camera
1212

13+
> [!Important]
14+
> This page is for **Foundational APIs** only. Refer to [Quick Start](../../user-guide.md) for how to scan from camera with `BarcodeScanner` component.
15+
1316
Follow these three steps to read barcodes from the camera:
1417

1518
1. Set input

0 commit comments

Comments
 (0)