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
10 changes: 10 additions & 0 deletions _includes/sidelist-programming/programming-android.html
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,7 @@
<li lang="android"><a href="{{ site.dcv_android_api }}core/enum/image-tag-type.html?lang=android" class="otherLinkColour">ImageTagType</a></li>
<li lang="android"><a href="{{ site.dcv_android_api }}core/enum/intermediate-result-unit-type.html?lang=android" class="otherLinkColour">IntermediateResultUnitType</a></li>
<li lang="android"><a href="{{ site.dcv_android_api }}core/enum/log-mode.html?lang=android" class="otherLinkColour">LogMode</a></li>
<li lang="android"><a href="{{ site.dcv_android_api }}core/enum/measure-unit.html?lang=android" class="otherLinkColour">MeasureUnit</a></li>
<li lang="android"><a href="{{ site.dcv_android_api }}core/enum/region-object-element-type.html?lang=android" class="otherLinkColour">RegionObjectElementType</a></li>
<li lang="android"><a href="{{ site.dcv_android_api }}core/enum/section-type.html?lang=android" class="otherLinkColour">SectionType</a></li>
<li lang="android"><a href="{{ site.dcv_android_api }}core/enum/transform-matrix-type.html?lang=android" class="otherLinkColour">TransformMatrixType</a></li>
Expand Down Expand Up @@ -242,13 +243,20 @@
<li lang="android"><a href="{{ site.dcv_android_api }}utility/image-processor.html" class="otherLinkColour">ImageProcessor</a></li>
<li lang="android"><a href="{{ site.dcv_android_api }}utility/multi-frame-result-cross-filter.html" class="otherLinkColour">MultiFrameResultCrossFilter</a></li>
<li lang="android"><a href="{{ site.dcv_android_api }}utility/proactive-image-source-adapter.html" class="otherLinkColour">ProactiveImageSourceAdapter</a></li>
<li lang="android"><a href="{{ site.dcv_android_api }}utility/layout-analysis-parameter.html" class="otherLinkColour">LayoutAnalysisParameter</a></li>
<li lang="android"><a href="{{ site.dcv_android_api }}utility/layout-analysis-result.html" class="otherLinkColour">LayoutAnalysisResult</a></li>
<li lang="android"><a href="{{ site.dcv_android_api }}utility/layout-analyzer.html" class="otherLinkColour">LayoutAnalyzer</a></li>
<li lang="android"><a href="{{ site.dcv_android_api }}utility/layout-axis.html" class="otherLinkColour">LayoutAxis</a></li>
<li lang="android"><a href="{{ site.dcv_android_api }}utility/layout-element.html" class="otherLinkColour">LayoutElement</a></li>
<li lang="android"><a href="{{ site.dcv_android_api }}utility/utility-exception.html" class="otherLinkColour">UtilityException</a></li>
<li lang="android"><a href="{{ site.dcv_android_api }}utility/utility-module.html" class="otherLinkColour">UtilityModule</a></li>
</ul>
</li>
<li lang="android"><a>Enumerations</a>
<ul lang="android">
<li lang="android"><a href="{{ site.dcv_android_api }}utility/enum/filter-type.html" class="otherLinkColour">EnumFilterType</a></li>
<li lang="android"><a href="{{ site.dcv_android_api }}utility/enum/layout-element-source.html" class="otherLinkColour">EnumLayoutElementSource</a></li>
<li lang="android"><a href="{{ site.dcv_android_api }}utility/enum/layout-pattern.html" class="otherLinkColour">EnumLayoutPattern</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -551,6 +559,7 @@
<ul>
<li><a href="{{ site.dcv_parameters_reference }}label-recognizer-task-settings/stage-localize-text-lines.html#stage" class="otherLinkColour">Stage</a></li>
<li><a href="{{ site.dcv_parameters_reference }}label-recognizer-task-settings/localization-modes.html" class="otherLinkColour">LocalizationModes</a></li>
<li><a href="{{ site.dcv_parameters_reference }}label-recognizer-task-settings/orientation-detection-modes.html" class="otherLinkColour">OrientationDetectionModes</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -794,6 +803,7 @@
<ul>
<li><a href="{{ site.dcv_parameters_reference }}barcode-format-specification/all-module-deviation.html" class="otherLinkColour">AllModuleDeviation</a></li>
<li><a href="{{ site.dcv_parameters_reference }}barcode-format-specification/australian-post-encoding-table.html" class="otherLinkColour">AustralianPostEncodingTable</a></li>
<li><a href="{{ site.dcv_parameters_reference }}barcode-format-specification/auto-detect-color-inversion.html" class="otherLinkColour">AutoDetectColorInversion</a></li>
<li><a href="{{ site.dcv_parameters_reference }}barcode-format-specification/barcode-angle-range-array.html" class="otherLinkColour">BarcodeAngleRangeArray</a></li>
<li><a href="{{ site.dcv_parameters_reference }}barcode-format-specification/barcode-bytes-length-range-array.html" class="otherLinkColour">BarcodeBytesLengthRangeArray</a></li>
<li><a href="{{ site.dcv_parameters_reference }}barcode-format-specification/barcode-format-ids.html" class="otherLinkColour">BarcodeFormatIds</a></li>
Expand Down
10 changes: 10 additions & 0 deletions _includes/sidelist-programming/programming-ios.html
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,7 @@
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}core/enum/image-tag-type.html?lang=objc,swift" class="otherLinkColour">DSImageTagType</a></li>
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}core/enum/intermediate-result-unit-type.html?lang=objc,swift" class="otherLinkColour">DSIntermediateResultUnitType</a></li>
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}core/enum/log-mode.html?lang=objc,swift" class="otherLinkColour">DSLogMode</a></li>
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}core/enum/measure-unit.html?lang=objc,swift" class="otherLinkColour">DSMeasureUnit</a></li>
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}core/enum/region-object-element-type.html?lang=objc,swift" class="otherLinkColour">DSRegionObjectElementType</a></li>
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}core/enum/section-type.html?lang=objc,swift" class="otherLinkColour">DSSectionType</a></li>
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}core/enum/transform-matrix-type.html?lang=objc,swift" class="otherLinkColour">DSTransformMatrixType</a></li>
Expand Down Expand Up @@ -247,12 +248,19 @@
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}utility/image-processor.html" class="otherLinkColour">DSImageProcessor</a></li>
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}utility/multi-frame-result-cross-filter.html" class="otherLinkColour">DSMultiFrameResultCrossFilter</a></li>
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}utility/proactive-image-source-adapter.html" class="otherLinkColour">DSProactiveImageSourceAdapter</a></li>
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}utility/layout-analysis-parameter.html" class="otherLinkColour">DSLayoutAnalysisParameter</a></li>
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}utility/layout-analysis-result.html" class="otherLinkColour">DSLayoutAnalysisResult</a></li>
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}utility/layout-analyzer.html" class="otherLinkColour">DSLayoutAnalyzer</a></li>
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}utility/layout-axis.html" class="otherLinkColour">DSLayoutAxis</a></li>
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}utility/layout-element.html" class="otherLinkColour">DSLayoutElement</a></li>
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}utility/utility-module.html" class="otherLinkColour">DSUtilityModule</a></li>
</ul>
</li>
<li lang="objectivec-swift"><a>Enumerations</a>
<ul lang="objectivec-swift">
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}utility/enum/filter-type.html?lang=objc,swift" class="otherLinkColour">DSFilterType</a></li>
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}utility/enum/layout-element-source.html?lang=objc,swift" class="otherLinkColour">DSLayoutElementSource</a></li>
<li lang="objectivec-swift"><a href="{{ site.dcv_ios_api }}utility/enum/layout-pattern.html?lang=objc,swift" class="otherLinkColour">DSLayoutPattern</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -555,6 +563,7 @@
<ul>
<li><a href="{{ site.dcv_parameters_reference }}label-recognizer-task-settings/stage-localize-text-lines.html#stage" class="otherLinkColour">Stage</a></li>
<li><a href="{{ site.dcv_parameters_reference }}label-recognizer-task-settings/localization-modes.html" class="otherLinkColour">LocalizationModes</a></li>
<li><a href="{{ site.dcv_parameters_reference }}label-recognizer-task-settings/orientation-detection-modes.html" class="otherLinkColour">OrientationDetectionModes</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -798,6 +807,7 @@
<ul>
<li><a href="{{ site.dcv_parameters_reference }}barcode-format-specification/all-module-deviation.html" class="otherLinkColour">AllModuleDeviation</a></li>
<li><a href="{{ site.dcv_parameters_reference }}barcode-format-specification/australian-post-encoding-table.html" class="otherLinkColour">AustralianPostEncodingTable</a></li>
<li><a href="{{ site.dcv_parameters_reference }}barcode-format-specification/auto-detect-color-inversion.html" class="otherLinkColour">AutoDetectColorInversion</a></li>
<li><a href="{{ site.dcv_parameters_reference }}barcode-format-specification/barcode-angle-range-array.html" class="otherLinkColour">BarcodeAngleRangeArray</a></li>
<li><a href="{{ site.dcv_parameters_reference }}barcode-format-specification/barcode-bytes-length-range-array.html" class="otherLinkColour">BarcodeBytesLengthRangeArray</a></li>
<li><a href="{{ site.dcv_parameters_reference }}barcode-format-specification/barcode-format-ids.html" class="otherLinkColour">BarcodeFormatIds</a></li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ This page introduces the `capture` APIs of the `CaptureVisionRouter` that design
| [`capture(fileBytes,templateName)`](#capturefilebytestemplatename) | Processes a single image or a file containing a single image to derive important information with the file bytes in the memory. |
| [`capture(imageData,templateName)`](#captureimagedatatemplatename) | Processes a single image or a file containing a single image to derive important information with an [`ImageData`](../core/basic-structures/image-data.md) object. |
| [`capture(bitmap,templateName)`](#capturebitmaptemplatename) | Processes a single image or a file containing a single image to derive important information with a `Bitmap`. |
| [`captureMultiPages(filePath,templateName)`](#capturemultipagesfilepathtemplatename) | Processes a multi-page file to derive important information with the file path. |
| [`captureMultiPages(fileBytes,templateName)`](#capturemultipagesfilebytestemplatename) | Processes a multi-page file to derive important information with the file bytes in the memory. |
| [`captureMultiPages(fileFetcher,templateName)`](#capturemultipagesfilefetchertemplatename) | Processes a multi-page file to derive important information with a `FileFetcher`. |

## capture(filePath,templateName)

Expand Down Expand Up @@ -158,3 +161,69 @@ Possible errors:
| EC_TEMPLATE_NAME_INVALID | -10036 | The target template name is invalid. |
| EC_CALL_REJECTED_WHEN_CAPTURING | -10062 | Function call is rejected when capturing in progress. |
| EC_MULTI_PAGES_NOT_SUPPORTED | -10066 | The api does not support multi-page files. Please use FileFetcher instead. |

## captureMultiPages(filePath,templateName)

Processes a multi-page file to derive important information with the file path.

```java
CapturedResult[] captureMultiPages(String filePath, String templateName);
```

**Parameters**

`[in] filePath`: The file path and name that you want to capture data from.

`[in] templateName`: Specifies a "CaptureVisionTemplate" to use. The following value are available for this parameter:

- One of the [`EnumPresetTemplate`]({{ site.dcv_android_api }}capture-vision-router/enum/preset-template.html?lang=android) member. This is available only if you have never upload a new template via `initSettings` or `initSettingsFromFile`.
- A string that represents one of the template name that you have uploaded via `initSettings` or `initSettingsFromFile`.
- "" (empty string) to use the default template. The first template will be used if you have uploaded a template file via `initSettingsFromFile` or `initSettings`.

**Return Value**

An array of [`CapturedResult`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result.html) objects which contains the derived information from each page of the file.

## captureMultiPages(fileBytes,templateName)

Processes a multi-page file to derive important information with the file bytes in the memory.

```java
CapturedResult[] captureMultiPages(byte[] fileBytes, String templateName);
```

**Parameters**

`[in] fileBytes`: A byte array that points to a file in memory.

`[in] templateName`: Specifies a "CaptureVisionTemplate" to use. The following value are available for this parameter:

- One of the [`EnumPresetTemplate`]({{ site.dcv_android_api }}capture-vision-router/enum/preset-template.html?lang=android) member. This is available only if you have never upload a new template via `initSettings` or `initSettingsFromFile`.
- A string that represents one of the template name that you have uploaded via `initSettings` or `initSettingsFromFile`.
- "" (empty string) to use the default template. The first template will be used if you have uploaded a template file via `initSettingsFromFile` or `initSettings`.

**Return Value**

An array of [`CapturedResult`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result.html) objects which contains the derived information from each page of the file.

## captureMultiPages(fileFetcher,templateName)

Processes a multi-page file to derive important information with a [`FileFetcher`]({{ site.dcv_android_api }}utility/file-fetcher.html).

```java
CapturedResult[] captureMultiPages(FileFetcher fileFetcher, String templateName);
```

**Parameters**

`[in] fileFetcher`: A [`FileFetcher`]({{ site.dcv_android_api }}utility/file-fetcher.html) object.

`[in] templateName`: Specifies a "CaptureVisionTemplate" to use. The following value are available for this parameter:

- One of the [`EnumPresetTemplate`]({{ site.dcv_android_api }}capture-vision-router/enum/preset-template.html?lang=android) member. This is available only if you have never upload a new template via `initSettings` or `initSettingsFromFile`.
- A string that represents one of the template name that you have uploaded via `initSettings` or `initSettingsFromFile`.
- "" (empty string) to use the default template. The first template will be used if you have uploaded a template file via `initSettingsFromFile` or `initSettings`.

**Return Value**

An array of [`CapturedResult`]({{ site.dcv_android_api }}capture-vision-router/auxiliary-classes/captured-result.html) objects which contains the derived information from each page of the file.
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ class Quadrilateral
| [`transformByMatrix`](#transformbymatrix) | Transforms the coordinates of the quadrilateral by a transformation matrix. |
| [`getBoundingRect`](#getboundingrect) | Get the bounding rectangle of the quadrilateral. |
| [`getArea`](#getarea) | Get the area of the quadrilateral. |
| [`getCentrePoint`](#getcentrepoint) | Get the centre point of the quadrilateral. |

### points

Expand Down Expand Up @@ -156,3 +157,15 @@ int getArea();
**Return Value**

The area of the quadrilateral.

### getCentrePoint

Gets the centre point of the quadrilateral.

```java
Point getCentrePoint();
```

**Return Value**

The centre point of the quadrilateral.
21 changes: 21 additions & 0 deletions programming/android/api-reference/core/enum/measure-unit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
layout: default-layout
title: MeasureUnit - Dynamsoft Capture Vision Android Enumerations
description: The enumeration MeasureUnit of Dynamsoft Capture Vision Android edition describes the unit of measurement for a value.
keywords: measure unit, pixel, percentage
codeAutoHeight: true
---

# Enumeration MeasureUnit

`MeasureUnit` describes the unit of measurement for a value.

```java
public @interface EnumMeasureUnit
{
/**The value is an absolute pixel count.*/
public static final int MU_PIXEL = 0;
/**The value is a percentage of the reference dimension (e.g. 25 = 25%).*/
public static final int MU_PERCENTAGE = 1;
}
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
layout: default-layout
title: LayoutElementSource - Dynamsoft Capture Vision Android Enumerations
description: The enumeration LayoutElementSource of Dynamsoft Capture Vision Android edition describes the origin of a layout element.
keywords: layout element source
codeAutoHeight: true
---

# Enumeration LayoutElementSource

`LayoutElementSource` describes the origin of a layout element.

```java
public @interface EnumLayoutElementSource
{
/**No element exists at this logical grid position.*/
public static final int LES_NONE = 0;
/**Element is provided from the original input array.*/
public static final int LES_INPUT = 1;
/**Element is reconstructed or filled in by the algorithm.*/
public static final int LES_INFERRED = 2;
}
```
23 changes: 23 additions & 0 deletions programming/android/api-reference/utility/enum/layout-pattern.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
layout: default-layout
title: LayoutPattern - Dynamsoft Capture Vision Android Enumerations
description: The enumeration LayoutPattern of Dynamsoft Capture Vision Android edition describes the layout pattern for quadrilateral analysis.
keywords: layout pattern
codeAutoHeight: true
---

# Enumeration LayoutPattern

`LayoutPattern` describes the layout pattern for quadrilateral analysis.

```java
public @interface EnumLayoutPattern
{
/**Algorithm automatically detects the best layout pattern.*/
public static final int LP_UNKNOWN = 0;
/**Elements are organized into sequential lines (rows or columns).*/
public static final int LP_LINES = 1;
/**Elements are organized into a strict grid/matrix structure.*/
public static final int LP_MATRIX = 2;
}
```
Loading