Skip to content

Commit 9ac51be

Browse files
Merge pull request #355 from dynamsoft-docs/preview
update to internal commit f697990d
2 parents 1d9a51b + 691ce65 commit 9ac51be

File tree

15 files changed

+171
-26
lines changed

15 files changed

+171
-26
lines changed

_includes/sidelist-programming/programming-android.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,7 @@
293293
</li>
294294
<li lang="android"><a>Enumerations</a>
295295
<ul lang="android">
296+
<li lang="android"><a href="{{ site.dcp_android_api }}enum/code-type.html?lang=android" class="otherLinkColour">CodeType</a></li>
296297
<li lang="android"><a href="{{ site.dcp_android_api }}enum/mapping-status.html?lang=android" class="otherLinkColour">MappingStatus</a></li>
297298
<li lang="android"><a href="{{ site.dcp_android_api }}enum/validation-status.html?lang=android" class="otherLinkColour">ValiadtionStatus</a></li>
298299
</ul>

_includes/sidelist-programming/programming-oc.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,7 @@
292292
</li>
293293
<li lang="objectivec-swift"><a>Enumerations</a>
294294
<ul lang="objectivec-swift">
295+
<li lang="objectivec-swift"><a href="{{ site.dcp_ios_api }}code-parser/enum/code-type.html?lang=objc,swift" class="otherLinkColour">DSCodeType</a></li>
295296
<li lang="objectivec-swift"><a href="{{ site.dcp_ios_api }}code-parser/enum/mapping-status.html?lang=objc,swift" class="otherLinkColour">DSMappingStatus</a></li>
296297
<li lang="objectivec-swift"><a href="{{ site.dcp_ios_api }}code-parser/enum/validation-status.html?lang=objc,swift" class="otherLinkColour">DSValiadtionStatus</a></li>
297298
</ul>

programming/android/api-reference/auxiliary-PDF417Details.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ class PDF417Details extends BarcodeDetails
2929
| ------ | ----------- |
3030
| [`PDF417Details`](#pdf417details-1) | The constructor. Initializes a new instance of the `PDF417Details` class. |
3131
| [`getRows`](#getrows) | Returns the number of rows in the PDF417 barcode. |
32+
| [`getCodewords`](#getcodewords) | Returns the code words of the PDF417 barcode. |
3233
| [`getColumns`](#getcolumns) | Returns the number of columns in the PDF417 barcode. |
3334
| [`getErrorCorrectionLevel`](#geterrorcorrectionlevel) | Returns the error correction level of PDF417 code. |
3435
| [`hasLeftRowIndicator`](#hasleftrowindicator) | Indicates whether the left row indicator of the PDF417 code exists. |
@@ -54,6 +55,18 @@ int getRows();
5455

5556
An integer representing the number of rows in the PDF417 barcode.
5657

58+
### getCodewords
59+
60+
Returns the code words of the PDF417 barcode.
61+
62+
```java
63+
byte[] getCodewords();
64+
```
65+
66+
**Return Value**
67+
68+
An array of bytes representing the code words of the PDF417 barcode.
69+
5770
### getColumns
5871

5972
Returns the number of columns in the PDF417 barcode, indicating how many columns of modules it contains.

programming/android/api-reference/barcode-scanner/barcode-scanner-config.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,25 +33,29 @@ final class BarcodeScannerConfig
3333
| [`setScanRegion`](#setscanregion) | Sets a scan region where only the barcodes located in the scan region can be decoded. |
3434
| [`setTorchButtonVisible`](#settorchbuttonvisible) | Sets whether to display the torch button when scanning or not. |
3535
| [`setBeepEnabled`](#setbeepenabled) | Sets whether to trigger a beep sound when a barcode is detected. |
36+
| [`setVibrateEnabled`](#setvibrateenabled) | Sets whether to trigger a vibration when a barcode is detected. |
3637
| [`setScanLaserVisible`](#setscanlaservisible) | Sets whether to display a scan laser when scanning. |
3738
| [`setAutoZoomEnabled`](#setautozoomenabled) | Sets whether to enable the auto-zoom feature when scanning. |
3839
| [`setCloseButtonVisible`](#setclosebuttonvisible) | Sets whether to display a button that can close the scanner page. |
3940
| [`setMaxConsecutiveStableFramesToExit`](#setmaxconsecutivestableframestoexit) | Sets how long the library will keep scanning when there is no more barcodes to decode. |
4041
| [`setExpectedBarcodesCount`](#setexpectedbarcodescount) | Sets the expected number of barcodes. The multiple barcodes scanning will be stopped when the `expectedBarcodesCount` is reached. |
4142
| [`setCameraToggleButtonVisible`](#setcameratogglebuttonvisible) | Sets whether to display the camera toggle button. |
43+
| [`setZoomFactor`](#setzoomfactor) | Sets the zoom factor. |
4244
| [`getLicense`](#getlicense) | Returns the license key string. |
4345
| [`getScanningMode`](#getscanningmode) | Returns the scanning mode. |
4446
| [`getTemplateFile`](#gettemplatefile) | Returns the template with a file path or a JSON string. |
4547
| [`isTorchButtonVisible`](#istorchbuttonvisible) | Returns whether the button is visible. |
4648
| [`getBarcodeFormats`](#getbarcodeformats) | Returns the barcode format(s) that the library will accept. |
4749
| [`getScanRegion`](#getscanregion) | Returns the scan region. |
4850
| [`isBeepEnabled`](#isbeepenabled) | Returns whether the beep sound is enabled. |
51+
| [`isVibrateEnabled`](#isvibrateenabled) | Returns whether the vibration is enabled. |
4952
| [`isScanLaserVisible`](#isscanlaservisible) | Returns whether the scan laser is visible. |
5053
| [`isAutoZoomEnabled`](#isautozoomenabled) | Returns whether the auto-zoom feature is enabled. |
5154
| [`isCloseButtonVisible`](#isclosebuttonvisible) | Returns whether the close button is visible. |
5255
| [`getMaxConsecutiveStableFramesToExit`](#getmaxconsecutivestableframestoexit) | Returns the maximum number of consecutive stable frames to exit. |
5356
| [`getExpectedBarcodesCount`](#getexpectedbarcodescount) | Returns the expected number of barcodes. |
5457
| [`isCameraToggleButtonVisible`](#iscameratogglebuttonvisible) | Returns whether the camera toggle button is visible. |
58+
| [`getZoomFactor`](#getzoomfactor) | Gets the zoom factor. |
5559

5660
### setLicense
5761

@@ -137,6 +141,18 @@ void setBeepEnabled(boolean beepEnabled);
137141

138142
`beepEnabled`: A boolean value that determines whether to enable the beep sound.
139143

144+
### setVibrateEnabled
145+
146+
Sets whether to trigger a vibration when a barcode is detected.
147+
148+
```java
149+
void setVibrateEnabled(boolean vibrateEnabled);
150+
```
151+
152+
**Parameter(s)**
153+
154+
`vibrateEnabled`: A boolean value that determines whether to enable the vibration.
155+
140156
### setScanLaserVisible
141157

142158
Sets whether to display a scan laser when scanning.
@@ -209,6 +225,18 @@ void setCameraToggleButtonVisible(boolean cameraToggleButtonVisible);
209225

210226
`cameraToggleButtonVisible`: A boolean value that determines whether to display the camera toggle button.
211227

228+
### setZoomFactor
229+
230+
Sets the zoom factor.
231+
232+
```java
233+
void setZoomFactor(float zoomFactor);
234+
```
235+
236+
**Parameter(s)**
237+
238+
`zoomFactor`: The zoom factor.
239+
212240
### getLicense
213241

214242
Returns the license key string.
@@ -293,6 +321,18 @@ boolean isBeepEnabled();
293321

294322
A boolean value that determines whether the beep sound is enabled.
295323

324+
### isVibrateEnabled
325+
326+
Returns a boolean indicating whether or not the vibration is enabled.
327+
328+
```java
329+
boolean isVibrateEnabled();
330+
```
331+
332+
**Return Value**
333+
334+
A boolean value that determines whether the vibration is enabled.
335+
296336
### isScanLaserVisible
297337

298338
Returns a boolean indicating whether or not the scan laser is visible.
@@ -364,3 +404,15 @@ boolean isCameraToggleButtonVisible();
364404
**Return Value**
365405

366406
A boolean value that determines whether the camera toggle button is displayed.
407+
408+
### getZoomFactor
409+
410+
Returns the zoom factor.
411+
412+
```java
413+
float getZoomFactor();
414+
```
415+
416+
**Return Value**
417+
418+
`zoomFactor`: The zoom factor.

programming/android/foundational-guide.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@ noTitleIndex: true
1414

1515
- Supported OS: Android 5.0 (API Level 21) or higher.
1616
- Supported ABI: **armeabi-v7a**, **arm64-v8a**, **x86** and **x86_64**.
17-
- Development Environment: Android Studio 2022.2.1 or higher.
17+
- Development Environment:
18+
- IDE: **Android Studio 2024.3.2** suggested.
19+
- JDK: **Java 17** or higher.
20+
- Gradle: **8.0** or higher.
1821

1922
## Add the Libraries
2023

@@ -66,13 +69,13 @@ There are two ways to add the libraries into your project - **Manually** and **M
6669
>1.
6770
```groovy
6871
dependencies {
69-
implementation 'com.dynamsoft:barcodereaderbundle:11.0.3000'
72+
implementation 'com.dynamsoft:barcodereaderbundle:11.0.5000'
7073
}
7174
```
7275
2.
7376
```kotlin
7477
dependencies {
75-
implementation("com.dynamsoft:barcodereaderbundle:11.0.3000")
78+
implementation("com.dynamsoft:barcodereaderbundle:11.0.5000")
7679
}
7780
```
7881

@@ -97,7 +100,7 @@ There are two ways to add the libraries into your project - **Manually** and **M
97100
```groovy
98101
dependencies {
99102
implementation fileTree(dir: 'libs', include: ['*.aar'])
100-
def camerax_version = '1.3.4'
103+
def camerax_version = '1.4.2'
101104
implementation "androidx.camera:camera-core:$camerax_version"
102105
implementation "androidx.camera:camera-camera2:$camerax_version"
103106
implementation "androidx.camera:camera-lifecycle:$camerax_version"
@@ -106,14 +109,13 @@ There are two ways to add the libraries into your project - **Manually** and **M
106109
```
107110
2.
108111
```kotlin
109-
val camerax_version = "1.3.4"
112+
val camerax_version = "1.4.2"
110113
dependencies {
111114
implementation(fileTree(mapOf("dir" to "libs", "include" to listOf("*.aar"))))
112115
implementation("androidx.camera:camera-core:$camerax_version")
113116
implementation("androidx.camera:camera-camera2:$camerax_version")
114117
implementation("androidx.camera:camera-lifecycle:$camerax_version")
115118
implementation("androidx.camera:camera-view:$camerax_version")
116-
implementation(platform("org.jetbrains.kotlin:kotlin-bom:1.8.0"))
117119
}
118120
```
119121

@@ -129,7 +131,7 @@ In this section, we are going to explain how to create a Hello World implementat
129131

130132
> [!NOTE]
131133
>
132-
> - Android Studio 2024.1.2 is used here in this guide.
134+
> - Android Studio 2024.3.2 is used here in this guide.
133135
> - You can get similar source code from
134136
> - <a href="https://github.com/Dynamsoft/barcode-reader-mobile-samples/tree/main/android/FoundationalAPISamples/DecodeWithCameraEnhancer" target="_blank">DecodeWithCameraEnhancer Sample (Java)</a>
135137
> - DynamsoftCameraEnhancer library is used for camera capture in this guide below. If you use the Android CameraX SDK for camera capture, check [DecodeWithCameraX sample](https://github.com/Dynamsoft/barcode-reader-mobile-samples/tree/main/android/FoundationalAPISamples/DecodeWithCameraX){:target="_blank"} on how to add barcode scanning to your app.

programming/android/release-notes/android-11.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,20 @@ noTitleIndex: true
1010

1111
# Release Notes for Android SDK - 11.x
1212

13+
## 11.0.5000 (07/29/2025)
14+
15+
### New
16+
17+
- **Supported 16 KB page sizes**.
18+
19+
### Changed
20+
21+
- **License Validation Behavior**: Instead of stopping execution immediately on an invalid license module, the library now continues processing and returns results from modules with valid licenses. An error is still reported to indicate the license issue.
22+
23+
### Fixed
24+
25+
- Fixed various minor bugs and improved overall stability.
26+
1327
## 11.0.3100 (05/30/2025)
1428

1529
### Fixed

programming/android/release-notes/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ permalink: /programming/android/release-notes/
1010

1111
# Dynamsoft Barcode Reader Android SDK - Release Notes
1212

13+
- [11.0.5000 (07/29/2025)]({{ site.android_release_notes }}android-11.html#1105000-07292025)
1314
- [11.0.3000 (05/15/2025)]({{ site.android_release_notes }}android-11.html#1103000-05152025)
1415
- [10.4.3002 (03/07/2025)]({{ site.android_release_notes }}android-10.html#1043002-03072025)
1516
- [10.4.3001 (02/11/2025)]({{ site.android_release_notes }}android-10.html#1043001-02112025)

programming/android/upgrade.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,6 @@ pageStartVer: 10.0
5050
}
5151
```
5252

53-
> Note: If you are using gradle 6.x or older version, the maven dependencies should be configured in `[App Project Root Path]\app\build.gradle`
54-
5553
2. Open the file `[App Project Root Path]\app\build.gradle` and add the dependencies:
5654

5755
<div class="sample-code-prefix"></div>
@@ -94,24 +92,22 @@ pageStartVer: 10.0
9492
```groovy
9593
dependencies {
9694
implementation fileTree(dir: 'libs', include: ['*.aar'])
97-
def camerax_version = '1.3.4'
95+
def camerax_version = '1.4.2'
9896
implementation "androidx.camera:camera-core:$camerax_version"
9997
implementation "androidx.camera:camera-camera2:$camerax_version"
10098
implementation "androidx.camera:camera-lifecycle:$camerax_version"
10199
implementation "androidx.camera:camera-view:$camerax_version"
102-
implementation(platform("org.jetbrains.kotlin:kotlin-bom:1.8.0"))
103100
}
104101
```
105102
2.
106103
```kotlin
107-
val camerax_version = "1.3.4"
104+
val camerax_version = "1.4.2"
108105
dependencies {
109106
implementation(fileTree(mapOf("dir" to "libs", "include" to listOf("*.aar"))))
110107
implementation("androidx.camera:camera-core:$camerax_version")
111108
implementation("androidx.camera:camera-camera2:$camerax_version")
112109
implementation("androidx.camera:camera-lifecycle:$camerax_version")
113110
implementation("androidx.camera:camera-view:$camerax_version")
114-
implementation(platform("org.jetbrains.kotlin:kotlin-bom:1.8.0"))
115111
}
116112
```
117113

programming/android/user-guide.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,10 @@ This user guide will walk through the [ScanSingleBarcode](https://github.com/Dyn
2323

2424
- Supported OS: **Android 5.0** (API Level 21) or higher.
2525
- Supported ABI: **armeabi-v7a**, **arm64-v8a**, **x86** and **x86_64**.
26-
- Development Environment: **Android Studio 2022.2.1** or higher.
26+
- Development Environment:
27+
- IDE: **Android Studio 2024.3.2** suggested.
28+
- JDK: **Java 17** or higher.
29+
- Gradle: **8.0** or higher.
2730

2831
## Add the SDK
2932

@@ -64,8 +67,6 @@ There are two ways in which you can include the `dynamsoftbarcodereaderbundle` l
6467
}
6568
```
6669

67-
> Note: If you are using gradle 6.x or older version, the maven dependencies should be configured in `[App Project Root Path]\app\build.gradle`
68-
6970
2. Open the file `[App Project Root Path]\app\build.gradle` and add the dependencies:
7071

7172
<div class="sample-code-prefix"></div>
@@ -75,13 +76,13 @@ There are two ways in which you can include the `dynamsoftbarcodereaderbundle` l
7576
>1.
7677
```groovy
7778
dependencies {
78-
implementation 'com.dynamsoft:barcodereaderbundle:11.0.3100'
79+
implementation 'com.dynamsoft:barcodereaderbundle:11.0.5000'
7980
}
8081
```
8182
2.
8283
```kotlin
8384
dependencies {
84-
implementation("com.dynamsoft:barcodereaderbundle:11.0.3100")
85+
implementation("com.dynamsoft:barcodereaderbundle:11.0.5000")
8586
}
8687
```
8788

@@ -106,24 +107,22 @@ There are two ways in which you can include the `dynamsoftbarcodereaderbundle` l
106107
```groovy
107108
dependencies {
108109
implementation fileTree(dir: 'libs', include: ['*.aar'])
109-
def camerax_version = '1.3.4'
110+
def camerax_version = '1.4.2'
110111
implementation "androidx.camera:camera-core:$camerax_version"
111112
implementation "androidx.camera:camera-camera2:$camerax_version"
112113
implementation "androidx.camera:camera-lifecycle:$camerax_version"
113114
implementation "androidx.camera:camera-view:$camerax_version"
114-
implementation(platform("org.jetbrains.kotlin:kotlin-bom:1.8.0"))
115115
}
116116
```
117117
2.
118118
```kotlin
119-
val camerax_version = "1.3.4"
119+
val camerax_version = "1.4.2"
120120
dependencies {
121121
implementation(fileTree(mapOf("dir" to "libs", "include" to listOf("*.aar"))))
122122
implementation("androidx.camera:camera-core:$camerax_version")
123123
implementation("androidx.camera:camera-camera2:$camerax_version")
124124
implementation("androidx.camera:camera-lifecycle:$camerax_version")
125125
implementation("androidx.camera:camera-view:$camerax_version")
126-
implementation(platform("org.jetbrains.kotlin:kotlin-bom:1.8.0"))
127126
}
128127
```
129128

programming/objectivec-swift/api-reference/auxiliary-iPDF417Details.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ class PDF417Details : BarcodeDetails
3535
| Attributes | Type | Description |
3636
| ---------- | ---- | ----------- |
3737
| [`rows`](#rows) | *NSInteger* | The number of rows in the PDF417 barcode. |
38+
| [`codewords`](#columns) | *NSData* | The codewords of the PDF417 barcode. |
3839
| [`columns`](#columns) | *NSInteger* | The number of columns in the PDF417 barcode. |
3940
| [`errorCorrectionLevel`](#errorcorrectionlevel) | *NSInteger* | The error correction level of PDF417 code. |
4041
| [`hasLeftRowIndicator`](#hasleftrowindicator) | *NSInteger* |Indicates whether the left row indicator of the PDF417 code exists. |
@@ -57,6 +58,23 @@ The number of rows in the PDF417 barcode, indicating how many rows of modules it
5758
var rows: Int { get }
5859
```
5960

61+
### codewords
62+
63+
The codewords of the PDF417 barcode.
64+
65+
<div class="sample-code-prefix"></div>
66+
>- Objective-C
67+
>- Swift
68+
>
69+
>1.
70+
```objc
71+
@property (nonatomic, readonly, retain) NSData *codewords;
72+
```
73+
2.
74+
```swift
75+
var codewords: Data { get }
76+
```
77+
6078
### columns
6179

6280
The number of columns in the PDF417 barcode, indicating how many columns of modules it contains.

0 commit comments

Comments
 (0)