Skip to content

Commit f225f2a

Browse files
Merge pull request #202 from dynamsoft-docs/preview
update to internal commit 5d5777e3
2 parents 3a84e9a + fcc384c commit f225f2a

File tree

15 files changed

+222
-37
lines changed

15 files changed

+222
-37
lines changed

_includes/sidelist-programming/programming-android.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,7 @@
271271
</li>
272272
<li lang="android"><a>Enumerations</a>
273273
<ul lang="android">
274+
<li lang="android"><a href="{{ site.dcp_android_api }}enum/code-parser.html?lang=android" class="otherLinkColour">CodeType</a></li>
274275
<li lang="android"><a href="{{ site.dcp_android_api }}enum/mapping-status.html?lang=android" class="otherLinkColour">MappingStatus</a></li>
275276
<li lang="android"><a href="{{ site.dcp_android_api }}enum/validation-status.html?lang=android" class="otherLinkColour">ValiadtionStatus</a></li>
276277
</ul>

_includes/sidelist-programming/programming-ios.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,7 @@
275275
</li>
276276
<li lang="objectivec-swift"><a>Enumerations</a>
277277
<ul lang="objectivec-swift">
278+
<li lang="objectivec-swift"><a href="{{ site.dcp_ios_api }}enum/code-type.html?lang=objc,swift" class="otherLinkColour">DSCodeType</a></li>
278279
<li lang="objectivec-swift"><a href="{{ site.dcp_ios_api }}enum/mapping-status.html?lang=objc,swift" class="otherLinkColour">DSMappingStatus</a></li>
279280
<li lang="objectivec-swift"><a href="{{ site.dcp_ios_api }}enum/validation-status.html?lang=objc,swift" class="otherLinkColour">DSValiadtionStatus</a></li>
280281
</ul>

programming/android/api-reference/capture-vision-router/auxiliary-classes/intermediate-result-receiver.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,9 @@ void onTargetROIResultsReceived(@NonNull IntermediateResult result, Intermediate
9191

9292
The callback triggered when the processing of a task is finished.
9393

94+
> [!Note]
95+
> This callback may be invoked on different threads. Ensure that any shared resources accessed within the callback are properly synchronized to avoid data corruption or crashes.
96+
9497
```java
9598
void onTaskResultsReceived(@NonNull IntermediateResult result, IntermediateResultExtraInfo info);
9699
```

programming/android/api-reference/capture-vision-router/multiple-file-processing.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,20 @@ noTitleIndex: true
1616
| [`getInput`](#getinput) | Returns the image source object. |
1717
| [`addResultReceiver`](#addresultreceiver) | Adds a [`CapturedResultReceiver`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) object as the receiver of captured results. |
1818
| [`removeResultReceiver`](#removeresultreceiver) | Removes the specified [`CapturedResultReceiver`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) object. |
19+
| [`removeAllResultReceivers`](#removeallresultreceivers) | Removes all user-added [`CapturedResultReceivers`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html). |
1920
| [`startCapturing`](#startcapturing) | Initiates a capturing process based on a specified template. This process is repeated for each image fetched from the source. |
2021
| [`stopCapturing`](#stopcapturing) | Stops the capturing process. |
2122
| [`pauseCapturing`](#pausecapturing) | Pauses the Capture Vision Router. |
2223
| [`resumeCapturing`](#resumecapturing) | Resumes the Capture Vision Router. |
2324
| [`addCaptureStateListener`](#addcapturestatelistener) | Registers a [`CaptureStateListener`](auxiliary-classes/capture-state-listener.html) to be used as a callback when capture state is received. |
2425
| [`removeCaptureStateListener`](#removecapturestatelistener) | Removes a [`CaptureStateListener`](auxiliary-classes/capture-state-listener.html) that has been configured for the Capture Vision Router. |
26+
| [`removeAllCaptureStateListeners`](#removeallcapturestatelisteners) | Removes all user-added [`CaptureStateListeners`](auxiliary-classes/capture-state-listener.html). |
2527
| [`addResultFilter`](#addresultfilter) | Adds a `CapturedResultFilter` object to filter non-essential results. |
2628
| [`removeResultFilter`](#removeresultfilter) | Removes the specified `CapturedResultFilter` object. |
29+
| [`removeAllResultFilters`](#removeallresultfilters) | Removes all user-added `CapturedResultFilters`. |
2730
| [`addImageSourceStateListener`](#addimagesourcestatelistener) | Register a [`ImageSourceStateListener`](auxiliary-classes/image-source-state-listener.html) to get callback when the status of [`ImageSourceAdapter`]({{ site.dcv_android_api }}core/basic-structures/image-source-adapter.html) received. |
2831
| [`removeImageSourceStateListener`](#removeimagesourcestatelistener) | Removes a [`ImageSourceStateListener`](auxiliary-classes/image-source-state-listener.html) from the Capture Vision Router. |
32+
| [`removeAllImageSourceStateListeners`](#removeallimagesourcestatelisteners) | Removes all user-added [`ImageSourceStateListeners`](auxiliary-classes/image-source-state-listener.html). |
2933

3034
## setInput
3135

@@ -87,6 +91,14 @@ void removeResultReceiver(CapturedResultReceiver receiver);
8791

8892
`[in] receiver`: The receiver object, of type [`CapturedResultReceiver`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html).
8993

94+
## removeAllResultReceivers
95+
96+
Removes all user-added [`CapturedResultReceivers`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html).
97+
98+
```java
99+
void removeAllResultReceivers();
100+
```
101+
90102
## startCapturing
91103

92104
Initiates a capturing process based on a specified template. This process is repeated for each image fetched from the source.
@@ -153,6 +165,14 @@ void removeResultFilter(CapturedResultFilter filter);
153165

154166
`[in] filter`: The filter object, of type [`CapturedResultFilter`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result-filter.html).
155167

168+
## removeResultFilter
169+
170+
Removes all user-added`CapturedResultFilters`.
171+
172+
```java
173+
void removeAllResultFilters();
174+
```
175+
156176
## addCaptureStateListener
157177

158178
Registers a [`CaptureStateListener`](auxiliary-classes/capture-state-listener.html) to be used as a callback when capture state is received.
@@ -177,6 +197,14 @@ void removeCaptureStateListener(CaptureStateListener listener);
177197

178198
`[in] listener`: An object of [`CaptureStateListener`](auxiliary-classes/capture-state-listener.html)
179199

200+
## removeAllCaptureStateListeners
201+
202+
Removes all user-added [`CaptureStateListeners`](auxiliary-classes/capture-state-listener.html).
203+
204+
```java
205+
void removeAllCaptureStateListeners();
206+
```
207+
180208
## addImageSourceStateListener
181209

182210
Register a [`ImageSourceStateListener`](auxiliary-classes/image-source-state-listener.html) to get callback when the status of [`ImageSourceAdapter`]({{ site.dcv_android_api }}core/basic-structures/image-source-adapter.html) received.
@@ -200,3 +228,11 @@ void removeImageSourceStateListener(ImageSourceStateListener listener);
200228
**Parameters**
201229

202230
`[in] listener`: An object of [`ImageSourceStateListener`](auxiliary-classes/image-source-state-listener.html).
231+
232+
## removeAllImageSourceStateListeners
233+
234+
Removes all user-added [`ImageSourceStateListeners`](auxiliary-classes/image-source-state-listener.html).
235+
236+
```java
237+
void removeAllImageSourceStateListeners();
238+
```

programming/android/api-reference/core/enum/error-code.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,8 @@ public @interface EnumErrorCode
137137
public static final int EC_PDF_LIBRARY_LOAD_FAILED = -10075,
138138
/*The license is initialized successfully but detected invalid content in your key.*/
139139
public static final int EC_LICENSE_WARNING = -10076,
140+
/*The template version is incompatible. Please use a compatible template.*/
141+
public static final int EC_TEMPLATE_VERSION_INCOMPATIBLE = -10081
140142
/** -20000~-29999: DLS license error code. */
141143
/** No license. */
142144
public static final int EC_NO_LICENSE = -20000,
@@ -154,6 +156,10 @@ public @interface EnumErrorCode
154156
public static final int EC_INSTANCE_COUNT_OVER_LIMIT = -20008,
155157
/** Trial License */
156158
public static final int EC_TRIAL_LICENSE = -20010,
159+
/*License authentication failed: quota exceeded.*/
160+
public static final int EC_LICENSE_AUTH_QUOTA_EXCEEDED = -20013,
161+
/**License restriction: the number of results has exceeded the allowed limit.*/
162+
public static final int EC_LICENSE_RESULTS_LIMIT_EXCEEDED = -20014,
157163
/** Failed to reach License Server. */
158164
public static final int EC_FAILED_TO_REACH_DLS = -20200,
159165
/** -30000~-39999: DBR error code. */

programming/android/api-reference/utility/image-processor.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,9 @@ class ImageProcessor
2626

2727
| Method | Description |
2828
| ------ | ----------- |
29-
| [`cropImage`](#cropimageimagedatarect) | Crops an image based on the provided rectangle or quadrilateral. |
30-
| [`cropImage`](#cropimageimagedataquad) | Crops an image based on the provided rectangle or quadrilateral. |
29+
| [`cropImage`](#cropimageimagedatarect) | Crops an image based on the provided rectangle. |
30+
| [`cropAndDeskewImage(imageData,quad,dstWidth,dstHeight,padding)`](#cropanddeskewimageimagedataquaddstwidthdstheightpaddingerrorcode) | Crops and deskew an image based on the provided quadrilateral and additional information. |
31+
| [`cropAndDeskewImage(imageData,quad)`](#cropanddeskewimageimagedataquad) | Crops and deskew an image based on the provided quadrilateral. |
3132
| [`adjustBrightness`](#adjustbrightness) | Adjusts the brightness of an image. |
3233
| [`adjustContrast`](#adjustcontrast) | Adjusts the contrast of an image. |
3334
| [`filterImage`](#filterimage) | Applies a filter to an image. |
@@ -56,23 +57,21 @@ ImageData cropImage(ImageData imageData, Rect rect) throws UtilityException{}
5657

5758
The cropped `ImageData`.
5859

59-
### cropImage(imageData,quad)
60+
### cropAndDeskewImage(imageData,quad,dstWidth,dstHeight,padding,errorCode)
6061

61-
Crops an image based on the provided quadrilateral.
62+
Crops and deskews an image based on the provided quadrilateral and additional information.
6263

6364
```java
64-
ImageData cropImage(ImageData imageData, Quadrilateral quad) throws UtilityException{}
65+
public ImageData cropAndDeskewImage(CImageData imageData, CQuadrilateral quad, int dstWidth, int dstHeight, int padding) throws UtilityException{}
6566
```
6667

67-
**Parameters**
68-
69-
`[in] imageData`: The `ImageData` to modify.
70-
71-
`[in] quad`: The `Quadrilateral` to crop the image.
68+
### cropAndDeskewImage(imageData,quad)
7269

73-
**Return Value**
70+
Crops and deskews an image based on the provided quadrilateral. The arguments dstWidth, dstHeight, and padding are set to 0.
7471

75-
The cropped `ImageData`.
72+
```java
73+
public ImageData cropAndDeskewImage(CImageData imageData, CQuadrilateral quad) throws UtilityException{}
74+
```
7675

7776
### adjustBrightness
7877

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

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

1010
# Release Notes - DynamsoftCaptureVision Android v3.x
1111

12+
## 3.0.5000 (07/29/2025)
13+
14+
### New
15+
16+
- **Supported 16 KB page sizes**.
17+
18+
### Changed
19+
20+
- **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.
21+
22+
### Fixed
23+
24+
- Fixed various minor bugs and improved overall stability.
25+
1226
## 3.0.3100 (05/30/2025)
1327

1428
### Fixed

programming/android/release-notes/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ noTitleIndex: true
99

1010
# Release Notes Index - DynamsoftCaptureVisionBundle Android
1111

12+
- [3.0.5000 (07/29/2025)](android-3.html#305000-07292025)
1213
- [3.0.3100 (05/30/2025)](android-3.html#303100-05302025)
1314
- [3.0.3000 (05/15/2025)](android-3.html#303000-05152025)
1415
- [2.6.1003 (01/23/2025)](android-2.html#261003-01232025)

programming/android/user-guide/mrz.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,13 +118,13 @@ The MRZ (Machine Readable Zone) in TD3 format consists of 2 lines, with each lin
118118
>1.
119119
```groovy
120120
dependencies {
121-
implementation 'com.dynamsoft:mrzscannerbundle:3.0.3100'
121+
implementation 'com.dynamsoft:mrzscannerbundle:3.0.5000'
122122
}
123123
```
124124
2.
125125
```kotlin
126126
dependencies {
127-
implementation("com.dynamsoft:mrzscannerbundle:3.0.3100")
127+
implementation("com.dynamsoft:mrzscannerbundle:3.0.5000")
128128
}
129129
```
130130

programming/ios/api-reference/capture-vision-router/multiple-file-processing.md

Lines changed: 84 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,25 @@ noTitleIndex: true
1212

1313
| Method | Description |
1414
| ------ | ----------- |
15-
| [`setInput`](#setinput) | Sets an image source that will provide images to be consecutively processed. |
16-
| [`getInput`](#getinput) | Gets the attached image source adapter object of the Capture Vision Router. |
17-
| [`addImageSourceStateListener`](#addimagesourcestatelistener) | Registers a `DSImageSourceStateListener` object to be used as a callback when the status of `DSImageSourceAdapter` changes. |
18-
| [`removeImageSourceStateListener`](#removeimagesourcestatelistener) | Removes a `DSImageSourceStateListener` from the Capture Vision Router. |
15+
| [`setInput`](#setinput) | Sets up an image source to provide images for continuous processing. |
16+
| [`getInput`](#getinput) | Returns the image source object. |
1917
| [`addResultReceiver`](#addresultreceiver) | Adds a [`CapturedResultReceiver`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) object as the receiver of captured results. |
2018
| [`removeResultReceiver`](#removeresultreceiver) | Removes the specified [`CapturedResultReceiver`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) object. |
19+
| [`removeAllResultReceivers`](#removeallresultreceivers) | Removes all user-added [`CapturedResultReceivers`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html). |
2120
| [`startCapturing`](#startcapturing) | Initiates a capturing process based on a specified template. This process is repeated for each image fetched from the source. |
2221
| [`stopCapturing`](#stopcapturing) | Stops the capturing process. |
23-
| [`pauseCapturing`](#pausecapturing) | Pauses the capturing process. |
24-
| [`resumeCapturing`](#resumecapturing) | Resumes the capturing process. |
25-
| [`addCaptureStateListener`](#addcapturestatelistener) | Registers a `DSCaptureStateListener` to be used as a callback when capture state changes. |
26-
| [`removeCaptureStateListener`](#removecapturestatelistener) | Removes a `DSCaptureStateListener` that has been configured for the Capture Vision Router. |
27-
| [`addResultFilter`](#addresultfilter) | Adds a `DSCapturedResultFilter` object to filter non-essential results. |
28-
| [`removeResultFilter`](#removeresultfilter) | Removes the specified `DSCapturedResultFilter` object. |
22+
| [`pauseCapturing`](#pausecapturing) | Pauses the Capture Vision Router. |
23+
| [`resumeCapturing`](#resumecapturing) | Resumes the Capture Vision Router. |
24+
| [`addCaptureStateListener`](#addcapturestatelistener) | Registers a [`CaptureStateListener`](auxiliary-classes/capture-state-listener.html) to be used as a callback when capture state is received. |
25+
| [`removeCaptureStateListener`](#removecapturestatelistener) | Removes a [`CaptureStateListener`](auxiliary-classes/capture-state-listener.html) that has been configured for the Capture Vision Router. |
26+
| [`removeAllCaptureStateListeners`](#removeallcapturestatelisteners) | Removes all user-added [`CaptureStateListeners`](auxiliary-classes/capture-state-listener.html). |
27+
| [`addResultFilter`](#addresultfilter) | Adds a `CapturedResultFilter` object to filter non-essential results. |
28+
| [`removeResultFilter`](#removeresultfilter) | Removes the specified `CapturedResultFilter` object. |
29+
| [`removeAllResultFilters`](#removeallresultfilters) | Removes all user-added `CapturedResultFilters`. |
30+
| [`addImageSourceStateListener`](#addimagesourcestatelistener) | Register a [`ImageSourceStateListener`](auxiliary-classes/image-source-state-listener.html) to get callback when the status of [`ImageSourceAdapter`]({{ site.dcv_android_api }}core/basic-structures/image-source-adapter.html) received. |
31+
| [`removeImageSourceStateListener`](#removeimagesourcestatelistener) | Removes a [`ImageSourceStateListener`](auxiliary-classes/image-source-state-listener.html) from the Capture Vision Router. |
32+
| [`removeAllImageSourceStateListeners`](#removeallimagesourcestatelisteners) | Removes all user-added [`ImageSourceStateListeners`](auxiliary-classes/image-source-state-listener.html). |
33+
2934

3035
## setInput
3136

@@ -131,6 +136,23 @@ func removeImageSourceStateListener(_ listener:DSImageSourceStateListener) -> BO
131136

132137
A BOOL value that indicates whether the `DSImageSourceStateListener` is removed successfully.
133138

139+
## removeAllImageSourceStateListeners
140+
141+
Removes all user-added `DSImageSourceStateListeners`.
142+
143+
<div class="sample-code-prefix"></div>
144+
>- Objective-C
145+
>- Swift
146+
>
147+
>1.
148+
```objc
149+
- (BOOL)removeAllImageSourceStateListeners;
150+
```
151+
2.
152+
```swift
153+
func removeAllImageSourceStateListeners()
154+
```
155+
134156
## addResultReceiver
135157

136158
Adds a [`CapturedResultReceiver`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html) object as the receiver of captured results.
@@ -181,6 +203,23 @@ func removeResultReceiver(_ listener:DSCapturedResultReceiver) -> BOOL
181203

182204
A BOOL value that indicates whether the result receiver is removed successfully.
183205

206+
## removeAllResultReceivers
207+
208+
Removes all user-added [`CapturedResultReceivers`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html).
209+
210+
<div class="sample-code-prefix"></div>
211+
>- Objective-C
212+
>- Swift
213+
>
214+
>1.
215+
```objc
216+
- (void)removeAllResultReceivers;
217+
```
218+
2.
219+
```swift
220+
func removeAllResultReceivers()
221+
```
222+
184223
## startCapturing
185224

186225
Initiates a capturing process based on a specified template. This process is repeated for each image fetched from the source.
@@ -196,7 +235,7 @@ Initiates a capturing process based on a specified template. This process is rep
196235
```
197236
2.
198237
```swift
199-
func startCapturing(_ templateName:String) -> BOOL
238+
func startCapturing(_ templateName:String, completionHandler: ((Bool, (any Error)?) -> Void)? = nil)
200239
```
201240

202241
**Parameters**
@@ -325,6 +364,23 @@ func removeCaptureStateListener(_ listener:DSCaptureStateListener) -> BOOL
325364

326365
A BOOL value that indicates whether the capture state listener is removed successfully.
327366

367+
## removeAllCaptureStateListeners
368+
369+
Removes all user-added `DSCaptureStateListeners`.
370+
371+
<div class="sample-code-prefix"></div>
372+
>- Objective-C
373+
>- Swift
374+
>
375+
>1.
376+
```objc
377+
- (BOOL)removeAllCaptureStateListeners;
378+
```
379+
2.
380+
```swift
381+
func removeAllCaptureStateListeners()
382+
```
383+
328384
## addResultFilter
329385

330386
Adds a [`DSCapturedResultFilter`]({{ site.dcv_ios_api }}capture-vision-router/auxiliary-classes/captured-result-filter.html) object to filter non-essential results. Currnetly, is must be a [`MultiFrameCrossFilter`]({{ site.dcv_ios_api }}utility/multi-frame-result-cross-filter.html) object.
@@ -374,3 +430,20 @@ func removeResultFilter(_ filter:DSCapturedResultFilter) -> BOOL
374430
**Return Value**
375431

376432
A BOOL value that indicates whether the result filter is removed successfully.
433+
434+
## removeAllResultFilters
435+
436+
Removes all user-added `DSCapturedResultFilters`.
437+
438+
<div class="sample-code-prefix"></div>
439+
>- Objective-C
440+
>- Swift
441+
>
442+
>1.
443+
```objc
444+
- (BOOL)removeAllResultFilters;
445+
```
446+
2.
447+
```swift
448+
func removeAllResultFilters()
449+
```

0 commit comments

Comments
 (0)