From ba9be2322ea60b45f2eeeebd2445bf8ffe2f7aba Mon Sep 17 00:00:00 2001 From: DMGithubPublisher Date: Fri, 3 Jan 2025 15:02:20 +0800 Subject: [PATCH] update to internal commit d9a90e47 --- _data/full_tree.yml | 2 + _data/product_version.yml | 3 +- .../programming-js-v2.4.2200.html | 1467 +++++++++++++++++ .../sidelist-programming/programming-js.html | 14 + .../sidelist-parameters.html | 207 +++ .../sidelist-understanding-v2.4.2200.html | 5 + .../sidelist-understanding.html | 3 +- .../capture-vision-router-module-v2.0.10.md | 2 +- .../capture-vision-router-module-v2.0.32.md | 2 +- .../capture-vision-router-module-v2.2.10.md | 2 +- .../capture-vision-router-module-v2.4.2200.md | 167 ++ .../capture-vision-router-module.md | 5 +- .../intermediate-result-receiver-v2.4.2200.md | 701 ++++++++ .../intermediate-result-receiver.md | 26 +- .../settings-v2.4.2200.md | 208 +++ .../capture-vision-router/settings.md | 22 + ...3.md => captured-result-item-v2.2.3000.md} | 0 ...3.0.10.md => captured-result-v2.2.3000.md} | 0 .../core/basic-structures/quadrilateral.md | 5 + ...2.30.md => core-module-class-v2.2.3000.md} | 0 ...le-v3.0.33.md => core-module-v2.2.3000.md} | 0 .../api-reference/core/core-module-v3.0.10.md | 143 -- .../api-reference/core/core-module.md | 7 +- ...0.md => image-source-adapter-v2.2.3000.md} | 1 - programming/javascript/api-reference/index.md | 237 ++- ...lti-frame-result-cross-filter-v2.4.2200.md | 234 +++ .../multi-frame-result-cross-filter.md | 89 + .../utility/utility-module-v2.4.2200.md | 44 + .../api-reference/utility/utility-module.md | 6 +- programming/javascript/release-notes/dcvb.md | 39 + programming/javascript/release-notes/index.md | 1 + 31 files changed, 3474 insertions(+), 168 deletions(-) create mode 100644 _includes/sidelist-programming/programming-js-v2.4.2200.html create mode 100644 _includes/sidelist-programming/sidelist-parameters.html create mode 100644 _includes/sidelist-programming/sidelist-understanding-v2.4.2200.html create mode 100644 programming/javascript/api-reference/capture-vision-router/capture-vision-router-module-v2.4.2200.md create mode 100644 programming/javascript/api-reference/capture-vision-router/intermediate-result-receiver-v2.4.2200.md create mode 100644 programming/javascript/api-reference/capture-vision-router/settings-v2.4.2200.md rename programming/javascript/api-reference/core/basic-structures/{captured-result-item-v3.0.33.md => captured-result-item-v2.2.3000.md} (100%) rename programming/javascript/api-reference/core/basic-structures/{captured-result-v3.0.10.md => captured-result-v2.2.3000.md} (100%) rename programming/javascript/api-reference/core/{core-module-class-v3.2.30.md => core-module-class-v2.2.3000.md} (100%) rename programming/javascript/api-reference/core/{core-module-v3.0.33.md => core-module-v2.2.3000.md} (100%) delete mode 100644 programming/javascript/api-reference/core/core-module-v3.0.10.md rename programming/javascript/api-reference/core/{image-source-adapter-v3.0.10.md => image-source-adapter-v2.2.3000.md} (99%) create mode 100644 programming/javascript/api-reference/utility/multi-frame-result-cross-filter-v2.4.2200.md create mode 100644 programming/javascript/api-reference/utility/utility-module-v2.4.2200.md diff --git a/_data/full_tree.yml b/_data/full_tree.yml index 8b9e2b1..29b678d 100644 --- a/_data/full_tree.yml +++ b/_data/full_tree.yml @@ -4,7 +4,9 @@ tree_file_list: - sidelist-programming/sidelist-performance.html - sidelist-programming/sidelist-parameters-organization.html - sidelist-programming/sidelist-parameter-reference.html + - sidelist-programming/sidelist-parameters.html - sidelist-programming/sidelist-understanding.html - sidelist-programming/programming-js.html - sidelist-programming/programming-js-v2.2.3000.html + - sidelist-programming/programming-js-v2.4.2200.html diff --git a/_data/product_version.yml b/_data/product_version.yml index 35cac22..00f029b 100644 --- a/_data/product_version.yml +++ b/_data/product_version.yml @@ -1,7 +1,8 @@ useGroupedVersion: true version_info_list: - - value: latest version(2.4.2200) + - value: latest version(2.6.1000) - value: 2.x child: + - 2.4.2200 - 2.2.3000 \ No newline at end of file diff --git a/_includes/sidelist-programming/programming-js-v2.4.2200.html b/_includes/sidelist-programming/programming-js-v2.4.2200.html new file mode 100644 index 0000000..6be70ab --- /dev/null +++ b/_includes/sidelist-programming/programming-js-v2.4.2200.html @@ -0,0 +1,1467 @@ +
  • DEVELOPMENT
    • +
  • + User Guide + +
    • +
  • + API Reference + +
    • +{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-understanding.html" -%} +
  • USEFUL RESOURCES
    • +
  • + Release Notes + +
    • +
  • License Initialization
    • \ No newline at end of file diff --git a/_includes/sidelist-programming/programming-js.html b/_includes/sidelist-programming/programming-js.html index 6be70ab..49c8778 100644 --- a/_includes/sidelist-programming/programming-js.html +++ b/_includes/sidelist-programming/programming-js.html @@ -568,6 +568,13 @@ >DetectedQuadsUnit +
  • + LogicLinesUnit +
  • CornerType
    • +
  • + CrossVerificationStatus +
  • + Parameters + +
    • \ No newline at end of file diff --git a/_includes/sidelist-programming/sidelist-understanding-v2.4.2200.html b/_includes/sidelist-programming/sidelist-understanding-v2.4.2200.html new file mode 100644 index 0000000..f401e13 --- /dev/null +++ b/_includes/sidelist-programming/sidelist-understanding-v2.4.2200.html @@ -0,0 +1,5 @@ +
  • UNDERSTANDING DCV
    • +
  • Overview of DCV
    • +{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-architecture.html" -%} +{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameters-organization.html" -%} +{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameter-reference.html" -%} \ No newline at end of file diff --git a/_includes/sidelist-programming/sidelist-understanding.html b/_includes/sidelist-programming/sidelist-understanding.html index f401e13..c07d38d 100644 --- a/_includes/sidelist-programming/sidelist-understanding.html +++ b/_includes/sidelist-programming/sidelist-understanding.html @@ -1,5 +1,4 @@
  • UNDERSTANDING DCV
  • Overview of DCV
    • {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-architecture.html" -%} -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameters-organization.html" -%} -{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameter-reference.html" -%} \ No newline at end of file +{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-parameters.html" -%} \ No newline at end of file diff --git a/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module-v2.0.10.md b/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module-v2.0.10.md index 86f9eb9..0fe6d66 100644 --- a/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module-v2.0.10.md +++ b/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module-v2.0.10.md @@ -25,7 +25,7 @@ This class defines common functionality in the `CaptureVisionRouter` module. ## CaptureVisionRouter Class -The `CaptureVisionRouter` class defines how a user interacts with image-processing and semantic-processing products in their applications. A `CaptureVisionRouter` instance accepts and processes images from an image source and returns processing results of many types. Read [Final results]({{site.architecture}}output.html#final-results?lang=js) for more information. The following code snippet shows its basic usage: +The `CaptureVisionRouter` class defines how a user interacts with image-processing and semantic-processing products in their applications. A `CaptureVisionRouter` instance accepts and processes images from an image source and returns processing results of many types. Read [Final results]({{site.dcvb_architecture}}output.html#final-results?lang=js) for more information. The following code snippet shows its basic usage: ```typescript let router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance(); diff --git a/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module-v2.0.32.md b/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module-v2.0.32.md index 05bd246..c3d1497 100644 --- a/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module-v2.0.32.md +++ b/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module-v2.0.32.md @@ -17,7 +17,7 @@ The CaptureVisionRouter module is defined in the namespace `Dynamsoft.CVR`. It c ## CaptureVisionRouter Class -The `CaptureVisionRouter` class defines how a user interacts with image-processing and semantic-processing products in their applications. A `CaptureVisionRouter` instance accepts and processes images from an image source and returns processing results which may contain [Final results]({{site.architecture}}output.html#final-results?lang=js){:target="_blank"} or [Intermediate Results]({{site.architecture}}output.html#intermediate-results?lang=js){:target="_blank"}. +The `CaptureVisionRouter` class defines how a user interacts with image-processing and semantic-processing products in their applications. A `CaptureVisionRouter` instance accepts and processes images from an image source and returns processing results which may contain [Final results]({{site.dcvb_architecture}}output.html#final-results?lang=js){:target="_blank"} or [Intermediate Results]({{site.dcvb_architecture}}output.html#intermediate-results?lang=js){:target="_blank"}. ### Create and Destroy Instances diff --git a/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module-v2.2.10.md b/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module-v2.2.10.md index a25685e..15db0b2 100644 --- a/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module-v2.2.10.md +++ b/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module-v2.2.10.md @@ -17,7 +17,7 @@ The CaptureVisionRouter module is defined in the namespace `Dynamsoft.CVR`. It c ## CaptureVisionRouter Class -The `CaptureVisionRouter` class defines how a user interacts with image-processing and semantic-processing products in their applications. A `CaptureVisionRouter` instance accepts and processes images from an image source and returns processing results which may contain [Final results]({{site.architecture}}output.html#final-results?lang=js){:target="_blank"} or [Intermediate Results]({{site.architecture}}output.html#intermediate-results?lang=js){:target="_blank"}. +The `CaptureVisionRouter` class defines how a user interacts with image-processing and semantic-processing products in their applications. A `CaptureVisionRouter` instance accepts and processes images from an image source and returns processing results which may contain [Final results]({{site.dcvb_architecture}}output.html#final-results?lang=js){:target="_blank"} or [Intermediate Results]({{site.dcvb_architecture}}output.html#intermediate-results?lang=js){:target="_blank"}. ### Create and Destroy Instances diff --git a/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module-v2.4.2200.md b/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module-v2.4.2200.md new file mode 100644 index 0000000..6fe76f1 --- /dev/null +++ b/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module-v2.4.2200.md @@ -0,0 +1,167 @@ +--- +layout: default-layout +title: CaptureVisionRouter Module - Dynamsoft Capture Vision JavaScript Edition API +description: This page introduces APIs related to CaptureVisionRouter of Dynamsoft Capture Vision JavaScript Edition as a module. +keywords: capture vision, module, api reference, javascript, js +needAutoGenerateSidebar: true +needGenerateH3Content: true +noTitleIndex: true +breadcrumbText: CaptureVisionRouter Module +--- + +# DynamsoftCaptureVisionRouter Module + +The CaptureVisionRouter module is defined in the namespace `Dynamsoft.CVR`. It consists of the classes `CaptureVisionRouter`, `CaptureVisionRouterModule`, `CapturedResultReceiver`, `IntermediateResultManager`, `IntermediateResultReceiver` and a few interfaces and enumerations. + +## CaptureVisionRouter Class + +The `CaptureVisionRouter` class defines how a user interacts with image-processing and semantic-processing products in their applications. A `CaptureVisionRouter` instance accepts and processes images from an image source and returns processing results which may contain [Final results]({{site.dcvb_architecture}}output.html#final-results?lang=js){:target="_blank"} or [Intermediate Results]({{site.dcvb_architecture}}output.html#intermediate-results?lang=js){:target="_blank"}. + +### Create and Destroy Instances + +| Name | Description | +| ------------------------------------------------------------ | ------------------------------------------------------------------------ | +| `static` [createInstance()](./instantiate.md#createinstance) | Initializes a new instance of the `CaptureVisionRouter` class. | +| [dispose()](./instantiate.md#dispose) | Releases all resources used by the `CaptureVisionRouter` instance. | +| [disposed](./instantiate.md#disposed) | Returns whether the `CaptureVisionRouter` instance has been disposed of. | + +### Single-Image Processing + +| Name | Description | +| ------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| [capture()](./single-image-processing.md#capture) | Processes a single image or a file containing a single image to derive important information. | + +### Multiple-Image Processing + +| Name | Description | +| ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [setInput()](./multiple-image-processing.md#setinput) | Sets up an image source to provide images for continuous processing. | +| [getInput()](./multiple-image-processing.md#getinput) | Returns the image source object. | +| [addResultReceiver()](./multiple-image-processing.md#addresultreceiver) | Adds a `CapturedResultReceiver` object as the receiver of captured results. | +| [removeResultReceiver()](./multiple-image-processing.md#removeresultreceiver) | Removes the specified `CapturedResultReceiver` object. | +| [addResultFilter()](./multiple-image-processing.md#addresultfilter) | Adds a `MultiFrameResultCrossFilter` object to filter non-essential results. | +| [removeResultFilter()](./multiple-image-processing.md#removeresultfilter) | Removes the specified `MultiFrameResultCrossFilter` object. | +| [startCapturing()](./multiple-image-processing.md#startcapturing) | Initiates a capturing process based on a specified template. | +| [stopCapturing()](./multiple-image-processing.md#stopcapturing) | Stops the capturing process. | + + + + +### Settings + +| Name | Description | +| -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| [initSettings()](./settings.md#initsettings) | Initializes settings with either a file or a string. | +| [outputSettings()](./settings.md#outputsettings) | Outputs a `CaptureVisionTemplate` specified by its name to a string. | +| [outputSettingsToFile](./settings.md#outputsettingstofile) | Generates a Blob object or initiates a JSON file download containing the settings for the specified `CaptureVisionTemplate`. | +| [getSimplifiedSettings()](./settings.md#getsimplifiedsettings) | Retrieves a JSON object that contains simplified settings for the specified `CaptureVisionTemplate`. | +| [updateSettings()](./settings.md#updatesettings) | Updates the specified `CaptureVisionTemplate` with an updated `SimplifiedCaptureVisionSettings` object. | +| [resetSettings()](./settings.md#resetsettings) | Restores all runtime settings to their original default values. | + +### Intermediate Result + +| Name | Description | +| --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | +| [getIntermediateResultManager()](./intermediate-result.md#getintermediateresultmanager) | Returns an object, of type `IntermediateResultManager`, that manages intermediate results. | + +## CaptureVisionRouterModule Class + +The `CaptureVisionRouterModule` class defines common functionality in the `CaptureVisionRouter` module. + +| Name | Description | +| --------------------------------------------------------------------------- | ------------------------------------------------------ | +| `static` [getVersion()](./capture-vision-router-module-class.md#getversion) | Returns the version of the CaptureVisionRouter module. | + +## CapturedResultReceiver Class + +The `CapturedResultReceiver` class is designed as a standardized way for retrieving captured results in the Dynamsoft Capture Vision architecture. It adopts an event-driven approach, with events dedicated to various result types, such as the original image, decoded barcodes, recognized text lines, detected quads, normalized images, and parsed results, etc. + +| Name | Description | +| ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | +| [onCapturedResultReceived()](./captured-result-receiver.md#oncapturedresultreceived) | Event triggered when a generic captured result is available. | +| [onOriginalImageResultReceived()](./captured-result-receiver.md#onoriginalimageresultreceived) | Event triggered when the original image result is available. | +| [onDecodedBarcodesReceived()](./captured-result-receiver.md#ondecodedbarcodesreceived) | Event triggered when decoded barcodes are available. | +| [onRecognizedTextLinesReceived()](./captured-result-receiver.md#onrecognizedtextlinesreceived) | Event triggered when recognized text lines are available. | +| [onDetectedQuadsReceived()](./captured-result-receiver.md#ondetectedquadsreceived) | Event triggered when detected quads are available. | +| [onNormalizedImagesReceived()](./captured-result-receiver.md#onnormalizedimagesreceived) | Event triggered when normalized images are available. | +| [onParsedResultsReceived()](./captured-result-receiver.md#onparsedresultsreceived) | Event triggered when parsed results are available. | + +## IntermediateResultManager Class + +The `IntermediateResultManager` class is responsible for handling intermediate results obtained during the process of an image. It offers methods to both register and deregister receivers of these intermediate results, as well as to retrieve the original image data. + +| Name | Description | +| ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| [addResultReceiver()](./intermediate-result-manager.md#addresultreceiver) | Adds a `IntermediateResultReceiver` object as the receiver of intermediate results. | +| [removeResultReceiver()](./intermediate-result-manager.md#removeresultreceiver) | Removes the specified `IntermediateResultReceiver` object. | +| [getOriginalImage()](./intermediate-result-manager.md#getoriginalimage) | Retrieves the original image data. | + +## IntermediateResultReceiver Class + +The `IntermediateResultReceiver` class is designed as a standardized way for retrieving intermediate results in image processing workflows in the Dynamsoft Capture Vision architecture. It adopts an event-driven approach, with events triggered for specific types of results, such as pre-detected regions, localized barcodes, etc. Each event is optional, allowing flexibility and customization based on the needs of the application. + +| Name | Description | +| ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| [onTaskResultsReceived()](./intermediate-result-receiver.md#ontaskresultsreceived) | Event triggered when task results are received. | +| [onPredetectedRegionsReceived()](./intermediate-result-receiver.md#onpredetectedregionsreceived) | Event triggered when pre-detected regions are received. | +| [onLocalizedBarcodesReceived()](./intermediate-result-receiver.md#onlocalizedbarcodesreceived) | Event triggered when localized barcodes are received. | +| [onDecodedBarcodesReceived()](./intermediate-result-receiver.md#ondecodedbarcodesreceived) | Event triggered when decoded barcodes are received. | +| [onLocalizedTextLinesReceived()](./intermediate-result-receiver.md#onlocalizedtextlinesreceived) | Event triggered when localized text lines are received. | +| [onRecognizedTextLinesReceived()](./intermediate-result-receiver.md#onrecognizedtextlinesreceived) | Event triggered when recognized text lines are received. | +| [onDetectedQuadsReceived()](./intermediate-result-receiver.md#ondetectedquadsreceived) | Event triggered when detected quads are received. | +| [onNormalizedImagesReceived()](./intermediate-result-receiver.md#onnormalizedimagesreceived) | Event triggered when normalized images are received. | +| [onColourImageUnitReceived()](./intermediate-result-receiver.md#oncolourimageunitreceived) | Event triggered when a colour image unit is received. | +| [onScaledDownColourImageUnitReceived()](./intermediate-result-receiver.md#onscaleddowncolourimageunitreceived) | Event triggered when a scaled-down colour image unit is received. | +| [onGrayscaleImageUnitReceived()](./intermediate-result-receiver.md#ongrayscaleimageunitreceived) | Event triggered when a grayscale image unit is received. | +| [onTransformedGrayscaleImageUnitReceived()](./intermediate-result-receiver.md#ontransformedgrayscaleimageunitreceived) | Event triggered when a transformed grayscale image unit is received. | +| [onEnhancedGrayscaleImageUnitReceived()](./intermediate-result-receiver.md#onenhancedgrayscaleimageunitreceived) | Event triggered when an enhanced grayscale image unit is received. | +| [onBinaryImageUnitReceived()](./intermediate-result-receiver.md#onbinaryimageunitreceived) | Event triggered when a binary image unit is received. | +| [onTextureDetectionResultUnitReceived()](./intermediate-result-receiver.md#ontexturedetectionresultunitreceived) | Event triggered when a texture detection result unit is received. | +| [onTextureRemovedGrayscaleImageUnitReceived()](./intermediate-result-receiver.md#ontextureremovedgrayscaleimageunitreceived) | Event triggered when a texture-removed grayscale image unit is received. | +| [onTextureRemovedBinaryImageUnitReceived()](./intermediate-result-receiver.md#ontextureremovedbinaryimageunitreceived) | Event triggered when a texture-removed binary image unit is received. | +| [onContoursUnitReceived()](./intermediate-result-receiver.md#oncontoursunitreceived) | Event triggered when a contours unit is received. | +| [onLineSegmentsUnitReceived()](./intermediate-result-receiver.md#onlinesegmentsunitreceived) | Event triggered when a line segments unit is received. | +| [onTextZonesUnitReceived()](./intermediate-result-receiver.md#ontextzonesunitreceived) | Event triggered when a text zones unit is received. | +| [onTextRemovedBinaryImageUnitReceived()](./intermediate-result-receiver.md#ontextremovedbinaryimageunitreceived) | Event triggered when a text-removed binary image unit is received. | +| [onLongLinesUnitReceived()](./intermediate-result-receiver.md#onlonglinesunitreceived) | Event triggered when a long lines unit is received. | +| [onCornersUnitReceived()](./intermediate-result-receiver.md#oncornersunitreceived) | Event triggered when a corners unit is received. | +| [onCandidateQuadEdgesUnitReceived()](./intermediate-result-receiver.md#oncandidatequadedgesunitreceived) | Event triggered when a candidate quad edges unit are detected. | +| [onCandidateBarcodeZonesUnitReceived()](./intermediate-result-receiver.md#oncandidatebarcodezonesunitreceived) | Event triggered when a candidate barcode zones unit are detected. | +| [onScaledUpBarcodeImageUnitReceived()](./intermediate-result-receiver.md#onscaledupbarcodeimageunitreceived) | Event triggered when a scaled-up barcode image unit is received. | +| [onDeformationResistedBarcodeImageUnitReceived()](./intermediate-result-receiver.md#ondeformationresistedbarcodeimageunitreceived) | Event triggered when a deformation-resisted barcode image unit is received. | +| [onComplementedBarcodeImageUnitReceived()](./intermediate-result-receiver.md#oncomplementedbarcodeimageunitreceived) | Event triggered when a complemented barcode image unit is received. | + +## BufferedItemsManager Class + +The `BufferedItemsManager` class is responsible for storing sample data generated during the recognition of confusable characters. Users can obtain these images and reuse them for more precise recognition in the future. + +| Name | Description | +| ---------------------------------------------------------------------------------------- | --------------------------------------------- | +| [getMaxBufferedItems()](./buffered-items-manager.md#getmaxbuffereditems) | Gets the buffered recognized character items. | +| [setMaxBufferedItems()](./buffered-items-manager.md#setmaxbuffereditems) | Sets the maximum number of buffered items. | +| [getBufferedCharacterItemSet()](./buffered-items-manager.md#getbufferedcharacteritemset) | Gets the buffered recognized character items. | + +## Interfaces + +* [CapturedResult](./interfaces/captured-result.md) +* [SimplifiedCaptureVisionSettings](./interfaces/simplified-capture-vision-settings.md) + + + + + + +## Enums + +* [EnumImageSourceState]({{ site.enums }}core/image-source-state.html?lang=js) + + diff --git a/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module.md b/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module.md index 50c5cc0..d7519be 100644 --- a/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module.md +++ b/programming/javascript/api-reference/capture-vision-router/capture-vision-router-module.md @@ -17,7 +17,7 @@ The CaptureVisionRouter module is defined in the namespace `Dynamsoft.CVR`. It c ## CaptureVisionRouter Class -The `CaptureVisionRouter` class defines how a user interacts with image-processing and semantic-processing products in their applications. A `CaptureVisionRouter` instance accepts and processes images from an image source and returns processing results which may contain [Final results]({{site.architecture}}output.html#final-results?lang=js){:target="_blank"} or [Intermediate Results]({{site.architecture}}output.html#intermediate-results?lang=js){:target="_blank"}. +The `CaptureVisionRouter` class defines how a user interacts with image-processing and semantic-processing products in their applications. A `CaptureVisionRouter` instance accepts and processes images from an image source and returns processing results which may contain [Final results]({{site.dcvb_architecture}}output.html#final-results?lang=js){:target="_blank"} or [Intermediate Results]({{site.dcvb_architecture}}output.html#intermediate-results?lang=js){:target="_blank"}. ### Create and Destroy Instances @@ -60,6 +60,7 @@ The `CaptureVisionRouter` class defines how a user interacts with image-processi | [outputSettings()](./settings.md#outputsettings) | Outputs a `CaptureVisionTemplate` specified by its name to a string. | | [outputSettingsToFile](./settings.md#outputsettingstofile) | Generates a Blob object or initiates a JSON file download containing the settings for the specified `CaptureVisionTemplate`. | | [getSimplifiedSettings()](./settings.md#getsimplifiedsettings) | Retrieves a JSON object that contains simplified settings for the specified `CaptureVisionTemplate`. | +| [getTemplateNames()](./settings.md#gettemplatenames) | Retrieves the names of all the currently available templates. | | [updateSettings()](./settings.md#updatesettings) | Updates the specified `CaptureVisionTemplate` with an updated `SimplifiedCaptureVisionSettings` object. | | [resetSettings()](./settings.md#resetsettings) | Restores all runtime settings to their original default values. | @@ -160,7 +161,7 @@ The `BufferedItemsManager` class is responsible for storing sample data generate ## Enums -* [EnumImageSourceState]({{ site.enums }}core/image-source-state.html?lang=js) +* [EnumImageSourceState]({{ site.dcvb_enums }}core/image-source-state.html?lang=js) - - -The following interfaces facilitate the use of intermediate result functions: - -* [BinaryImageUnit](./intermediate-results/binary-image-unit.md) -* [ColourImageUnit](./intermediate-results/colour-image-unit.md) -* [ContoursUnit](./intermediate-results/contours-unit.md) -* [EnhancedGrayscaleImageUnit](./intermediate-results/enhanced-grayscale-image-unit.md) -* [GrayscaleImageUnit](./intermediate-results/grayscale-image-unit.md) -* [IntermediateResultExtraInfo](./intermediate-results/intermediate-result-extra-info.md) -* [IntermediateResultReceiver](./intermediate-results/intermediate-result-receiver.md) -* [IntermediateResultUnit](./intermediate-results/intermediate-result-unit.md) -* [IntermediateResult](./intermediate-results/intermediate-result.md) -* [LineSegmentsUnit](./intermediate-results/line-segments-unit.md) -* [ObservationParameters](./intermediate-results/observation-parameters.md) -* [PredetectedRegionElement](./intermediate-results/predetected-region-element.md) -* [PredetectedRegionsUnit](./intermediate-results/predetected-regions-unit.md) -* [RegionObjectElement](./intermediate-results/region-object-element.md) -* [ScaledDownColourImageUnit](./intermediate-results/scaled-down-colour-image-unit.md) -* [TextRemovedBinaryImageUnit](./intermediate-results/text-removed-binary-image-unit.md) -* [TextZonesUnit](./intermediate-results/text-zones-unit.md) -* [TextureDetectionResultUnit](./intermediate-results/texture-detection-result-unit.md) -* [TextureRemovedBinaryImageUnit](./intermediate-results/texture-removed-binary-image-unit.md) -* [TextureRemovedGrayscaleImageUnit](./intermediate-results/texture-removed-grayscale-image-unit.md) -* [TransformedGrayscaleImageUnit](./intermediate-results/transformed-grayscale-image-unit.md) - -### Enums - -The following are the basic enumerations often shared by more than one module: - -* [EnumBufferOverflowProtectionMode]({{ site.enums }}core/buffer-overflow-protection-mode.html?lang=js) -* [EnumCapturedResultItemType]({{ site.enums }}core/captured-result-item-type.html?lang=js) -* [EnumColourChannelUsageType]({{ site.enums }}core/colour-channel-usage-type.html?lang=js) -* [EnumCornerType]({{ site.enums }}core/corner-type.html?lang=js) -* [EnumErrorCode]({{ site.enums }}core/error-code.html?lang=js) -* [EnumGrayscaleEnhancementMode]({{ site.enums }}core/grayscale-enhancement-mode.html?lang=js) -* [EnumGrayscaleTransformationMode]({{ site.enums }}core/grayscale-transformation-mode.html?lang=js) -* [EnumImagePixelFormat]({{ site.enums }}core/image-pixel-format.html?lang=js) -* [EnumImageTagType]({{ site.enums }}core/image-tag-type.html?lang=js) - - - -The following enumerations facilitate the use of intermediate result functions: - -* [EnumIntermediateResultUnitType]({{ site.enums }}core/intermediate-result-unit-type.html?lang=js) -* [EnumRegionObjectElementType]({{ site.enums }}core/region-object-element-type.html?lang=js) -* [EnumSectionType]({{ site.enums }}core/section-type.html?lang=js) \ No newline at end of file diff --git a/programming/javascript/api-reference/core/core-module.md b/programming/javascript/api-reference/core/core-module.md index 8108ceb..a5868ef 100644 --- a/programming/javascript/api-reference/core/core-module.md +++ b/programming/javascript/api-reference/core/core-module.md @@ -80,9 +80,8 @@ The following are the basic interfaces often shared by more than one module: * [TextZone](./intermediate-results/text-zone.md) * [Warning](./basic-structures/warning.md) - + + ### Intermediate Results @@ -127,4 +126,4 @@ The following are the basic enumerations often shared by more than one module: - \ No newline at end of file + \ No newline at end of file diff --git a/programming/javascript/api-reference/core/image-source-adapter-v3.0.10.md b/programming/javascript/api-reference/core/image-source-adapter-v2.2.3000.md similarity index 99% rename from programming/javascript/api-reference/core/image-source-adapter-v3.0.10.md rename to programming/javascript/api-reference/core/image-source-adapter-v2.2.3000.md index 05117de..d6aacb7 100644 --- a/programming/javascript/api-reference/core/image-source-adapter-v3.0.10.md +++ b/programming/javascript/api-reference/core/image-source-adapter-v2.2.3000.md @@ -30,7 +30,6 @@ noTitleIndex: true | [clearBuffer()](#clearbuffer) | Clears the image buffer. | | [setColourChannelUsageType()](#setcolourchannelusagetype) | Sets the usage type of a color channel in an image. | | [getColourChannelUsageType()](#getcolourchannelusagetype) | Gets the usage type of a color channel in an image. | ---- ## addImageToBuffer diff --git a/programming/javascript/api-reference/index.md b/programming/javascript/api-reference/index.md index 6dbd84a..27ceabd 100644 --- a/programming/javascript/api-reference/index.md +++ b/programming/javascript/api-reference/index.md @@ -9,14 +9,233 @@ noTitleIndex: true breadcrumbText: API Reference --- -# Dnamsoft Capture Vision JavaScript API Reference +# Dnamsoft Capture Vision JavaScript API Reference Index + +## [DynamsoftCaptureVisionRouter]({{ site.dcvb_js_api }}capture-vision-router/capture-vision-router-module.html) + +### Classes + +* [CaptureVisionRouter]({{ site.dcvb_js_api }}capture-vision-router/capture-vision-router-module.html) +* [CaptureVisionRouterModule]({{ site.dcvb_js_api }}capture-vision-router/capture-vision-router-module-class.html) +* [CapturedResultReceiver]({{ site.dcvb_js_api }}capture-vision-router/captured-result-receiver.html) +* [IntermediateResultManager]({{ site.dcvb_js_api }}capture-vision-router/intermediate-result-manager.html) +* [IntermediateResultReceiver]({{ site.dcvb_js_api }}capture-vision-router/intermediate-result-receiver.html) +* [BufferedItemsManager]({{ site.dcvb_js_api }}capture-vision-router/buffered-items-manager.html) + +### Interfaces + +* [CapturedResult]({{ site.dcvb_js_api }}capture-vision-router/interfaces/captured-result.html) +* [SimplifiedCaptureVisionSettings]({{ site.dcvb_js_api }}capture-vision-router/interfaces/simplified-capture-vision-settings.html) + +### Enums + +* [EnumImageSourceState]({{ site.dcvb_enums }}core/image-source-state.html?lang=js) + +## [DynamsoftBarcodeReader]({{ site.dbr_js_api }}barcode-reader-module.html) + +### Classes + +* [BarcodeReaderModule]({{ site.dbr_js_api }}barcode-reader-module-class.html) + +### Interfaces + +* [AztecDetails]({{ site.dbr_js_api }}interfaces/aztec-details.html) +* [BarcodeDetails]({{ site.dbr_js_api }}interfaces/barcode-details.html) +* [BarcodeResultItem]({{ site.dbr_js_api }}interfaces/barcode-result-item.html) +* [CandidateBarcodeZone]({{ site.dbr_js_api }}interfaces/candidate-barcode-zone.html) +* [CandidateBarcodeZonesUnit]({{ site.dbr_js_api }}interfaces/candidate-barcode-zones-unit.html) +* [ComplementedBarcodeImageUnit]({{ site.dbr_js_api }}interfaces/complemented-barcode-image-unit.html) +* [DataMatrixDetails]({{ site.dbr_js_api }}interfaces/datamatrix-details.html) +* [DecodedBarcodeElement]({{ site.dbr_js_api }}interfaces/decoded-barcode-element.html) +* [DecodedBarcodesResult]({{ site.dbr_js_api }}interfaces/decoded-barcodes-result.html) +* [DecodedBarcodesUnit]({{ site.dbr_js_api }}interfaces/decoded-barcodes-unit.html) +* [DeformationResistedBarcode]({{ site.dbr_js_api }}interfaces/deformation-resisted-barcode.html) +* [DeformationResistedBarcodeImageUnit]({{ site.dbr_js_api }}interfaces/deformation-resisted-barcode-image-unit.html) +* [ExtendedBarcodeResult]({{ site.dbr_js_api }}interfaces/extended-barcode-result.html) +* [LocalizedBarcodeElement]({{ site.dbr_js_api }}interfaces/localized-barcode-element.html) +* [LocalizedBarcodesUnit]({{ site.dbr_js_api }}interfaces/localized-barcodes-unit.html) +* [OneDCodeDetails]({{ site.dbr_js_api }}interfaces/oned-code-details.html) +* [PDF417Details]({{ site.dbr_js_api }}interfaces/pdf417-details.html) +* [QRCodeDetails]({{ site.dbr_js_api }}interfaces/qr-code-details.html) +* [ScaledUpBarcodeImageUnit]({{ site.dbr_js_api }}interfaces/scaled-up-barcode-image-unit.html) +* [SimplifiedBarcodeReaderSettings]({{ site.dbr_js_api }}interfaces/simplified-barcode-reader-settings.html) + +### Enums + +* [EnumBarcodeFormat]({{ site.dcvb_enums }}barcode-reader/barcode-format.html?lang=js) +* [EnumDeblurMode]({{ site.dcvb_enums }}barcode-reader/deblur-mode.html?lang=js) +* [EnumExtendedBarcodeResultType]({{ site.dcvb_enums }}barcode-reader/extended-barcode-result-type.html?lang=js) +* [EnumLocalizationMode]({{ site.dcvb_enums }}barcode-reader/localization-mode.html?lang=js) +* [EnumQRCodeErrorCorrectionLevel]({{ site.dcvb_enums }}barcode-reader/qr-code-error-correction-level.html?lang=js) + +## [DynamsoftLabelRecognizer]({{ site.dlr_js_api }}label-recognizer-module.html) + +### Classes + +* [LabelRecognizerModule]({{ site.dlr_js_api }}label-recognizer-module-class.html) + +### Interfaces + +* [SimplifiedLabelRecognizerSettings]({{ site.dlr_js_api }}interfaces/simplified-label-recognizer-settings.md) +* [BufferedCharacterItem]({{ site.dlr_js_api }}interfaces/buffered-character-item.md) +* [BufferedCharacterItemSet]({{ site.dlr_js_api }}interfaces/buffered-character-item-set.md) +* [CharacterCluster]({{ site.dlr_js_api }}interfaces/character-cluster.md) +* [CharacterResult]({{ site.dlr_js_api }}interfaces/character-result.md) +* [LocalizedTextLineElement]({{ site.dlr_js_api }}interfaces/localized-textline-element.md) +* [RecognizedTextLineElement]({{ site.dlr_js_api }}interfaces/recognized-textline-element.md) +* [LocalizedTextLinesUnit]({{ site.dlr_js_api }}interfaces/localized-textlines-unit.md) +* [RecognizedTextLinesUnit]({{ site.dlr_js_api }}interfaces/recognized-textlines-unit.md) +* [TextLineResultItem]({{ site.dlr_js_api }}interfaces/textline-result-item.md) +* [RecognizedTextLinesResult]({{ site.dlr_js_api }}interfaces/recognized-textlines-result.md) + +## [DynamsoftDocumentNormalizer]({{ site.ddn_js_api }}document-normalizer-module.html) + +### Classes + +* [DocumentNormalizerModule]({{ site.ddn_js_api }}document-normalizer-module-class.html) + +### Interfaces + +* [CandidateQuadEdgesUnit]({{ site.ddn_js_api }}interfaces/candidate-quad-edges-unit.md) +* [CornersUnit]({{ site.ddn_js_api }}interfaces/corners-unit.md) +* [DetectedQuadElement]({{ site.ddn_js_api }}interfaces/detected-quad-element.md) +* [DetectedQuadResultItem]({{ site.ddn_js_api }}interfaces/detected-quad-result-item.md) +* [DetectedQuadsResult]({{ site.ddn_js_api }}interfaces/detected-quads-result.md) +* [DetectedQuadsUnit]({{ site.ddn_js_api }}interfaces/detected-quads-unit.md) +* [LongLinesUnit]({{ site.ddn_js_api }}interfaces/long-lines-unit.md) +* [NormalizedImageElement]({{ site.ddn_js_api }}interfaces/normalized-image-element.md) +* [NormalizedImageResultItem]({{ site.ddn_js_api }}interfaces/normalized-image-result-item.md) +* [NormalizedImagesResult]({{ site.ddn_js_api }}interfaces/normalized-images-result.md) +* [NormalizedImagesUnit]({{ site.ddn_js_api }}interfaces/normalized-images-unit.md) +* [SimplifiedDocumentNormalizerSettings]({{ site.ddn_js_api }}interfaces/simplified-document-normalizer-settings.md) + +### Enums + +* [EnumImageColourMode]({{ site.dcvb_enums }}document-normalizer/image-colour-mode.html?lang=js) + +## [DynamsoftCameraEnhancer]({{ site.dce_js_api }}index.html) + +### Classes -* [CaptureVisionRouter](capture-vision-router/capture-vision-router-module.md) -* [BarcodeReader]({{ site.dbr_js_api }}barcode-reader-module.html) -* [LabelRecognizer]({{ site.dlr_js_api }}label-recognizer-module.html) -* [DocumentNormalizer]({{ site.ddn_js_api }}document-normalizer-module.html) * [CameraEnhancer]({{ site.dce_js_api }}index.html) -* [CodeParser]({{ site.dcp_js_api }}code-parser-module.html) -* [License](license/license-module.md) -* [Utility](utility/utility-module.md) -* [Core](core/core-module.md) +* [CameraView]({{ site.dce_js_api }}cameraview.html) +* [ImageEditorView]({{ site.dce_js_api }}imageeditorview.html) +* [CameraEnhancerModule]({{ site.dce_js_api }}cameraenhancermodule.html) +* [DrawingItem]({{ site.dce_js_api }}drawingitem.html) +* [DrawingLayer]({{ site.dce_js_api }}drawinglayer.html) +* [DrawingStyleManager]({{ site.dce_js_api }}drawinglayer.html) +* [Feedback]({{ site.dce_js_api }}feedback.html) + +### Interfaces + +* [CameraTestResponse]({{ site.dce_js_api }}interface/cameratestresponse.html) +* [DCEFrame]({{ site.dce_js_api }}interface/dceframe.html) +* [DrawingItemEvent]({{ site.dce_js_api }}interface/drawingitemevent.html) +* [DrawingStyle]({{ site.dce_js_api }}interface/drawingstyle.html) +* [Note]({{ site.dce_js_api }}interface/note.html) +* [PlayCallbackInfo]({{ site.dce_js_api }}interface/playcallbackinfo.html) +* [Resolution]({{ site.dce_js_api }}interface/resolution.html) +* [TipConfig]({{ site.dce_js_api }}interface/tipconfig.html) +* [VideoDevice]({{ site.dce_js_api }}interface/videodevice.html) +* [VideoFrameTag]({{ site.dce_js_api }}interface/videoframetag.html) + +### Enums + +* [EnumDrawingItemMediaType]({{ site.dce_js_api }}enum/enumdrawingitemmediatype.html) +* [EnumDrawingItemState]({{ site.dce_js_api }}enum/enumdrawingitemstate.html) +* [EnumEnhancedFeatures]({{ site.dce_js_api }}enum/enumenhancedfeatures.html) + +## [DynamsoftCodeParser]({{ site.dcp_js_api }}code-parser-module.html) + +### Classes + +* [CodeParser]({{ site.dcp_js_api }}code-parser.html) +* [CodeParserModule]({{ site.dcp_js_api }}code-parser-module-class.html) + +### Interfaces + +* [ParsedResult]({{ site.dcp_js_api }}interfaces/parsed-result.md) +* [ParsedResultItem]({{ site.dcp_js_api }}interfaces/parsed-result-item.md) + +### Enumerations + +* [EnumMappingStatus]({{ site.dcvb_enums }}code-parser/mapping-status.html) +* [EnumValidationStatus]({{ site.dcvb_enums }}code-parser/validation-status.html) + +## [DynamsoftCore]({{ site.dcvb_js_api }}core/core-module.html) + +### Classes + +* [CoreModule]({{ site.dcvb_js_api }}core/core-module-class.html) +* [ImageSourceAdapter]({{ site.dcvb_js_api }}core/image-source-adapter.html) + +### Interfaces + +* [Arc]({{ site.dcvb_js_api }}core/basic-structures/arc.html) +* [Contour]({{ site.dcvb_js_api }}core/basic-structures/contour.html) +* [Corner]({{ site.dcvb_js_api }}core/basic-structures/corner.html) +* [DSRect]({{ site.dcvb_js_api }}core/basic-structures/ds-rect.html) +* [Edge]({{ site.dcvb_js_api }}core/basic-structures/edge.html) +* [LineSegment]({{ site.dcvb_js_api }}core/basic-structures/line-segment.html) +* [Point]({{ site.dcvb_js_api }}core/basic-structures/point.html) +* [Polygon]({{ site.dcvb_js_api }}core/basic-structures/polygon.html) +* [Quadrilateral]({{ site.dcvb_js_api }}core/basic-structures/quadrilateral.html) +* [Rect]({{ site.dcvb_js_api }}core/basic-structures/rect.html) +* [CapturedResultItem]({{ site.dcvb_js_api }}core/basic-structures/captured-result-item.html) +* [DSFile]({{ site.dcvb_js_api }}core/basic-structures/ds-file.html) +* [DSImageData]({{ site.dcvb_js_api }}core/basic-structures/ds-image-data.html) +* [ImageSourceErrorListener]({{ site.dcvb_js_api }}core/basic-structures/image-source-error-listener.html) +* [ImageTag]({{ site.dcvb_js_api }}core/basic-structures/image-tag.html) +* [OriginalImageResultItem]({{ site.dcvb_js_api }}core/basic-structures/original-image-result-item.html) +* [TextZone]({{ site.dcvb_js_api }}core/intermediate-results/text-zone.html) +* [Warning]({{ site.dcvb_js_api }}core/basic-structures/warning.html) +* [BinaryImageUnit]({{ site.dcvb_js_api }}core/intermediate-results/binary-image-unit.html) +* [ColourImageUnit]({{ site.dcvb_js_api }}core/intermediate-results/colour-image-unit.html) +* [ContoursUnit]({{ site.dcvb_js_api }}core/intermediate-results/contours-unit.html) +* [EnhancedGrayscaleImageUnit]({{ site.dcvb_js_api }}core/intermediate-results/enhanced-grayscale-image-unit.html) +* [GrayscaleImageUnit]({{ site.dcvb_js_api }}core/intermediate-results/grayscale-image-unit.html) +* [IntermediateResult]({{ site.dcvb_js_api }}core/intermediate-results/intermediate-result.html) +* [IntermediateResultExtraInfo]({{ site.dcvb_js_api }}core/intermediate-results/intermediate-result-extra-info.html) +* [IntermediateResultUnit]({{ site.dcvb_js_api }}core/intermediate-results/intermediate-result-unit.html) +* [ObservationParameters]({{ site.dcvb_js_api }}core/intermediate-results/observation-parameters.html) +* [LineSegmentsUnit]({{ site.dcvb_js_api }}core/intermediate-results/line-segments-unit.html) +* [PredetectedRegionElement]({{ site.dcvb_js_api }}core/intermediate-results/predetected-region-element.html) +* [PredetectedRegionsUnit]({{ site.dcvb_js_api }}core/intermediate-results/predetected-regions-unit.html) +* [RegionObjectElement]({{ site.dcvb_js_api }}core/intermediate-results/region-object-element.html) +* [ScaledDownColourImageUnit]({{ site.dcvb_js_api }}core/intermediate-results/scaled-down-colour-image-unit.html) +* [TextRemovedBinaryImageUnit]({{ site.dcvb_js_api }}core/intermediate-results/text-removed-binary-image-unit.html) +* [TextureDetectionResultUnit]({{ site.dcvb_js_api }}core/intermediate-results/texture-detection-result-unit.html) +* [TextureRemovedBinaryImageUnit]({{ site.dcvb_js_api }}core/intermediate-results/texture-removed-binary-image-unit.html) +* [TextureRemovedGrayscaleImageUnit]({{ site.dcvb_js_api }}core/intermediate-results/texture-removed-grayscale-image-unit.html) +* [TextZonesUnit]({{ site.dcvb_js_api }}core/intermediate-results/text-zones-unit.html) +* [TransformedGrayscaleImageUnit]({{ site.dcvb_js_api }}core/intermediate-results/transformed-grayscale-image-unit.html) + +### Enums + +* [EnumBufferOverflowProtectionMode]({{ site.dcvb_enums }}core/buffer-overflow-protection-mode.html?lang=js) +* [EnumCapturedResultItemType]({{ site.dcvb_enums }}core/captured-result-item-type.html?lang=js) +* [EnumColourChannelUsageType]({{ site.dcvb_enums }}core/colour-channel-usage-type.html?lang=js) +* [EnumCornerType]({{ site.dcvb_enums }}core/corner-type.html?lang=js) +* [EnumErrorCode]({{ site.dcvb_enums }}core/error-code.html?lang=js) +* [EnumGrayscaleEnhancementMode]({{ site.dcvb_enums }}core/grayscale-enhancement-mode.html?lang=js) +* [EnumGrayscaleTransformationMode]({{ site.dcvb_enums }}core/grayscale-transformation-mode.html?lang=js) +* [EnumImagePixelFormat]({{ site.dcvb_enums }}core/image-pixel-format.html?lang=js) +* [EnumImageTagType]({{ site.dcvb_enums }}core/image-tag-type.html?lang=js) +* [EnumIntermediateResultUnitType]({{ site.dcvb_enums }}core/intermediate-result-unit-type.html?lang=js) +* [EnumRegionObjectElementType]({{ site.dcvb_enums }}core/region-object-element-type.html?lang=js) +* [EnumSectionType]({{ site.dcvb_enums }}core/section-type.html?lang=js) + +## [DynamsoftLicense]({{ site.dcvb_js_api }}license/license-module.html) + +### Classes + +* [LicenseModule]({{ site.dcvb_js_api }}license/license-module-class.html) +* [LicenseManager]({{ site.dcvb_js_api }}license/license-manager.html) + +## [DynamsoftUtility]({{ site.dcvb_js_api }}utility/utility-module.html) + +### Classes + +* [UtilityModule]({{ site.dcvb_js_api }}utility/utility-module-class.html) +* [ImageManager]({{ site.dcvb_js_api }}utility/image-manager.html) +* [MultiFrameResultCrossFilter]({{ site.dcvb_js_api }}utility//multi-frame-result-cross-filter.html) \ No newline at end of file diff --git a/programming/javascript/api-reference/utility/multi-frame-result-cross-filter-v2.4.2200.md b/programming/javascript/api-reference/utility/multi-frame-result-cross-filter-v2.4.2200.md new file mode 100644 index 0000000..f48d7ae --- /dev/null +++ b/programming/javascript/api-reference/utility/multi-frame-result-cross-filter-v2.4.2200.md @@ -0,0 +1,234 @@ +--- +layout: default-layout +title: Interface MultiFrameResultCrossFilter - Dynamsoft Utility Module JS Edition API Reference +description: This page shows the JS edition of the class MultiFrameResultCrossFilter in Dynamsoft Utility Module. +keywords: image manager, JS +needAutoGenerateSidebar: true +needGenerateH3Content: true +noTitleIndex: true +--- + +# MultiFrameResultCrossFilter + +The `MultiFrameResultCrossFilter` class offers a set of API functions designed for managing and filtering results from multiple image frames, typically used in consecutive frames of a streaming video. + +| Name | Description | +| ----------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| [enableResultCrossVerification()](#enableresultcrossverification) | Enables or disables the verification of specific result item types. | +| [isResultCrossVerificationEnabled()](#isresultcrossverificationenabled) | Checks if verification is active for a given result item type. | +| [enableResultDeduplication()](#enableresultdeduplication) | Enables or disables the deduplication process for specific result item types. | +| [isResultDeduplicationEnabled()](#isresultdeduplicationenabled) | Checks if deduplication is active for a given result item type. | +| [setDuplicateForgetTime()](#setduplicateforgettime) | Sets the interval during which duplicates are disregarded for specific result item types. | +| [getDuplicateForgetTime()](#getduplicateforgettime) | Retrieves the interval during which duplicates are disregarded for a given result item type. | +| [onOriginalImageResultReceived()](#onoriginalimageresultreceived) | Event triggered when the original images are received. | +| [onDecodedBarcodesReceived()](#ondecodedbarcodesreceived) | Event triggered when the decoded barcodes are received. | +| [onRecognizedTextLinesReceived()](#onrecognizedtextlinesreceived) | Event triggered when the recognized text lines are received. | +| [onDetectedQuadsReceived()](#ondetectedquadsreceived) | Event triggered when the detected quadrilaterals are received. | +| [onNormalizedImagesReceived()](#onnormalizedimagesreceived) | Event triggered when the normalized images are received. | + + +### enableResultCrossVerification + +Enables or disables the verification of specific result item types. + +```typescript +enableResultCrossVerification(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image", enabled: boolean): void; +``` + +**Parameters** + +`resultItemTypes`: Specifies the result item types. + +`enabled`: Boolean to toggle verification on or off. + +**Return Value** + +None. + +**See Also** + +[EnumCapturedResultItemType](https://www.dynamsoft.com/capture-vision/docs/core/enums/core/captured-result-item-type.html?lang=js) + +### isResultCrossVerificationEnabled + +Checks if verification is active for a given result item type. + +```typescript +isResultCrossVerificationEnabled(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image"): boolean; +``` + +**Parameters** + +`resultItemType`: Specifies the result item type in question. + +**Return Value** + +Boolean indicating the status of verification for the specified type. + +**See Also** + +[EnumCapturedResultItemType](https://www.dynamsoft.com/capture-vision/docs/core/enums/core/captured-result-item-type.html?lang=js) + +### enableResultDeduplication + +Enables or disables the deduplication process for specific result item types. + +```typescript +enableResultDeduplication(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image", enabled: boolean): void; +``` + +**Parameters** + +`resultItemTypes`: Specifies the result item types. + +`enabled`: Boolean to toggle deduplication on or off. + +**Return Value** + +None. + +**See Also** + +[EnumCapturedResultItemType](https://www.dynamsoft.com/capture-vision/docs/core/enums/core/captured-result-item-type.html?lang=js) + +### isResultDeduplicationEnabled + +Checks if deduplication is active for a given result item type. + +```typescript +isResultDeduplicationEnabled(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image"): boolean; +``` + +**Parameters** + +`resultItemType`: Specifies the result item type in question. + +**Return Value** + +Boolean indicating the deduplication status for the specified type. + +**See Also** + +[EnumCapturedResultItemType](https://www.dynamsoft.com/capture-vision/docs/core/enums/core/captured-result-item-type.html?lang=js) + +### setDuplicateForgetTime + +Sets the interval during which duplicates are disregarded for specific result item types. + +```typescript +setDuplicateForgetTime(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image", time: number): void; +``` + +**Parameters** + +`resultItemTypes`: Specifies the result item types. + +`time`: Time in milliseconds during which duplicates are disregarded. The maximum time allowed is 10,000 milliseconds or 10 seconds. + +**Return Value** + +None. + +**See Also** + +[EnumCapturedResultItemType](https://www.dynamsoft.com/capture-vision/docs/core/enums/core/captured-result-item-type.html?lang=js) + +### getDuplicateForgetTime + +Retrieves the interval during which duplicates are disregarded for a given result item type. + +```typescript +getDuplicateForgetTime(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image"): number; +``` + +**Parameters** + +`resultItemType`: Specifies the result item type in question. + +**Return Value** + +The set interval for the specified item type. + +**See Also** + +[EnumCapturedResultItemType](https://www.dynamsoft.com/capture-vision/docs/core/enums/core/captured-result-item-type.html?lang=js) + +### onOriginalImageResultReceived + +Event triggered when the original images are received. + +```typescript +onOriginalImageResultReceived?: (result: Core.OriginalImageResultItem) => void; +``` + +**Parameters** + +`result`: The result item that contains the original image, of type `OriginalImageResultItem`. + +**Return Value** + +None. + +### onDecodedBarcodesReceived + +Event triggered when the decoded barcodes are received. + +```typescript +onDecodedBarcodesReceived?: (result: any) => void; +``` + +**Parameters** + +`result`: The result item that contains the decoded barcodes, of type `any`. + +**Return Value** + +None. + +### onRecognizedTextLinesReceived + +Event triggered when the recognized text lines are received. + +```typescript +onRecognizedTextLinesReceived?: (result: any) => void; +``` + +**Parameters** + +`result`: The result item that contains the recognized text lines, of type `any`. + +**Return Value** + +None. + +### onDetectedQuadsReceived + +Event triggered when the detected quadrilaterals are received. + +```typescript +onDetectedQuadsReceived?: (result: any) => void; +``` + +**Parameters** + +`result`: The result item that contains the detected quadrilaterals, of type `any`. + +**Return Value** + +None. + +### onNormalizedImagesReceived + +Event triggered when the normalized images are received. + +```typescript +onNormalizedImagesReceived?: (result: any) => void; +``` + +**Parameters** + +`result`: The result item that contains the normalized images, of type `any`. + +**Return Value** + +None. \ No newline at end of file diff --git a/programming/javascript/api-reference/utility/multi-frame-result-cross-filter.md b/programming/javascript/api-reference/utility/multi-frame-result-cross-filter.md index f48d7ae..61b506e 100644 --- a/programming/javascript/api-reference/utility/multi-frame-result-cross-filter.md +++ b/programming/javascript/api-reference/utility/multi-frame-result-cross-filter.md @@ -14,18 +14,65 @@ The `MultiFrameResultCrossFilter` class offers a set of API functions designed f | Name | Description | | ----------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| [enableLatestOverlapping()](#enablelatestoverlapping) | Enables or disables the to-the-latest overlapping feature of one or multiple specific result item types. This feature can increase the read-rate performance when decoding multiple barcodes under the video streaming. | +| [isLatestOverlappingEnabled()](#islatestoverlappingenabled) | Checks if to-the-latest overlapping is active for a given result item type. | | [enableResultCrossVerification()](#enableresultcrossverification) | Enables or disables the verification of specific result item types. | | [isResultCrossVerificationEnabled()](#isresultcrossverificationenabled) | Checks if verification is active for a given result item type. | | [enableResultDeduplication()](#enableresultdeduplication) | Enables or disables the deduplication process for specific result item types. | | [isResultDeduplicationEnabled()](#isresultdeduplicationenabled) | Checks if deduplication is active for a given result item type. | | [setDuplicateForgetTime()](#setduplicateforgettime) | Sets the interval during which duplicates are disregarded for specific result item types. | | [getDuplicateForgetTime()](#getduplicateforgettime) | Retrieves the interval during which duplicates are disregarded for a given result item type. | +| [setMaxOverlappingFrames()](#setmaxoverlappingframes) | Set the maximum overlapping frames count for a given result item type. | +| [getMaxOverlappingFrames()](#getmaxoverlappingframes) | Get the maximum overlapping frames count for a given result item type. | | [onOriginalImageResultReceived()](#onoriginalimageresultreceived) | Event triggered when the original images are received. | | [onDecodedBarcodesReceived()](#ondecodedbarcodesreceived) | Event triggered when the decoded barcodes are received. | | [onRecognizedTextLinesReceived()](#onrecognizedtextlinesreceived) | Event triggered when the recognized text lines are received. | | [onDetectedQuadsReceived()](#ondetectedquadsreceived) | Event triggered when the detected quadrilaterals are received. | | [onNormalizedImagesReceived()](#onnormalizedimagesreceived) | Event triggered when the normalized images are received. | +### enableLatestOverlapping + +Enables or disables the latest overlapping of specific result item types. + +> Please note that this feature is currently only available for barcodes reading. + +```typescript +enableLatestOverlapping(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image", enabled: boolean): void; +``` + +**Parameters** + +`resultItemTypes`: Specifies the result item types. + +`enabled`: Boolean to toggle the latest overlapping on or off. + +**Return Value** + +None. + +**See Also** + +[EnumCapturedResultItemType](https://www.dynamsoft.com/capture-vision/docs/core/enums/core/captured-result-item-type.html?lang=js) + +### isLatestOverlappingEnabled + +Checks if latest overlapping is active for a given result item type. + +```typescript +isLatestOverlappingEnabled(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image"): boolean; +``` + +**Parameters** + +`resultItemType`: Specifies the result item type in question. + +**Return Value** + +Boolean indicating the status of the latest overlapping for the specified type. + +**See Also** + +[EnumCapturedResultItemType](https://www.dynamsoft.com/capture-vision/docs/core/enums/core/captured-result-item-type.html?lang=js) ### enableResultCrossVerification @@ -153,6 +200,48 @@ The set interval for the specified item type. [EnumCapturedResultItemType](https://www.dynamsoft.com/capture-vision/docs/core/enums/core/captured-result-item-type.html?lang=js) +### setMaxOverlappingFrames + +Set the maximum overlapping frames count for a given result item type. + +```typescript +setMaxOverlappingFrames(resultItemTypes: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image", maxOverlappingFrames: number): void; +``` + +**Parameters** + +`resultItemTypes`: Specifies the result item types. + +`maxOverlappingFrames`: The maximum overlapping frame count for the overlapping. + +**Return Value** + +None. + +**See Also** + +[EnumCapturedResultItemType](https://www.dynamsoft.com/capture-vision/docs/core/enums/core/captured-result-item-type.html?lang=js) + +### getMaxOverlappingFrames + +Get the maximum overlapping frames count for a given result item type. + +```typescript +getMaxOverlappingFrames(resultItemType: Core.EnumCapturedResultItemType | "barcode" | "text_line" | "detected_quad" | "normalized_image"): number; +``` + +**Parameters** + +`resultItemType`: Specifies the result item type in question. + +**Return Value** + +The maximum overlapping frame count for the overlapping. + +**See Also** + +[EnumCapturedResultItemType](https://www.dynamsoft.com/capture-vision/docs/core/enums/core/captured-result-item-type.html?lang=js) + ### onOriginalImageResultReceived Event triggered when the original images are received. diff --git a/programming/javascript/api-reference/utility/utility-module-v2.4.2200.md b/programming/javascript/api-reference/utility/utility-module-v2.4.2200.md new file mode 100644 index 0000000..75a81e1 --- /dev/null +++ b/programming/javascript/api-reference/utility/utility-module-v2.4.2200.md @@ -0,0 +1,44 @@ +--- +layout: default-layout +title: API Reference Index - Utility Module JavaScript Edition +description: This is the index page of the Utility Module API Reference +keywords: Utility, api reference, javascript, js +needAutoGenerateSidebar: true +needGenerateH3Content: true +noTitleIndex: true +breadcrumbText: Utility Module +--- + + +# DynamsoftUtility Module + +The Utility module is defined in the namespace `Dynamsoft.Utility`. At present, it consists of the classes `UtilityModule`, `ImageManager` and `MultiFrameResultCrossFilter`. + +## UtilityModule Class + +This class defines common functionality in the Utility module. At present, it has only one method. + +| Name | Description | +| ------------------------------------------------------------- | ------------------------------------------ | +| `static` [getVersion()](./utility-module-class.md#getversion) | Returns the version of the Utility module. | + +## ImageManager Class + +The `ImageManager` class provides APIs for managing images. At present, it has only one API to save an image as a file. + +| Name | Description | +| ------------------------------------------- | ------------------------------------------------------ | +| [saveToFile](./image-manager.md#savetofile) | Saves the specified image in either PNG or JPG format. | + +## MultiFrameResultCrossFilter Class + +The `MultiFrameResultCrossFilter` class provides APIs to configure the filtering of results from multiple images which have been processed consecutively. Usually these images are frames from a streaming video. + +| Name | Description | +| ----------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| [enableResultCrossVerification()](./multi-frame-result-cross-filter.md#enableresultcrossverification) | Enables or disables the verification of specific result item types. | +| [isResultCrossVerificationEnabled()](./multi-frame-result-cross-filter.md#isresultcrossverificationenabled) | Checks if verification is active for a given result item type. | +| [enableResultDeduplication()](./multi-frame-result-cross-filter.md#enableresultdeduplication) | Enables or disables the deduplication process for specific result item types. | +| [isResultDeduplicationEnabled()](./multi-frame-result-cross-filter.md#isresultdeduplicationenabled) | Checks if deduplication is active for a given result item type. | +| [setDuplicateForgetTime()](./multi-frame-result-cross-filter.md#setduplicateforgettime) | Sets the interval during which duplicates are disregarded for specific result item types. | +| [getDuplicateForgetTime()](./multi-frame-result-cross-filter.md#getduplicateforgettime) | Retrieves the interval during which duplicates are disregarded for a given result item type. | \ No newline at end of file diff --git a/programming/javascript/api-reference/utility/utility-module.md b/programming/javascript/api-reference/utility/utility-module.md index 75a81e1..8e52b28 100644 --- a/programming/javascript/api-reference/utility/utility-module.md +++ b/programming/javascript/api-reference/utility/utility-module.md @@ -36,9 +36,13 @@ The `MultiFrameResultCrossFilter` class provides APIs to configure the filtering | Name | Description | | ----------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| [enableLatestOverlapping()](./multi-frame-result-cross-filter.md#enablelatestoverlapping) | Enables or disables the to-the-latest overlapping feature of one or multiple specific result item types. This feature can increase the read-rate performance when decoding multiple barcodes under the video streaming. | +| [isLatestOverlappingEnabled()](./multi-frame-result-cross-filter.md#islatestoverlappingenabled) | Checks if to-the-latest overlapping is active for a given result item type. | | [enableResultCrossVerification()](./multi-frame-result-cross-filter.md#enableresultcrossverification) | Enables or disables the verification of specific result item types. | | [isResultCrossVerificationEnabled()](./multi-frame-result-cross-filter.md#isresultcrossverificationenabled) | Checks if verification is active for a given result item type. | | [enableResultDeduplication()](./multi-frame-result-cross-filter.md#enableresultdeduplication) | Enables or disables the deduplication process for specific result item types. | | [isResultDeduplicationEnabled()](./multi-frame-result-cross-filter.md#isresultdeduplicationenabled) | Checks if deduplication is active for a given result item type. | | [setDuplicateForgetTime()](./multi-frame-result-cross-filter.md#setduplicateforgettime) | Sets the interval during which duplicates are disregarded for specific result item types. | -| [getDuplicateForgetTime()](./multi-frame-result-cross-filter.md#getduplicateforgettime) | Retrieves the interval during which duplicates are disregarded for a given result item type. | \ No newline at end of file +| [getDuplicateForgetTime()](./multi-frame-result-cross-filter.md#getduplicateforgettime) | Retrieves the interval during which duplicates are disregarded for a given result item type. | +| [setMaxOverlappingFrames()](./multi-frame-result-cross-filter.md#setmaxoverlappingframes) | Set the maximum overlapping frames count for a given result item type. | +| [getMaxOverlappingFrames()](./multi-frame-result-cross-filter.md#getmaxoverlappingframes) | Get the maximum overlapping frames count for a given result item type. | \ No newline at end of file diff --git a/programming/javascript/release-notes/dcvb.md b/programming/javascript/release-notes/dcvb.md index 16a3508..080e96f 100644 --- a/programming/javascript/release-notes/dcvb.md +++ b/programming/javascript/release-notes/dcvb.md @@ -9,6 +9,45 @@ noTitleIndex: true # Release Notes - DynamsoftCaptureVisionBundle +## 2.6.1000 (01/03/2025) + +### Highlights + +- Enhanced document detection delivers more reliable results, particularly for single-document scenarios. Key improvements include: + - Strengthened detection algorithms for greater accuracy and robustness. + - Optimized parameter configurations for better adaptability across diverse scenarios. + - Refined cross-verification rules to ensure more consistent detection outcomes. +- Introduced a feature to track and accumulate recognized barcodes across multiple frames in real-time video, enabling seamless multi-barcode recognition. + +### Changelogs + +#### New + +- Added a new mode, `CICM_EDGE_ENHANCEMENT`, to the `ColourConversionModes` parameter, designed to enhance edge details when converting a color image to grayscale. +- Introduced the concept of `LogicLines` to enhance the processing and analysis of document structures. + - Added a new value, `IRUT_LOGIC_LINES`, to the `IntermediateResultUnitType` enumeration. + - Added a new function `onLogicLinesReceived` to the class `IntermediateResultReceiver` which will be called when logic lines have been received. + - Added a new class, `LogicLinesUnit`, to represent an intermediate result unit containing logic lines. +- Added the `getCrossVerificationStatus` function to both the `DetectedQuadResultItem` and `NormalizedImageResultItem` classes, along with a new `EnumCrossVerificationStatus` enumeration, to retrieve the cross-verification status of the result. +- Added the `getParameterTemplateCount` and `getParameterTemplateName` functions to the `CaptureVisionRouter` class to improve accessibility and usability of templates. +- Added to-the-latest overlapping feature. You can use `enableLatestOverlapping` function of `MultiFrameResultCrossFilter` class to enable this feature. +- Added the `getFieldRawValue` method to the `ParsedResultItem` class to retrieve the raw value of the field. + +#### Fixed + +- Fixed a bug in `TextZone` caused by the absence of a custom copy constructor, which led to improper memory management with the default copy constructor. +- Fixed a bug in DPM mode where the `isMirrored` value in the `BarcodeResultItem` was not correctly assigned. +- Fixed a bug where DotCode could not be decoded in certain scenarios. +- Small fixes and tweaks. + +#### Changed + +- Updated the parameter configurations for the `DetectDocumentBoundaries_Default` and `DetectAndNormalizeDocument_Default` preset templates to default to single-document mode. +- Changed default value of `ExpectedDocumentsCount` parameter from 0 to 1 to better support single-document mode. +- Changed default value of `CornerAngleRange` parameter from [70, 110] to [60, 120] to support a wider range of document capture angles. +- Modified the return logic for `DetectedQuadResultItem` and `NormalizedImageResultItem` when `ResultCrossVerification` is `enabled`. Previously, only verified results were returned; now, results are returned regardless of verification status, and the results include a `CrossVerificationStatus` to indicate the verification state. +- Removed the `LineExtractionModes` parameter and replaced it with `ShortlineDetectionMode` and `LineAssemblyMode` for more flexible and precise configuration. + ## 2.4.2200 (10/24/2024) ### Highlights diff --git a/programming/javascript/release-notes/index.md b/programming/javascript/release-notes/index.md index 260a5bc..49f5df3 100644 --- a/programming/javascript/release-notes/index.md +++ b/programming/javascript/release-notes/index.md @@ -9,5 +9,6 @@ noTitleIndex: true # Release Notes - Dynamsoft Capture Vision Bundle JavaScript +- [2.6.1000 (01/03/2025)](dcvb.md#261000-01032025) - [2.4.2200 (10/24/2024)](dcvb.md#242200-10242024) - [2.2.3000 (07/21/2024)](dcvb.md#223000-07212024) \ No newline at end of file