Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 46 additions & 1 deletion _includes/sidelist-programming/programming-js.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<ul lang="javascript">
<li lang="javascript">
<a target="_blank"
href="{{ site.dbr_js }}user-guide/barcode-scanner.html"
href="{{ site.dbr_js }}user-guide/index.html"
style="cursor: pointer; color: #3c3c3c"
>Read Barcodes</a
>
Expand Down Expand Up @@ -311,6 +311,13 @@
>DeformationResistedBarcodeImageUnit</a
>
</li>
<li>
<a
href="{{ site.dbr_js_api }}interfaces/eci-segment.html"
class="otherLinkColour"
>ECISegment</a
>
</li>
<li>
<a
href="{{ site.dbr_js_api }}interfaces/extended-barcode-result.html"
Expand Down Expand Up @@ -675,6 +682,30 @@
</li>
</ul>
</li>
<!-- Identity Utility -->
<li>
<a
href="{{ site.dbr_js_api }}interfaces/identity-utility/identity-utility-module-class.html"
class="otherLinkColour"
>DynamsoftIdentityUtility</a
>
<ul>
<li>
<a
href="{{ site.dbr_js_api }}interfaces/identity-utility/identity-processor.html"
class="otherLinkColour"
>IdentityProcessor</a
>
</li>
<li>
<a
href="{{ site.dbr_js_api }}interfaces/identity-utility/identity-utility-module-class.html"
class="otherLinkColour"
>IdentityUtilityModule</a
>
</li>
</ul>
</li>
<!-- DCE -->
<li>
<a href="{{ site.dce_js_api }}index.html" class="otherLinkColour"
Expand Down Expand Up @@ -976,6 +1007,13 @@
<li>
<a class="otherLinkColour">Enumerations</a>
<ul>
<li>
<a
href="{{ site.dcp_js_api }}enum-code-type.html"
class="otherLinkColour"
>EnumCodeType</a
>
</li>
<li>
<a
href="{{ site.dcp_js_api }}enum-mapping-status.html"
Expand Down Expand Up @@ -1100,6 +1138,13 @@
>Arc</a
>
</li>
<li>
<a
href="{{ site.dcvb_js_api }}core/intermediate-results/auxiliary-region-element.html"
class="otherLinkColour"
>AuxiliaryRegionElement</a
>
</li>
<li>
<a
href="{{ site.dcvb_js_api }}core/intermediate-results/binary-image-unit.html"
Expand Down
1 change: 1 addition & 0 deletions _includes/sidelist-programming/sidelist-parameters.html
Original file line number Diff line number Diff line change
Expand Up @@ -433,6 +433,7 @@
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/barcode-width-range-array.html" class="otherLinkColour">BarcodeWidthRangeArray</a></li>
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/barcode-zone-bar-count-range-array.html" class="otherLinkColour">BarcodeZoneBarCountRangeArray</a></li>
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/barcode-zone-min-distance-to-image-borders.html" class="otherLinkColour">BarcodeZoneMinDistanceToImageBorders</a></li>
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/barcode-zone-width-to-height-ratio-range-array.html" class="otherLinkColour">BarcodeZoneWidthToHeightRatioRangeArray</a></li>
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/code128-subset.html" class="otherLinkColour">Code128Subset</a></li>
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/data-matrix-module-isotropic.html" class="otherLinkColour">DataMatrixModuleIsotropic</a></li>
<li><a href="{{ site.dcvb_parameters }}barcode-format-specification/data-matrix-size-options.html" class="otherLinkColour">DataMatrixSizeOptions</a></li>
Expand Down
43 changes: 43 additions & 0 deletions llms.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
layout: null
sitemap: false
---

# Workflow Layer - Web Edition (v11.x)

> Root Documentation: https://www.dynamsoft.com/barcode-reader/docs/llms.txt
> This Layer URL: https://www.dynamsoft.com/capture-vision/docs/web/

This documentation covers Dynamsoft Barcode Reader SDK v11.x. It defines the Workflow Layer APIs for the web (JavaScript) edition.

**Language Edition:**
- JavaScript: https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/

## LLM Guidance

- This layer contains the SDK entry point (CaptureVisionRouter) and shared infrastructure for the JavaScript/web edition. Users cannot perform barcode/text/document tasks using this layer alone - Feature Layer modules must also be loaded.
- CaptureVisionRouter.capture() / CaptureVisionRouter.startCapturing() are the primary APIs; they require a template name (defined in the Core Concepts & Parameter Layer) to know what tasks to execute.
- ImageSourceAdapter is the abstract interface for image input; CameraEnhancer (from a separate package) is a concrete implementation for camera-based scanning.
- CapturedResultReceiver provides callbacks for final results; IntermediateResultReceiver provides in-process data access.
- The JavaScript edition uses ES module imports; each module (CaptureVisionRouter, Core, License, Utility, DNN, etc.) is a separate npm package under the @dynamsoft scope.
- User guides include per-module README files explaining package installation, WASM resource configuration, and framework integration.

## Related Layers

**Barcode Recognition Feature Layer APIs:**
- Server Editions: https://www.dynamsoft.com/barcode-reader/docs/server/llms.txt
- Web Edition: https://www.dynamsoft.com/barcode-reader/docs/web/llms.txt
- Mobile Editions: https://www.dynamsoft.com/barcode-reader/docs/mobile/llms.txt

**Core Concepts & Parameter Layer:**
- Parameter & Architecture Reference: https://www.dynamsoft.com/capture-vision/docs/core/llms.txt
- Barcode Knowledge Base: https://www.dynamsoft.com/barcode-reader/docs/core/llms.txt

**Other Workflow Layer Language Editions:**
- Server Editions: https://www.dynamsoft.com/capture-vision/docs/server/llms.txt
- Mobile Editions: https://www.dynamsoft.com/capture-vision/docs/mobile/llms.txt

## Pages

{% for article in site.pages %}{% if article.title %}- [{{article.title}}](https://www.dynamsoft.com{{ article.url | relative_url }}): {{ article.description }}{% endif %}
{% endfor %}
Original file line number Diff line number Diff line change
Expand Up @@ -32,23 +32,23 @@ maxImageSideLength: number;

## appendDLModelBuffer

Loads a specific data file containing recognition information. This file typically comprises a Convolutional Neural Networks (CNN) model.
Appends deep learning models to the memory buffer.

**Syntax**

```typescript
static appendDLModelBuffer(dataName: string, dataPath?: string) : Promise<void>;
static appendDLModelBuffer(dataName: string | Array<string>, dataPath?: string) : Promise<ErrorInfo>;
```

**Parameter**

`dataName` : Specifies the name of the data.
`dataName` : Specifies the names of the model files.

`dataPath`(Optional) : Specifies the path to find the data file. If not specified, the default path points to the package "dynamsoft-capture-vision-data" which has the same root path as the packag"dynamsoft-capture-vision-bundle".

**Return value**

None.
A promise that resolves when the operation has completed. It provides an object that describes the result.

**Code snippet**

Expand All @@ -64,7 +64,8 @@ CaptureVisionRouter.appendDLModelBuffer("sample-model.data")

**Remarks**

This method was renamed from `appendModelBuffer()` in Dynamsoft Barcode Reader Bundle version 11.2.2000 and Dynamsoft Capture Vision Bundle version 3.2.2000.
- This method was renamed from `appendModelBuffer()` in Dynamsoft Barcode Reader Bundle version 11.2.2000 and Dynamsoft Capture Vision Bundle version 3.2.2000.
- This method support pass an `Array<string>` in Dynamsoft Barcode Reader Bundle version 11.4.2000 and Dynamsoft Capture Vision Bundle version 3.4.2000.

## onDataLoadProgressChanged

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,10 @@ Specifies the shortest time span, in milliseconds, that must elapse between two
minImageCaptureInterval: number;
```

**Remarks**

The logic for `minImageCaptureInterval` = -1 is no longer available in CaptureVisionBundle version 3.4.2000.

## roi

Designates the region of interest (ROI) within an image, limiting the image processing activities exclusively to this specified area. It is of type `Quadrilateral`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ The `IntermediateResultManager` class is responsible for handling intermediate r
| ----------------------------------------------- | ----------------------------------------------------------------------------------- |
| [addResultReceiver()](#addresultreceiver) | Adds a `IntermediateResultReceiver` object as the receiver of intermediate results. |
| [removeResultReceiver()](#removeresultreceiver) | Removes the specified `IntermediateResultReceiver` object. |
| [removeAllResultReceivers()](#removeallresultreceivers) | Removes all `CapturedResultReceiver` objects. |
| [getOriginalImage()](#getoriginalimage) | Retrieves the original image data. |

## addResultReceiver
Expand All @@ -25,7 +26,7 @@ Adds a `IntermediateResultReceiver` object as the receiver of intermediate resul
**Syntax**

```typescript
addResultReceiver(receiver: IntermediateResultReceiver): void;
addResultReceiver(receiver: IntermediateResultReceiver): Promise<void>;
```

**Parameters**
Expand All @@ -45,7 +46,7 @@ intermediateResultReceiver.onDecodedBarcodesReceived = (result, info) => {
/* Do something with the result */
};
const intermediateResultManager = router.getIntermediateResultManager();
intermediateResultManager.addResultReceiver(intermediateResultReceiver);
await intermediateResultManager.addResultReceiver(intermediateResultReceiver);
```

**See Also**
Expand All @@ -59,7 +60,7 @@ Removes the specified `IntermediateResultReceiver` object.
**Syntax**

```typescript
removeResultReceiver(receiver: IntermediateResultReceiver): void;
removeResultReceiver(receiver: IntermediateResultReceiver): Promise<void>;
```

**Parameters**
Expand All @@ -79,15 +80,54 @@ intermediateResultReceiver.onDecodedBarcodesReceived = (result, info) => {
/* Do something with the result */
};
const intermediateResultManager = router.getIntermediateResultManager();
intermediateResultManager.addResultReceiver(intermediateResultReceiver);
await intermediateResultManager.addResultReceiver(intermediateResultReceiver);
// ...
intermediateResultManager.removeResultReceiver(intermediateResultReceiver);
await intermediateResultManager.removeResultReceiver(intermediateResultReceiver);
```

**See Also**

[IntermediateResultReceiver](../capture-vision-router/intermediate-result-receiver.md)

## removeAllResultReceivers

Removes all `CapturedResultReceiver` objects.

**Syntax**

```typescript
removeAllResultReceivers(): Promise<void>;
```

**Parameters**

None.

**Return Value**

None.

**Code snippet**

```javascript
router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
const receiver1 = new Dynamsoft.CVR.CapturedResultReceiver();
const receiver2 = new Dynamsoft.CVR.CapturedResultReceiver();
// ...
await router.addResultReceiver(receiver1);
await router.addResultReceiver(receiver2);
// ...
await router.removeAllResultReceivers();
```

**See also**

[CapturedResultReceiver](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/capture-vision-router/captured-result-receiver.html)

**Remarks**

New added in CaptureVisionBundle version 3.4.2000 & BarcodeReaderBundle version 11.4.2000.

### getOriginalImage

Retrieves the original image data.
Expand Down
Loading
Loading