Skip to content

Commit

Permalink
Merge pull request #131 from dynamsoft-docs/preview
Browse files Browse the repository at this point in the history
Preview
  • Loading branch information
Dynamsoft-Jerson authored May 15, 2024
2 parents af935c6 + 70b9d63 commit 281cb50
Show file tree
Hide file tree
Showing 51 changed files with 972 additions and 117 deletions.
2 changes: 1 addition & 1 deletion _includes/sidelist-programming/programming-android.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
<li lang="android"><a href="{{ site.dbr_android_api }}decoded-barcodes-result.html" class="otherLinkColour">DecodedBarcodesResult</a></li>
<li lang="android"><a href="{{ site.dbr_android_api }}decoded-barcodes-unit.html" class="otherLinkColour">DecodedBarcodesUnit</a></li>
<li lang="android"><a href="{{ site.dbr_android_api }}deformation-resisted-barcode-image-unit.html" class="otherLinkColour">DeformationResistedBarcodeImageUnit</a></li>
<li lang="android"><a href="{{ site.dbr_android_api }}extended-barcode-result.html" class="otherLinkColour">ExtendedBarcodeResult</a></li>
<li lang="android"><a href="{{ site.dbr_android_api }}auxiliary-ExtendedResult.html" class="otherLinkColour">ExtendedBarcodeResult</a></li>
<li lang="android"><a href="{{ site.dbr_android_api }}localized-barcodes-unit.html" class="otherLinkColour">LocalizedBarcodesUnit</a></li>
<li lang="android"><a href="{{ site.dbr_android_api }}localized-barcode-element.html" class="otherLinkColour">LocalizedBarcodesElement</a></li>
<li lang="android"><a href="{{ site.dbr_android_api }}auxiliary-OneDCodeDetails.html" class="otherLinkColour">OneDCodeDetails</a></li>
Expand Down
2 changes: 1 addition & 1 deletion _includes/sidelist-programming/programming-ios.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@
<li lang="objectivec-swift"><a href="{{ site.dbr_ios_api }}decoded-barcodes-result.html" class="otherLinkColour">DSDecodedBarcodesResult</a></li>
<li lang="objectivec-swift"><a href="{{ site.dbr_ios_api }}decoded-barcodes-unit.html" class="otherLinkColour">DSDecodedBarcodesUnit</a></li>
<li lang="objectivec-swift"><a href="{{ site.dbr_ios_api }}deformation-resisted-barcode-image-unit.html" class="otherLinkColour">DSDeformationResistedBarcodeImageUnit</a></li>
<li lang="objectivec-swift"><a href="{{ site.dbr_ios_api }}extended-barcode-result.html" class="otherLinkColour">DSExtendedBarcodeResult</a></li>
<li lang="objectivec-swift"><a href="{{ site.dbr_ios_api }}axuiliary-iExtendedResult.html" class="otherLinkColour">DSExtendedBarcodeResult</a></li>
<li lang="objectivec-swift"><a href="{{ site.dbr_ios_api }}localized-barcodes-unit.html" class="otherLinkColour">DSLocalizedBarcodesUnit</a></li>
<li lang="objectivec-swift"><a href="{{ site.dbr_ios_api }}localized-barcode-element.html" class="otherLinkColour">DSLocalizedBarcodesElement</a></li>
<li lang="objectivec-swift"><a href="{{ site.dbr_ios_api }}auxiliary-iOneDCodeDetails.html" class="otherLinkColour">DSOneDCodeDetails</a></li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
<li lang="react-native"><a href="{{ site.rn-api }}enum-dbr-preset-template.html" class="otherLinkColour">EnumDBRPresetTemplate</a></li>
<li lang="react-native"><a href="{{ site.rn-api }}enum-torch-state.html" class="otherLinkColour">EnumTorchState</a></li>
<li lang="react-native"><a href="{{ site.rn-api }}enum-camera-position.html" class="otherLinkColour">EnumCameraPosition</a></li>
<li lang="react-native"><a href="{{ site.rn-api }}enum-enhanced-features.html" class="otherLinkColour">EnumEnhancedFeatures</a></li>
</ul>
</li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
layout: default-layout
title: BufferedItemsManager - Dynamsoft Capture Vision Router Module Android Edition API Reference
description: The BufferedItemsManager class of DCV Android edition is used to manage the buffered items.
keywords: buffered items, manager, Java, Kotlin
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
---

# BufferedItemsManager

The `BufferedItemsManager` class is used to manage the buffered items.

## Definition

*Namespace:* com.dynamsoft.cvr

*Assembly:* DynamsoftCaptureVisionRouter.aar

```java
class BufferedItemsManager
```

## Methods

| Method | Description |
|------- |-------------|
| [`setMaxBufferedItems`](#setmaxbuffereditems) | Set the maximum number of buffered items. |
| [`getMaxBufferedItems`](#getmaxbuffereditems) | Get the maximum number of buffered items. |
| [`getBufferedCharacterItemSet`](#getbufferedcharacteritemset) | Get the buffered item set. |

### setMaxBufferedItems

Set the maximum number of buffered items.

```java
void setMaxBufferedItems(int count);
```

**Parameters**

`[in] count`: The maximum number of buffered items.

### getMaxBufferedItems

Get the maximum number of buffered items.

```java
int getMaxBufferedItems();
```

**Return Value**

The maximum number of buffered items.

### getBufferedCharacterItemSet

Get the buffered item set.

```java
BufferedCharacterItemSet getBufferedCharacterItemSet();
```

**Return Value**

The buffered item set.
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
---
layout: default-layout
title: SimplifiedCaptureVisionSettings - Dynamsoft Capture Vision Router Module Android Edition API Reference
description: The class SimplifiedCaptureVisionSettings of Dynamsoft Capture Vision Router Module contains settings for capturing and recognizing images with the CaptureVisionRouter class.
keywords: Capture Vision settings, Java, Kotlin
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
---

# SimplifiedCaptureVisionSettings

The `SimplifiedCaptureVisionSettings` class contains settings for capturing and recognizing images with the `CaptureVisionRouter` class.

## Definition

*Namespace:* com.dynamsoft.cvr

*Assembly:* DynamsoftCaptureVisionRouter.aar

```java
class SimplifiedCaptureVisionSettings
```

## Attributes

| Attributes | Type | Description |
| ---------- | ---- | ----------- |
| [`capturedResultItemTypes`](#capturedresultitemtypes) | *int* | Specifies the type(s) of CapturedItem(s) that will be captured. |
| [`roi`](#roi) | *[Quadrilateral](../../core/basic-structures/quadrilateral.md)* | Specifies the region of interest (ROI) where the image capture and recognition will take place. |
| [`roiMeasuredInPercentage`](#roimeasuredinpercentage) | *boolean* | Specifies whether the ROI is measured in pixels or as a percentage of the image size. |
| [`maxParallelTasks`](#maxparalleltasks) | *int* | Specifies the maximum number of parallel tasks that can be used for image capture and recognition. |
| [`minImageCaptureInterval`](#minimagecaptureinterval) | *int* | Set the minimum capture interval. It is measured in millisecond. |
| [`timeout`](#timeout) | *int* | Specifies the maximum time (in milliseconds) allowed for image capture and recognition. |
| [`barcodeSettings`](#barcodesettings) | *[SimplifiedBarcodeReaderSettings]({{ site.dbr_android_api }}simplified-barcode-reader-settings.html) \** | Specifies the settings for `DynamsoftBarcodeReader` tasks. |
| [`labelSettings`](#labelsettings) | *[SimplifiedLabelRecognizerSettings]({{ site.dlr_android_api }}simplified-label-recognizer-settings.html) \** | Specifies the settings for `DynamsoftLabelRecognizer` tasks. |
| [`documentSettings`](#documentsettings) | *[SimplifiedDocumentNormalizerSettings]({{ site.ddn_android_api }}simplified-document-normalizer-settings.html) \** | Specifies the settings for `DynamsoftDocumentNormalizer` tasks. |

### capturedResultItemTypes

Specifies the type(s) of CapturedItem(s) that will be captured.

```java
int capturedResultItemTypes;
```

### roi

Specifies the region of interest (ROI) where the image capture and recognition will take place.

```java
Quadrilateral roi;
```

### roiMeasuredInPercentage

Specifies whether the ROI is measured in pixels or as a percentage of the image size.

```java
boolean roiMeasuredInPercentage;
```

### maxParallelTasks

Specifies the maximum number of parallel tasks that can be used for image capture and recognition.

```java
int maxParallelTasks;
```

### minImageCaptureInterval

Set the minimum capture interval. It is measured in millisecond.

```java
int minImageCaptureInterval;
```

### timeout

Specifies the maximum time (in milliseconds) allowed for image capture and recognition.

```java
int timeout;
```

### barcodeSettings

Specifies the settings for `DynamsoftBarcodeReader` tasks with a [`SimplifiedBarcodeReaderSettings`]({{ site.dbr_android_api }}simplified-barcode-reader-settings.html) object.

```java
SimplifiedBarcodeReaderSettings barcodeSettings;
```

### labelSettings

Specifies the settings for `DynamsoftLabelRecognizer` tasks with a [`SimplifiedLabelRecognizerSettings`]({{ site.dlr_android_api }}simplified-label-recognizer-settings.html) object.

```java
SimplifiedLabelRecognizerSettings labelSettings;
```

### documentSettings

Specifies the settings for `DynamsoftDocumentNormalizer` tasks with a [`SimplifiedDocumentNormalizerSettings`]({{ site.ddn_android_api }}simplified-document-normalizer-settings.html) object.

```java
SimplifiedDocumentNormalizerSettings documentSettings;
```
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,15 @@ The `SimplifiedCaptureVisionSettings` class contains settings for capturing and
class SimplifiedCaptureVisionSettings
```

## Attributes
## Methods & Attributes

| Attributes | Type | Description |
| ---------- | ---- | ----------- |
| Method | Description |
|----------------------|-------------|
| [`toJSON`](#tojson) | Generate the current `SimplifiedCaptureVisionSettings` object to a JSON string. |
| [`fromJSON`](#fromjson) | Generate a `SimplifiedCaptureVisionSettings` object from a JSON string. |

| Attribute | Type | Description |
| --------- | ---- | ----------- |
| [`capturedResultItemTypes`](#capturedresultitemtypes) | *int* | Specifies the type(s) of CapturedItem(s) that will be captured. |
| [`roi`](#roi) | *[Quadrilateral](../../core/basic-structures/quadrilateral.md)* | Specifies the region of interest (ROI) where the image capture and recognition will take place. |
| [`roiMeasuredInPercentage`](#roimeasuredinpercentage) | *boolean* | Specifies whether the ROI is measured in pixels or as a percentage of the image size. |
Expand All @@ -36,6 +41,30 @@ class SimplifiedCaptureVisionSettings
| [`labelSettings`](#labelsettings) | *[SimplifiedLabelRecognizerSettings]({{ site.dlr_android_api }}simplified-label-recognizer-settings.html) \** | Specifies the settings for `DynamsoftLabelRecognizer` tasks. |
| [`documentSettings`](#documentsettings) | *[SimplifiedDocumentNormalizerSettings]({{ site.ddn_android_api }}simplified-document-normalizer-settings.html) \** | Specifies the settings for `DynamsoftDocumentNormalizer` tasks. |

### toJSON

Transform the current `SimplifiedLabelRecognizerSettings` object to a JSON string.

```java
String toJSON();
```

**Return Value**

The string that generated from the current `SimplifiedLabelRecognizerSettings` object.

### fromJSON

Generate a `SimplifiedLabelRecognizerSettings` object from a JSON string.

```java
static SimplifiedLabelRecognizerSettings fromJSON(String jsonString);
```

**Return Value**

The generated `SimplifiedLabelRecognizerSettings` object.

### capturedResultItemTypes

Specifies the type(s) of CapturedItem(s) that will be captured.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
layout: default-layout
title: Buffered Items APIs of CaptureVisionRouter - Dynamsoft Capture Vision Router Module Android Edition API Reference
description: Buffered items APIs references for DCV Android Edition.
keywords: capture vision, intermediate result, Java, Kotlin
needGenerateH3Content: true
needAutoGenerateSidebar: true
noTitleIndex: true
---

# Buffered Items

## Methods

| Method | Description |
|------- |-------------|
| [`getBufferedItemsManager`](#getbuffereditemsmanager) | Returns the manager instance of buffered items. |

### getBufferedItemsManager

Returns the manager instance of buffered items.

```java
BufferedItemsManager getBufferedItemsManager();
```

**Return Value**

Returns the manager instance of buffered items.

**Remarks**

When the maximum number of buffered items is set to greater than 0, item buffering is enabled. Currently only character items can be buffered.
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ noTitleIndex: true
| [`resumeCapturing`](#resumecapturing) | Resumes the Capture Vision Router. |
| [`addCaptureStateListener`](#addcapturestatelistener) | Registers a [`CaptureStateListener`](auxiliary-classes/capture-state-listener.html) to be used as a callback when capture state is received. |
| [`removeCaptureStateListener`](#removecapturestatelistener) | Removes a [`CaptureStateListener`](auxiliary-classes/capture-state-listener.html) that has been configured for the Capture Vision Router. |
| [`addResultFilter`](#addresultfilter) | Adds a `DSCapturedResultFilter` object to filter non-essential results. |
| [`removeResultFilter`](#removeresultfilter) | Removes the specified `DSCapturedResultFilter` object. |
| [`addResultFilter`](#addresultfilter) | Adds a `CapturedResultFilter` object to filter non-essential results. |
| [`removeResultFilter`](#removeresultfilter) | Removes the specified `CapturedResultFilter` object. |
| [`addImageSourceStateListener`](#addimagesourcestatelistener) | Register a [`ImageSourceStateListener`](auxiliary-classes/image-source-state-listener.html) to get callback when the status of [`ImageSourceAdapter`]({{ site.dcv_android_api }}core/basic-structures/image-source-adapter.html) received. |
| [`removeImageSourceStateListener`](#removeimagesourcestatelistener) | Removes a [`ImageSourceStateListener`](auxiliary-classes/image-source-state-listener.html) from the Capture Vision Router. |

Expand Down Expand Up @@ -131,7 +131,7 @@ void resumeCapturing();

## addResultFilter

Adds a `DSCapturedResultFilter` object to filter non-essential results. Currnetly, [`MultiFrameCrossFilter`]({{ site.dcv_android_api }}utility/multi-frame-result-cross-filter.html) is the only supported implementation of the `CapturedResultFilter`.
Adds a `CapturedResultFilter` object to filter non-essential results. Currnetly, [`MultiFrameCrossFilter`]({{ site.dcv_android_api }}utility/multi-frame-result-cross-filter.html) is the only supported implementation of the `CapturedResultFilter`.

```java
void addResultFilter(CapturedResultFilter filter);
Expand All @@ -143,7 +143,7 @@ void addResultFilter(CapturedResultFilter filter);

## removeResultFilter

Removes the specified `DSCapturedResultFilter` object.
Removes the specified `CapturedResultFilter` object.

```java
void removeResultFilter(CapturedResultFilter filter);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,17 @@ The `LineSegment` class represents a line segment in 2D space, which contains th
class LineSegment
```

## Attribute Summaries
## Methods & Attributes

| Attributes | Type | Description |
| ---------- | ---- | ----------- |
| [`startPoint`](#startpoint) | *android.graphics.Point* | The starting point of the line segment. |
| [`endPoint`](#endpoint) | *android.graphics.Point* | The ending point of the line segment. |

## Method Summaries

| Method | Description |
| ------ | ----------- |
| [`LineSegment`](#linesegment-1) | The constructor. |

## Attribute Details

### startPoint

The start point of the line segment.
Expand All @@ -53,8 +49,6 @@ The end point of the line segment.
Point endPoint;
```

## Method Details

### LineSegment

The constructor.
Expand Down
Loading

0 comments on commit 281cb50

Please sign in to comment.