Skip to content

Commit da25ff2

Browse files
update to internal commit c3b9b2f4
1 parent 5ac9b65 commit da25ff2

30 files changed

+385
-200
lines changed

_includes/sidelist-programming/programming-flutter.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@
9090
<ul lang="flutter">
9191
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router/dsrect.html" class="otherLinkColour">DSRect</a></li>
9292
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router/license-manager.html" class="otherLinkColour">LicenseManager</a></li>
93+
<li lang="flutter"><a href="{{ site.dbr_flutter_api }}capture-vision-router/quadrilateral.html" class="otherLinkColour">Quadrilateral</a></li>
9394
</ul>
9495
</li>
9596
</ul>

programming/flutter/api-reference/capture-vision-router/aztec-details.md

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

1313
The `AztecDetails` class encapsulates all of the extended details of an Aztec Code that is not available in the regular barcode result, if the barcode is an Aztec Code.
1414

15+
> [!TIP]
16+
> If you would like to learn more about the Aztec format, please refer to this [page](https://www.dynamsoft.com/barcode-reader/barcode-types/aztec-code/).
17+
1518
## Definition
1619

1720
*Assembly:* dynamsoft_capture_vision_flutter

programming/flutter/api-reference/capture-vision-router/camera-enhancer.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,25 @@ class CameraEnhancer
2222

2323
## Methods
2424

25+
| Method | Description |
26+
| ------ | ----------- |
27+
| [`close`](#close) | Closes the camera and releases the related resources. |
28+
| [`destroy`](#destroy) | Destroys the camera enhancer instance and releases the related resources on the host side. |
29+
| [`disableEnhancedFeatures`](#disableenhancedfeatures) | Disables the selected and activated enhanced features of the Camera Enhancer. |
30+
| [`enableEnhancedFeatures`](#enableenhancedfeatures) | Activates the selected enhanced features provided by the Camera Enhancer library, including the auto-zoom and smart torch features. |
31+
| [`getCameraPosition`](#getcameraposition) | Returns the current camera being used. |
32+
| [`getColourChannelUsageType`](#getcolourchannelusagetype) | Retrieves the current colour channel that is being used by the camera enhancer. |
33+
| [`getFocusMode`](#getfocusmode) | Returns the current focus mode of the camera. |
34+
| [`getScanRegion`](#getscanregion) | Returns the current scan region. |
35+
| [`open`](#open) | Opens the selected camera to begin the capture process. |
36+
| [`selectCamera`](#selectcamera) | Selects the camera based on the specified camera position. |
37+
| [`setColourChannelUsageType`](#setcolourchannelusagetype) | Defines the colour channel used by the camera enhancer. |
38+
| [`setFocus`](#setfocus) | Sets the focus point as well as the mode for the camera. |
39+
| [`setScanRegion`](#setscanregion) | Sets the scan region of the camera and displays a bordered area on the UI. |
40+
| [`setZoomFactor`](#setzoomfactor) | Sets the zoom factor of the camera. |
41+
| [`turnOffTorch`](#turnofftorch) | Turns off the camera's flashlight (if available). |
42+
| [`turnOnTorch`](#turnontorch) | Turns on the camera's flashlight (if available). |
43+
2544
### close
2645

2746
Closes the camera and releases the related resources. When the `CaptureVisionRouter` instance calls `stopCapturing`, please make sure to call this method as well to ensure that the resources are released properly.
@@ -120,6 +139,8 @@ Future<void> selectCamera(EnumCameraPosition position)
120139

121140
If you attempt to select the **backDualWideAuto** or the **backUltraWide** cameras on an Android phone, an exception will be thrown as those cameras are only available on iPhones. Supported devices include: iPhone 13 Pro, iPhone 13 Pro Max, iPhone 14 Pro, iPhone 14 Pro Max, iPhone 15 Pro, iPhone 15 Pro Max. This method must be called **after [`setInput`](capture-vision-router.md#setinput) and before the [`open`](#open) method**.
122141

142+
> *Exception* - "This camera position is only supported on iOS"
143+
123144
### setColourChannelUsageType
124145

125146
Defines the colour channel (as a [`EnumColourChannelUsageType`](../enum/colour-channel.md)) used by the camera enhancer - therefore determining whether the captured images or frames will come out in grayscale or colour (or one of the individual colours).
@@ -152,6 +173,8 @@ Future<void> setScanRegion(DSRect region) async
152173

153174
This method must be called **after [`setInput`](capture-vision-router.md#setinput) and before the [`open`](#open) method**.
154175

176+
> *Exception* - "Failed to set the scan region"
177+
155178
### setZoomFactor
156179

157180
Sets the zoom factor of the camera.

programming/flutter/api-reference/capture-vision-router/camera-view.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,17 @@ class CameraView
2222

2323
## Properties
2424

25+
| Property | Description |
26+
| -------- | ----------- |
27+
| [`cameraEnhancer`](#cameraenhancer) | Sets the `CameraEnhancer` instance that the `CameraView` is attached to. |
28+
| [`cameraToggleButton`](#cameratogglebutton) | Defines a custom widget to replace the default camera toggle button. |
29+
| [`cameraToggleButtonVisible`](#cameratogglebuttonvisible) | Determines whether the camera toggle button is visible. |
30+
| [`scanLaserVisible`](#scanlaservisible) | Determines whether the scan laser will be visible in the scan region. |
31+
| [`scanRegionMaskVisible`](#scanregionmaskvisible) | Establishes whether the scan region will be represented visually using a mask. |
32+
| [`torchButtonVisible`](#torchbuttonvisible) | Controls the visibility of the torch/flash button. |
33+
| [`torchButton`](#torchbutton) | Defines a custom `TorchButton` instead of the default torch icon. |
34+
| [`visibleLayerIds`](#visiblelayerids) | Defines which drawing layer(s) to display on the camera view. |
35+
2536
### cameraEnhancer
2637

2738
Sets the [`CameraEnhancer`](camera-enhancer.md) instance that the `CameraView` is attached to. The `CameraEnhancer` is responsible for the core camera operations, and so **this property must be defined when constructing the CameraView**.

programming/flutter/api-reference/capture-vision-router/capture-vision-router.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,8 @@ Initializes the settings of the `CaptureVisionRouter` instance using a JSON temp
184184
Future<void> initSettings(String content)
185185
```
186186

187+
> *Exception* - "Failed to initialize settings"
188+
187189
### initSettingsFromFile
188190

189191
Initializes the settings of the `CaptureVisionRouter` instance using a JSON template (as a JSON file). To learn how to use a customized JSON template, please refer to this [section of the Foundational User Guide](../../foundational-user-guide.md#using-a-json-template).
@@ -192,6 +194,8 @@ Initializes the settings of the `CaptureVisionRouter` instance using a JSON temp
192194
Future<void> initSettingsFromFile(String filePath) async
193195
```
194196

197+
> *Exception* - "Failed to initialize settings from file"
198+
195199
### outputSettings
196200

197201
Outputs the specified Capture Vision template's settings as a JSON string. If `includeDefaultValues` is set to true, the output will include the default settings values.
@@ -200,6 +204,8 @@ Outputs the specified Capture Vision template's settings as a JSON string. If `i
200204
Future<String?> outputSettings(String templateName, bool includeDefaultValues) async
201205
```
202206

207+
> *Exception* - "Failed to output settings"
208+
203209
### outputSettingsToFile
204210

205211
Outputs the specified Capture Vision template's settings to a JSON file. If `includeDefaultValues` is set to true, the output will include the default settings values.
@@ -208,6 +214,8 @@ Outputs the specified Capture Vision template's settings to a JSON file. If `inc
208214
Future<void> outputSettingsToFile(String templateName, String filePath, bool includeDefaultValues) async
209215
```
210216

217+
> *Exception* - "Failed to output settings to file"
218+
211219
### removeAllResultFilters
212220

213221
Removes all the result filters from the Capture Vision Router instance.
@@ -248,6 +256,8 @@ Resets all of the settings to their default values.
248256
Future<void> resetSettings() async
249257
```
250258

259+
> *Exception* - "Failed to reset settings"
260+
251261
### setGlobalIntraOpNumThreads
252262

253263
Sets the global number of threads used internally by the library for model execution. This parameter could help regulate the resources needed to operate the Capture Vision Router instance.
@@ -272,6 +282,8 @@ Future<void> setInput(ImageSourceAdapter input) async
272282

273283
In most cases, the `ImageSourceAdapter` that will be used is a Camera Enhancer instance to allow the user to use their phone's built-in camera. <!-- If there is a case where an external camera or image source is being used, please refer to Image -->
274284

285+
> *Exception* - "Failed to set input"
286+
275287
### startCapturing
276288

277289
Starts the capturing process using the specified template. Any result(s) (of type [`CapturedResult`](captured-result.md)) that are received while the capture process is underway will be relayed by a result receiver, which is a callback function that is triggered once a captured result is found.
@@ -284,6 +296,8 @@ Future<void> startCapturing(String templateName)
284296

285297
The template that is used during processing can be a preset template (one of [`EnumPresetTemplate`](../enum/preset-template.md)) or a customized JSON template that you create or that is provided to you by the Dynamsoft team.
286298

299+
> *Exception* - "Failed to start capturing"
300+
287301
### stopCapturing
288302

289303
Stops the capturing process and closes the camera.
@@ -304,6 +318,8 @@ Future<void> switchCapturingTemplate(String templateName) async
304318

305319
For the `templateName` input parameter, this can be either the name of the `CaptureVisionTemplate` in a custom JSON template file/string or the name of one of the preset templates available via [`EnumPresetTemplate`](../enum/preset-template.md).
306320

321+
> *Exception* - "Failed to switch template"
322+
307323
### updateSettings
308324

309325
Updates the specified template settings of the `CaptureVisionRouter` instance using a [`SimplifiedCaptureVisionSettings`](simplified-capture-vision-settings.md) object. To learn how to update the settings using the SimplifiedCaptureVisionSettings class - please refer to this [section of the Foundational User Guide](../../foundational-user-guide.md#using-simplifiedcapturevisionsettings).
@@ -316,3 +332,5 @@ Future<void> updateSettings(String templateName, SimplifiedCaptureVisionSettings
316332

317333
For the `templateName` input parameter, this can be either the name of the `CaptureVisionTemplate` in a custom JSON template file/string or the name of one of the preset templates available via [`EnumPresetTemplate`](../enum/preset-template.md).
318334

335+
> *Exception* - "Failed to update settings"
336+

programming/flutter/api-reference/capture-vision-router/datamatrix-details.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ noTitleIndex: true
1010

1111
# DataMatrixDetails
1212

13-
The `DataMatrixDetails` class encapsulates all of the extended details of a DataMatrix Code that is not available in the regular barcode result, if the barcode is a DataMatrix Code.
13+
The `DataMatrixDetails` class encapsulates all of the extended details of a DataMatrix Code that is not available in the regular barcode result, if the barcode is a DataMatrix Code.
14+
15+
> [!TIP]
16+
> If you would like to learn more about the DataMatrix format, please refer to this [page](https://www.dynamsoft.com/barcode-reader/barcode-types/dataMatrix/).
1417
1518
## Definition
1619

programming/flutter/api-reference/capture-vision-router/multi-frame-cross-filter.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,20 @@ class MultiFrameResultCrossFilter
2525

2626
## Methods
2727

28+
| Method | Description |
29+
| ------ | ----------- |
30+
| [`destroy`](#destroy) | Destroys the `MultiFrameResultCrossFilter` instance and releases the related resources on the native side. |
31+
| [`enableLatestOverlapping`](#enablelatestoverlapping) | Enables or disables the latest overlap result filtering. |
32+
| [`enableResultCrossVerification`](#enableresultcrossverification) | Enables or disables result cross verification for the specified result item types. |
33+
| [`enableResultDeduplication`](#enableresultdeduplication) | Enables or disables result deduplication for the specified result item types. |
34+
| [`getDuplicateForgetTime`](#getduplicateforgettime) | Returns the amount of time that the deduplication filter takes effect for the specified result item type(s). |
35+
| [`getMaxOverlappingFrames`](#getmaxoverlappingframes) | Returns the maximum number of overlapping frames to check for the specified result item type(s). |
36+
| [`isLatestOverlappingEnabled`](#islatestoverlappingenabled) | Checks if the latest overlapping filter is on for the specified result item type(s). |
37+
| [`isResultCrossVerificationEnabled`](#isresultcrossverificationenabled) | Checks if the cross verification filter is on for the specified result item type(s). |
38+
| [`isResultDeduplicationEnabled`](#isresultdeduplicationenabled) | Checks if the deduplication filter is on for the specified result item type(s). |
39+
| [`setDuplicateForgetTime`](#setduplicateforgettime) | Defines the amount of time that the deduplication filter takes effect for the specified result item type(s). |
40+
| [`setMaxOverlappingFrames`](#setmaxoverlappingframes) | Sets the maximum number of overlapping frames to check when the latest overlap filter is on. |
41+
2842
### destroy
2943

3044
Destroys the `MultiFrameResultCrossFilter` instance and releases the related resources on the native side.

programming/flutter/api-reference/capture-vision-router/oned-details.md

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

1313
The `OneDCodeDetails` class encapsulates all of the extended details of a 1D Code that is not available in the regular barcode result, if the barcode is a 1D Code.
1414

15+
> [!TIP]
16+
> If you would like to learn more about the 1D format, please refer to the [barcode types](https://www.dynamsoft.com/barcode-reader/barcode-types/) page and go through the list of linear barcode symbologies.
17+
1518
## Definition
1619

1720
*Assembly:* dynamsoft_capture_vision_flutter

programming/flutter/api-reference/capture-vision-router/pdf417-details.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ noTitleIndex: true
1010

1111
# PDF417Details
1212

13-
The `PDF417Details` class encapsulates all of the extended details of a PDF417 Code that is not available in the regular barcode result, if the barcode is a PDF417 Code.
13+
The `PDF417Details` class encapsulates all of the extended details of a PDF417 Code that is not available in the regular barcode result, if the barcode is a PDF417 Code.
14+
15+
> [!TIP]
16+
> If you would like to learn more about the PDF417 format, please refer to this [page](https://www.dynamsoft.com/barcode-reader/barcode-types/pdf417/).
1417
1518
## Definition
1619

programming/flutter/api-reference/capture-vision-router/qr-code-details.md

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

1313
The `QRCodeDetails` class encapsulates all of the extended details of a QR Code that is not available in the regular barcode result, if the barcode is a QR Code.
1414

15+
> [!TIP]
16+
> If you would like to learn more about the QR Code format, please refer to this [page](https://www.dynamsoft.com/barcode-reader/barcode-types/qr-code/).
17+
1518
## Definition
1619

1720
*Assembly:* dynamsoft_capture_vision_flutter

0 commit comments

Comments
 (0)