diff --git a/_includes/api-reference/region-object-element-android.md b/_includes/api-reference/region-object-element-android.md index e1f89ceb..4cf4e5c5 100644 --- a/_includes/api-reference/region-object-element-android.md +++ b/_includes/api-reference/region-object-element-android.md @@ -3,9 +3,9 @@ | Method | Description | |------- |-------------| -| [`getLocation`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getlocation) | Returns the location info of the element. | -| [`setLocation`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#setlocation) | Sets the location info of the element. | -| [`getReferencedElement`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getreferencedelement) | Returns the referenced element that supports the capturing of this element. | -| [`getRegionObjectElementType`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getregionobjectelementtype) | Returns the type of the element. | +| [`getImageData`]({{ site.dcv_android_api }}core/intermediate-results/region-object-element.html#getlocation) | Returns the ImageData of the image that produce this element. | +| [`getLocation`]({{ site.dcv_android_api }}core/intermediate-results/region-object-element.html#getlocation) | Returns the location info of the element. | +| [`getReferencedElement`]({{ site.dcv_android_api }}core/intermediate-results/region-object-element.html#getreferencedelement) | Returns the referenced element that supports the capturing of this element. | +| [`getType`]({{ site.dcv_android_api }}core/intermediate-results/region-object-element.html#getregionobjectelementtype) | Returns the type of the element. | diff --git a/_includes/api-reference/region-object-element-ios.md b/_includes/api-reference/region-object-element-ios.md index e1f89ceb..b8a37a13 100644 --- a/_includes/api-reference/region-object-element-ios.md +++ b/_includes/api-reference/region-object-element-ios.md @@ -1,11 +1,8 @@ - | Method | Description | |------- |-------------| -| [`getLocation`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getlocation) | Returns the location info of the element. | -| [`setLocation`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#setlocation) | Sets the location info of the element. | -| [`getReferencedElement`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getreferencedelement) | Returns the referenced element that supports the capturing of this element. | -| [`getRegionObjectElementType`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getregionobjectelementtype) | Returns the type of the element. | - - +| [`getLocation`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getlocation) | Gets the location of the region object, represented as a quadrilateral. | +| [`getReferencedElement`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getreferencedelement) | Gets the referenced element that supports the capturing of this element. | +| [`getRegionObjectElementType`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getregionobjectelementtype) | Gets the type of the region object element, defined by the enumeration [`DSRegionObjectElementType`]({{ site.dcv_ios_api }}core/enum/region-object-element-type.html?lang=objc,swift). | +| [`getImageData`]({{ site.dcv_ios_api }}core/intermediate-results/region-object-element.html#getimagedata) | Gets the image data of this region object element. | diff --git a/programming/android/api-reference/auxiliary-AztecDetails.md b/programming/android/api-reference/auxiliary-AztecDetails.md index feb88c6c..062d219c 100644 --- a/programming/android/api-reference/auxiliary-AztecDetails.md +++ b/programming/android/api-reference/auxiliary-AztecDetails.md @@ -27,19 +27,10 @@ class AztecDetails extends BarcodeDetails | Method | Description | | ------ | ----------- | -| [`AztecDetails`](#aztecdetails) | The constructor which initializes a new instance of the AztecDetails class. | | [`getRows`](#getrows) | Returns the number of rows of the Aztec barcode. | | [`getColumns`](#getcolumns) | Returns the number of columns in the Aztec barcode. | | [`getLayerNumber`](#getlayernumber) | Returns the layer number of the Aztec barcode. | -### AztecDetails - -The constructor. Initializes a new instance of the AztecDetails class. - -```java -AztecDetails() -``` - ### getRows Returns the number of rows of the Aztec barcode, indicating how many rows of modules it contains. diff --git a/programming/android/api-reference/auxiliary-DataMatrixDetails.md b/programming/android/api-reference/auxiliary-DataMatrixDetails.md index 6ff83071..329b20ed 100644 --- a/programming/android/api-reference/auxiliary-DataMatrixDetails.md +++ b/programming/android/api-reference/auxiliary-DataMatrixDetails.md @@ -27,21 +27,12 @@ class DataMatrixDetails extends BarcodeDetails | Method | Description | | ------ | ----------- | -| [`DataMatrixDetails`](#datamatrixdetails-1) | The constructor for the DataMatrixDetails class. | | [`getRows`](#getrows) | Returns the number of rows of the Data Matrix barcode. | | [`getColumns`](#getcolumns) | Returns the number of columns of the Data Matrix barcode. | | [`getDataRegionRows`](#getdataregionrows) | Returns the number of rows in the data region of the Data Matrix barcode. | | [`getDataRegionColumns`](#getdataregioncolumns) | Returns the number of columns in the data region of the Data Matrix barcode. | | [`getDataRegionNumber`](#getdataregionnumber) | Returns the number of data regions in the Data Matrix barcode. | -### DataMatrixDetails - -The constructor for the DataMatrixDetails class. - -```java -DataMatrixDetails(); -``` - ### getRows Returns the number of rows of the Data Matrix barcode, indicating how many rows of data modules it contains. @@ -95,7 +86,7 @@ An integer representing the column count of the barcode data region. Returns the number of data regions in the Data Matrix barcode. Data Matrix barcodes can have multiple data regions for storing data redundantly or for error correction purposes. ```java -int getDataRegionNumber +int getDataRegionNumber(); ``` **Return Value** diff --git a/programming/android/api-reference/auxiliary-ExtendedResult.md b/programming/android/api-reference/auxiliary-ExtendedResult.md index cda71544..452052e7 100644 --- a/programming/android/api-reference/auxiliary-ExtendedResult.md +++ b/programming/android/api-reference/auxiliary-ExtendedResult.md @@ -67,7 +67,8 @@ The following methods are inherited from class [`RegionObjectElement`]({{ site.d Returns the type of the extended barcode result as a [`ExtendedBarcodeResultType`]({{ site.dbr_android_api }}enum/extended-barcode-result-type.html?lang=android) enumeration item. ```java -EnumExtendedBarcodeResultType getExtendedBarcodeResultType(); +@EnumExtendedBarcodeResultType +int getExtendedBarcodeResultType(); ``` **Return Value** diff --git a/programming/android/api-reference/auxiliary-OneDCodeDetails.md b/programming/android/api-reference/auxiliary-OneDCodeDetails.md index 38068dd7..e58358ec 100644 --- a/programming/android/api-reference/auxiliary-OneDCodeDetails.md +++ b/programming/android/api-reference/auxiliary-OneDCodeDetails.md @@ -27,7 +27,6 @@ class OneDCodeDetails extends BarcodeDetails | Method | Description | | ------ | ----------- | -| [`OneDCodeDetails`](#onedcodedetails-1) | The constructor. Initializes a new instance of the OneDCodeDetails class. | | [`getStartCharsBytes`](#getstartcharsbytes) | Returns the start characters of the 1D barcode in a byte array. | | [`getStopCharsBytes`](#getstopcharsbytes) | Returns the stop characters of the 1D barcode in a byte array. | | [`getCheckDigitBytes`](#getcheckdigitbytes) | Returns the check digit characters of the 1D barcode in a byte array. | @@ -35,14 +34,6 @@ class OneDCodeDetails extends BarcodeDetails | [`getMiddlePatternRange`](#getmiddlepatternrange) | Returns the position range of the middle pattern relative to the barcode's location. | | [`getEndPatternRange`](#getendpatternrange) | Returns the position of the end pattern relative to the barcode location. | -### OneDCodeDetails - -The constructor. Initializes a new instance of the `OneDCodeDetails` class. - -```java -OneDCodeDetails(); -``` - ### getStartCharsBytes Returns the start characters of the 1D barcode in a byte array. Start characters are often used to identify the beginning of the barcode. @@ -53,7 +44,7 @@ byte[] getStartCharsBytes(); **Return Value** -A [Byte](https://developer.android.com/reference/java/lang/Byte){:target="_blank"} object representing the start characters of the 1D barcode. +A byte array representing the start characters of the 1D barcode. ### getStopCharsBytes @@ -65,7 +56,7 @@ byte[] getStopCharsBytes(); **Return Value** -A [Byte](https://developer.android.com/reference/java/lang/Byte){:target="_blank"} object representing the stop characters of the 1D barcode. +A byte array representing the stop characters of the 1D barcode. ### getCheckDigitBytes @@ -77,7 +68,7 @@ byte[] getCheckDigitBytes(); **Return Value** -A [Byte](https://developer.android.com/reference/java/lang/Byte){:target="_blank"} object representing the check digit characters of the 1D barcode. +A byte array representing the check digit characters of the 1D barcode. ### getStartPatternRange diff --git a/programming/android/api-reference/auxiliary-PDF417Details.md b/programming/android/api-reference/auxiliary-PDF417Details.md index 287bd947..ddace4c5 100644 --- a/programming/android/api-reference/auxiliary-PDF417Details.md +++ b/programming/android/api-reference/auxiliary-PDF417Details.md @@ -27,7 +27,6 @@ class PDF417Details extends BarcodeDetails | Method | Description | | ------ | ----------- | -| [`PDF417Details`](#pdf417details-1) | The constructor. Initializes a new instance of the `PDF417Details` class. | | [`getRows`](#getrows) | Returns the number of rows in the PDF417 barcode. | | [`getCodewords`](#getcodewords) | Returns the code words of the PDF417 barcode. | | [`getColumns`](#getcolumns) | Returns the number of columns in the PDF417 barcode. | @@ -35,14 +34,6 @@ class PDF417Details extends BarcodeDetails | [`hasLeftRowIndicator`](#hasleftrowindicator) | Indicates whether the left row indicator of the PDF417 code exists. | | [`hasRightRowIndicator`](#hasrightrowindicator) | Indicates whether the right row indicator of the PDF417 code exists. | -### PDF417Details - -The constructor. Initializes a new instance of the `PDF417Details` class. - -```java -PDF417Details(); -``` - ### getRows Returns the number of rows in the PDF417 barcode, indicating how many rows of modules it contains. @@ -60,7 +51,7 @@ An integer representing the number of rows in the PDF417 barcode. Returns the code words of the PDF417 barcode. ```java -byte[] getCodewords(); +int[] getCodewords(); ``` **Return Value** diff --git a/programming/android/api-reference/auxiliary-QRCodeDetails.md b/programming/android/api-reference/auxiliary-QRCodeDetails.md index 6c55b8cc..2ed06c62 100644 --- a/programming/android/api-reference/auxiliary-QRCodeDetails.md +++ b/programming/android/api-reference/auxiliary-QRCodeDetails.md @@ -27,7 +27,6 @@ class QRCodeDetails extends BarcodeDetails | Method | Description | | ------ | ----------- | -| [`QRCodeDetails`](#qrcodedetails-1) | The constructor. Initializes a new instance of the `QRCodeDetails` class. | | [`getRows`](#getrows) | Returns the number of rows in the QR Code. | | [`getColumns`](#getcolumns) | Returns the number of columns in the QR Code. | | [`getErrorCorrectionLevel`](#geterrorcorrectionlevel) | Returns the error correction level of the QR Code.| @@ -40,14 +39,6 @@ class QRCodeDetails extends BarcodeDetails | [`getDataMaskPattern`](#getdatamaskpattern) | Gets the data mask pattern reference for QR Code symbols. | | [`getCodewords`](#getcodewords) | Gets the codewords of the QR Code. | -### QRCodeDetails - -The constructor. Initializes a new instance of the `QRCodeDetails` class. - -```java -QRCodeDetails() -``` - ### getRows Returns the number of rows in the QR Code. diff --git a/programming/android/api-reference/candidate-barcode-zone.md b/programming/android/api-reference/candidate-barcode-zone.md index cbff5313..8d89f7f3 100644 --- a/programming/android/api-reference/candidate-barcode-zone.md +++ b/programming/android/api-reference/candidate-barcode-zone.md @@ -22,13 +22,17 @@ breadcrumbText: CandidateBarcodeZone class CandidateBarcodeZone ``` -## Attributes +## Attributes & Methods | Attribute | Description | | --------- | ------------| | [`location`](#location) | The location of the candidate barcode zone. | | [`possibleFormats`](#possibleformats) | The possible barcode formats of the barcode in the candidate barcode zone. | +| Method | Description | +| ------ | ----------- | +| [`CandidateBarcodeZone`](#candidatebarcodezone) | The constructor. | + ### location The location of the candidate barcode zone within the image represented as a [`Quadrilateral`]({{ site.dcvb_android_api }}core/basic-structures/quadrilateral.html). @@ -44,3 +48,11 @@ The possible format(s) of the barcode in the candidate barcode zone. ```java long possibleFormats; ``` + +### CandidateBarcodeZone + +The constructor. + +```java +CandidateBarcodeZone(@NonNull Quadrilateral location, @EnumBarcodeFormat long possibleFormats); +``` diff --git a/programming/android/api-reference/decoded-barcode-element.md b/programming/android/api-reference/decoded-barcode-element.md index dd654b90..ce2c3cc8 100644 --- a/programming/android/api-reference/decoded-barcode-element.md +++ b/programming/android/api-reference/decoded-barcode-element.md @@ -42,6 +42,7 @@ class DecodedBarcodeElement extends RegionObjectElement | [`setConfidence`](#setconfidence) | Set the confidence score of the barcode recognition result. | | [`getDetails`](#getdetails) | Returns the `BarcodeDetails` of the decoded barcode. | | [`getExtendedBarcodeResults`](#getextendedbarcoderesults) | Returns the extended barcode results of the decoded barcode. | +| [`setLocation`](#setlocation) | Sets the location of the decoded barcode. | The following methods are inherited from [`RegionObjectElement`]({{ site.dcvb_android_api }}core/intermediate-results/region-object-element.html). @@ -81,7 +82,7 @@ byte[] getBytes(); **Return Value** -A [Byte](https://developer.android.com/reference/java/lang/Byte){:target="_blank"} object representing the raw bytes of the decoded barcode. +A byte array representing the raw bytes of the decoded barcode. ### setBytes @@ -136,7 +137,7 @@ A [`EnumBarcodeFormat`]({{site.dbr_android_api }}enum/barcode-format.html?lang=a Sets the format of the decoded barcode as a [`EnumBarcodeFormat`]({{site.dbr_android_api }}enum/barcode-format.html?lang=android) item. ```java -void setFormat(EnumBarcodeFormat format); +void setFormat(@EnumBarcodeFormat long format); ``` **Parameters** @@ -226,3 +227,19 @@ ExtendedBarcodeResult[] getExtendedBarcodeResults(); **Return Value** An array of [`ExtendedBarcodeResult`](auxiliary-ExtendedResult.md) that represents the extended barcode results. + +### setLocation + +Sets the location of the decoded barcode. + +```java +int setLocation(Quadrilateral location); +``` + +**Parameters** + +`location`: The location of the decoded barcode as a [`Quadrilateral`]({{ site.dcvb_android_api }}core/basic-structures/quadrilateral.html) object. + +**Return Value** + +Returns 0 if it succeeds. Otherwise, returns an error code. diff --git a/programming/android/api-reference/decoded-barcodes-result.md b/programming/android/api-reference/decoded-barcodes-result.md index 9a787c34..f4587994 100644 --- a/programming/android/api-reference/decoded-barcodes-result.md +++ b/programming/android/api-reference/decoded-barcodes-result.md @@ -27,6 +27,7 @@ class DecodedBarcodesResult extends CapturedResultBase | Method | Description | | ------ | ----------- | +| [`DecodedBarcodesResult`](#decodedbarcodesresult) | The constructor. | | [`getItems`](#getitems) | Returns an array of `BarcodeResultItem`, which is the basic unit of the captured results. | The following methods are inherited from [`CapturedResultBase`]({{ site.dcvb_android_api }}core/basic-structures/captured-result-base.html): @@ -39,6 +40,14 @@ The following methods are inherited from [`CapturedResultBase`]({{ site.dcvb_and | [`getErrorCode`]({{ site.dcvb_android_api }}core/basic-structures/captured-result-base.html#geterrorcode) | Gets the error code of this result. | | [`getErrorMessage`]({{ site.dcvb_android_api }}core/basic-structures/captured-result-base.html#geterrormessage) | Gets the error message of this result. | +### DecodedBarcodesResult + +The constructor. + +```java +DecodedBarcodesResult(); +``` + ### getItems Returns an array of [`BarcodeResultItem`](barcode-result-item.md), which is the basic unit of the captured results. diff --git a/programming/android/api-reference/decoded-barcodes-unit.md b/programming/android/api-reference/decoded-barcodes-unit.md index 4d357842..c0470584 100644 --- a/programming/android/api-reference/decoded-barcodes-unit.md +++ b/programming/android/api-reference/decoded-barcodes-unit.md @@ -90,7 +90,7 @@ void removeAllDecodedBarcodes(); Set the [`DecodedBarcodeElement`](decoded-barcode-element.md) of the `DecodedBarcodesUnit`. ```java -int setDecodedBarcode(DecodedBarcodeElement decodedBarcode, Matrix matrixToOriginalImage); +int setDecodedBarcode(DecodedBarcodeElement element, Matrix matrixToOriginalImage); ``` **Parameters** diff --git a/programming/android/api-reference/deformation-resisted-barcode.md b/programming/android/api-reference/deformation-resisted-barcode.md index 5a4ea394..6eaccba0 100644 --- a/programming/android/api-reference/deformation-resisted-barcode.md +++ b/programming/android/api-reference/deformation-resisted-barcode.md @@ -23,7 +23,7 @@ permalink: /programming/android/api-reference/deformation-resisted-barcode.html class DeformationResistedBarcode ``` -## Attributes +## Attributes & Methods | Attribute | Description | | ------ | ----------- | @@ -31,6 +31,10 @@ class DeformationResistedBarcode | [`location`](#location) | The location of the deformation-resisted barcode. | | [`format`](#format) | The format of the deformation-resisted barcode. | +| Method | Description | +| ------ | ----------- | +| [`DeformationResistedBarcode`](#deformationresistedbarcode) | The constructor. | + ### imageData An [`ImageData`]({{ site.dcvb_android_api }}core/basic-structures/image-data.html) object representing the deformation-resisted barcode image. @@ -54,3 +58,11 @@ A [`EnumBarcodeFormat`]({{site.dbr_android_api }}enum/barcode-format.html?lang=a ```java long format; ``` + +### DeformationResistedBarcode + +The constructor. + +```java +DeformationResistedBarcode(ImageData imageData, @NonNull Quadrilateral location, @EnumBarcodeFormat long format); +``` diff --git a/programming/android/api-reference/localized-barcode-element.md b/programming/android/api-reference/localized-barcode-element.md index 1a09e141..25ff70a0 100644 --- a/programming/android/api-reference/localized-barcode-element.md +++ b/programming/android/api-reference/localized-barcode-element.md @@ -30,6 +30,7 @@ class LocalizedBarcodeElement extends RegionObjectElement | [`setPossibleFormats`](#setpossibleformats) | Sets the possible format of the localized barcode. | | [`getPossibleFormatsString`](#getpossibleformatsstring) | Returns the possible formats of the localized barcode as a string. | | [`getModuleSize`](#getmodulesize) | Returns the module size of the localized barcode. | +| [`setLocation`](#setlocation) | Sets the location of the localized barcode. | The following methods are inherited from class [`RegionObjectElement`]({{ site.dcvb_android_api }}core/intermediate-results/region-object-element.html). @@ -80,7 +81,7 @@ Returns the possible format(s) of the localized barcode. Set the possibleformat of the barcode. ```java -void setPossibleFormats(long possibleFormats); +void setPossibleFormats(@EnumBarcodeFormat long possibleFormats); ``` **Parameters** @@ -110,3 +111,19 @@ int getModuleSize(); **Return value** An integer representing the module size of the localized barcode. + +### setLocation + +Sets the location of the localized barcode. + +```java +int setLocation(Quadrilateral location) +``` + +**Parameters** + +`location`: The location of the localized barcode, represented as a [`Quadrilateral`]({{ site.dcvb_android_api }}core/basic-structures/quadrilateral.html). + +**Return value** + +Returns 0 if the location is set successfully, otherwise returns the error code. diff --git a/programming/android/api-reference/simplified-barcode-reader-settings.md b/programming/android/api-reference/simplified-barcode-reader-settings.md index 2c7a93bb..b9b140bf 100644 --- a/programming/android/api-reference/simplified-barcode-reader-settings.md +++ b/programming/android/api-reference/simplified-barcode-reader-settings.md @@ -48,6 +48,7 @@ class SimplifiedBarcodeReaderSettings Defines a combined value of [`EnumBarcodeFormat`]({{site.dbr_android_api }}enum/barcode-format.html?lang=android) to specify which barcode format(s) the library should target. ```java +@EnumBarcodeFormat long barcodeFormatIds; ``` @@ -56,6 +57,7 @@ long barcodeFormatIds; Sets the expected barcode count. You can set it to 0 if the barcode count is unknown. ```java +@IntRange(from = 0) int expectedBarcodesCount; ``` @@ -71,7 +73,8 @@ int expectedBarcodesCount; Defines the localization algorithm(s) used to localize barcodes. The array consists of one or more modes, with each [EnumLocalizationMode]({{site.dbr_android_api }}enum/localization-mode.html?lang=android) representing a different localization process. ```java -EnumLocalizationMode[] localizationModes; +@EnumLocalizationMode +int[] localizationModes; ``` **Remarks** @@ -83,7 +86,8 @@ If you would like to learn more about the localization modes and how they work, Sets the priority for which deblurring algorithms the library will employ when dealing with blurry images. This array consists of [`EnumDeblurMode`]({{site.dbr_android_api }}enum/deblur-mode.html?lang=android) items. ```java -EnumDeblurMode[] deblurModes; +@EnumDeblurMode +int[] deblurModes; ``` **Remarks** @@ -95,6 +99,7 @@ If you would like to learn more about the deblur modes and how they work, please Set the minimum barcode result confidence to filter out results that do not meet the required level of confidence/accuracy. The higher the value of this parameter, the more accurate the results will be. If the library is struggling to find a barcode, lowering the value of this parameter can help. ```java +@IntRange(from = 0, to = 100) int minResultConfidence; ``` @@ -131,7 +136,7 @@ int maxThreadsInOneTask; Sets which grayscale transformation mode(s) the library will employ when reading barcodes. This parameter controls the library's ability to read inverted barcodes. The array consists of [GrayscaleTransformationMode]({{site.dcvb_enumerations}}core/grayscale-transformation-mode.html?lang=android) items. ```java -EnumGrayscaleTransformationMode[] grayscaleTransformationModes; +int[] grayscaleTransformationModes; ``` **Remarks** @@ -143,7 +148,7 @@ To learn more about reading inverted barcodes, please view this article on [how Sets which grayscale enhancement mode(s) the library will use when reading barcodes. The array consists of [GrayscaleEnhancementModes]({{site.dcvb_enumerations}}core/grayscale-enhancement-mode.html?lang=objc,swift). ```java -EnumGrayscaleEnhancementMode[] grayscaleEnhancementModes; +int[] grayscaleEnhancementModes; ``` **Remarks** diff --git a/programming/android/release-notes/android-11.md b/programming/android/release-notes/android-11.md index ee1ff8e2..5c97b665 100644 --- a/programming/android/release-notes/android-11.md +++ b/programming/android/release-notes/android-11.md @@ -49,7 +49,7 @@ noTitleIndex: true - **Flexible Configuration**: Extensive parameter customization for specific use cases and comprehensive model configuration options. - **Enterprise Ready**: Battle-tested stability for production environments. -### Changed +### New - Added a new method, [`switchCapturingTemplate`]({{ site.dcvb_android_api }}capture-vision-router/multiple-file-processing.html#switchcapturingtemplate), which allows switching templates dynamically during the image processing workflow. - Added a new method, [`clearDLModelBuffers`]({{ site.dcvb_android_api }}capture-vision-router/settings.html#cleardlmodelbuffers), to release memory by clearing buffered deep learning models. diff --git a/programming/maui/api-reference/capture-vision-router-lite/captured-result-receiver.md b/programming/maui/api-reference/capture-vision-router-lite/captured-result-receiver.md deleted file mode 100644 index 0f0d3bbb..00000000 --- a/programming/maui/api-reference/capture-vision-router-lite/captured-result-receiver.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -layout: default-layout -title: CapturedResultReceiver Interface - Dynamsoft Capture Vision Router Lite MAUI -description: CapturedResultReceiver interface of DCV MAUI edition is designed as a standardized way for retrieving captured results. -keywords: decoded barcodes, parsed results, captured results, CRR, result receiver, output -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# CapturedResultReceiver - -The `CapturedResultReceiver` interface is designed as a standardized way for retrieving captured results in the Dynamsoft Capture Vision architecture. By implementing the `CapturedResultReceiver`, you will receive the callback of the various types of captured results, such as original image, decoded barcode, recognized text line, detected quad, normalized image, or parsed data. The `CapturedResultReceiver` can add a receiver for any type of captured result or for a specific type of captured result, based on the method that is implemented. - -## Definition - -*Namespace:* Dynamsoft.CaptureVisionRouter.Maui - -*Assembly:* Dynamsoft.CaptureVisionRouterLite.Maui - -```csharp -interface ICapturedResultReceiver -``` - -## Methods - -| Method | Description | -| ------ | ----------- | -| [`OnCapturedResultReceived`](#oncapturedresultreceived) | This callback method delivers a `CapturedResult`, which is an object containning all kinds of captured result items that are captured from the image. | -| [`OnDecodedBarcodesReceived`](#ondecodedbarcodesreceived) | This callback method delivers a `DecodedBarcodesResult`, which is an object containning all `CRIT_BARCODE` typed captured result items that are captured from the image. | - -### OnCapturedResultReceived - -This callback method delivers a `CapturedResult`, which is an object containning all kinds of captured result items that are captured from the image. The callback is triggered each time when an image finishes its processing. - -```csharp -void OnCapturedResultReceived(CapturedResult result); -``` - -**Parameters** - -`[in] result`: The captured result, an instance of [`CapturedResult`](captured-result.md). - -### OnDecodedBarcodesReceived - -This callback method delivers a `DecodedBarcodesResult`, which is an object containning all `CRIT_BARCODE` typed captured result items that are captured from the image. The callback is triggered each time when an image finishes its processing. - -```csharp -void OnDecodedBarcodesReceived(DecodedBarcodesResult result); -``` - -**Parameters** - -`[in] result`: The decoded barcode result, an instance of `DecodedBarcodesResult`. diff --git a/programming/maui/api-reference/capture-vision-router-lite/captured-result.md b/programming/maui/api-reference/capture-vision-router-lite/captured-result.md deleted file mode 100644 index 77f65cfa..00000000 --- a/programming/maui/api-reference/capture-vision-router-lite/captured-result.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -layout: default-layout -title: CapturedResult Class - Dynamsoft Capture Vision Router Lite MAUI -description: CapturedResult class of DCV MAUI edition represents the result of a capture operation on an image. -keywords: decoded barcode, parsed result, error code, output, captured result -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# CapturedResult - -The `CapturedResult` class represents the result of a capture operation on an image. Internally, `CapturedResult` stores an array that contains multiple items, each of which may be a barcode, text line, detected quad, normalized image, original image, parsed item, etc. - -> You might also looking for: -> -> - [DecodedBarcodesResult]({{ site.dbr_maui_api }}decoded-barcodes-result.html) - -## Definition - -*Namespace:* Dynamsoft.CaptureVisionRouter.Maui - -*Assembly:* Dynamsoft.CaptureVisionRouterLite.Maui - -```csharp -class CapturedResult -``` - -## Properties - -| Property | Description | -| --------- | ----------- | -| [`OriginalImageHashId`](#originalimagehashid) | The hash id of the original image. You can use this ID to get the original image via the `IntermediateResultManager` class. | -| [`RotationTransformMatrix`](#rotationtransformmatrix) | The rotation transformation matrix of the original image relative to the rotated image. | -| [`ErrorCode`](#errorcode) | The error code associated with the capture result. | -| [`ErrorMessage`](#errormessage) | The error message associated with the capture result. | -| [`DecodedBarcodesResult`](#decodedbarcodesresult) | An array of `BarcodeResultItem` objects, each representing a decoded barcode within the original image. | - -### OriginalImageHashId - -The hash id of the original image. You can use this ID to get the original image via the [`IntermediateResultManager`]({{ site.dcv_maui_api }}capture-vision-router/auxiliary-classes/intermediate-result-manager.html) class. - -```csharp -string OriginalImageHashId { get;} -``` - -### RotationTransformMatrix - -The rotation transformation matrix of the original image relative to the rotated image. - -```csharp -Matrix RotationTransformMatrix { get; } -``` - -### ErrorCode - -Error code associated with the capture result. - -```csharp -int ErrorCode { get; } -``` - -### ErrorMessage - -Error string providing details about the error. - -```csharp -string ErrorMessage { get; } -``` - -### DecodedBarcodesResult - -A [`DecodedBarcodesResult`]({{ site.dbr_maui_api }}decoded-barcodes-result.html) object that represents all decoded barcode within the original image. - -```csharp -DecodedBarcodesResult DecodedBarcodesResult { get; } -``` diff --git a/programming/maui/api-reference/capture-vision-router-lite/preset-template.md b/programming/maui/api-reference/capture-vision-router-lite/preset-template.md deleted file mode 100644 index f55a5175..00000000 --- a/programming/maui/api-reference/capture-vision-router-lite/preset-template.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default-layout -title: EnumPresetTemplate - Dynamsoft Capture Vision Router Lite MAUI -description: The enumeration PresetTemplate of Dynamsoft Vision Router describes the preset template. -keywords: CaptureVisionTemplate, PresetTemplate, single barcode template, speed first, read-rate first -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true -breadcrumbText: PresetTemplate ---- - -# EnumPresetTemplate - -`EnumPresetTemplate` class defines the preset tempate strings. These strings can be used when specifying template name with [`StartCapturing`](../multiple-file-processing.md#startcapturing) or [`Capture`](../single-file-processing.md#capture) methods. - -## Definition - -*Namespace:* Dynamsoft.CaptureVisionRouter.Maui - -*Assembly:* Dynamsoft.CaptureVisionRouterLite.Maui - -```csharp -public class EnumPresetTemplate -{ - public const string PT_DEFAULT = "Default"; - public const string PT_READ_BARCODES = "ReadBarcodes_Default"; - public const string PT_READ_BARCODES_SPEED_FIRST = "ReadBarcodes_SpeedFirst"; - public const string PT_READ_BARCODES_READ_RATE_FIRST = "ReadBarcodes_ReadRateFirst"; - public const string PT_READ_SINGLE_BARCODE = "ReadSingleBarcode"; -} -``` diff --git a/programming/maui/api-reference/capture-vision-router-lite/simplified-capture-vision-settings.md b/programming/maui/api-reference/capture-vision-router-lite/simplified-capture-vision-settings.md deleted file mode 100644 index 31bbf093..00000000 --- a/programming/maui/api-reference/capture-vision-router-lite/simplified-capture-vision-settings.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -layout: default-layout -title: SimplifiedCaptureVisionSettings Class - Dynamsoft Capture Vision Router Lite MAUI -description: SimplifiedCaptureVisionSettings class of DCV MAUI edition provides settings for capturing and recognizing images with the CaptureVisionRouter class. -keywords: roi, result item type, min interval, timeout -needGenerateH3Content: true -needAutoGenerateSidebar: true -noTitleIndex: true ---- - -# SimplifiedCaptureVisionSettings - -The `SimplifiedCaptureVisionSettings` class contains settings for capturing and recognizing images with the `CaptureVisionRouter` class. - -## Definition - -*Namespace:* Dynamsoft.CaptureVisionRouter.Maui - -*Assembly:* Dynamsoft.CaptureVisionRouterLite.Maui - -```csharp -class SimplifiedCaptureVisionSettings -``` - -## Properties - -| Property | Type | Description | -| ---------- | ---- | ----------- | -| [`CapturedResultItemTypes`](#capturedresultitemtypes) | *EnumCapturedResultItemType* | Specifies the type(s) of CapturedItem(s) that will be captured. | -| [`Roi`](#roi) | *[Quadrilateral]({{ site.dcv_maui_api }}core/quadrilateral.html)* | Specifies the region of interest (ROI) where the image capture and recognition will take place. | -| [`RoiMeasuredInPercentage`](#roimeasuredinpercentage) | *bool* | 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_maui_api }}simplified-barcode-reader-settings.html)* | Specifies the settings for `DynamsoftBarcodeReader` tasks. | - -### CapturedResultItemTypes - -Specifies the type(s) of CapturedItem(s) that will be captured. - -```csharp -EnumCapturedResultItemType CapturedResultItemTypes { get; set; } -``` - -### Roi - -Specifies the region of interest (ROI) where the image capture and recognition will take place. - -```csharp -Quadrilateral Roi { get; set; } -``` - -### RoiMeasuredInPercentage - -Specifies whether the ROI is measured in pixels or as a percentage of the image size. - -```csharp -bool RoiMeasuredInPercentage { get; set; } -``` - -### MaxParallelTasks - -Specifies the maximum number of parallel tasks that can be used for image capture and recognition. - -```csharp -int MaxParallelTasks { get; set; } -``` - -### MinImageCaptureInterval - -Set the minimum capture interval. It is measured in millisecond. - -```csharp -int MinImageCaptureInterval { get; set; } -``` - -### Timeout - -Specifies the maximum time (in milliseconds) allowed for image capture and recognition. - -```csharp -int Timeout { get; set; } -``` - -### BarcodeSettings - -Specifies the settings for `DynamsoftBarcodeReader` tasks with a [`SimplifiedBarcodeReaderSettings`]({{ site.dbr_maui_api }}simplified-barcode-reader-settings.html) object. - -```csharp -SimplifiedBarcodeReaderSettings BarcodeSettings { get; set; } -``` diff --git a/programming/objectivec-swift/api-reference/auxiliary-iAztecDetails.md b/programming/objectivec-swift/api-reference/auxiliary-iAztecDetails.md index 366e0a3f..674e3a2d 100644 --- a/programming/objectivec-swift/api-reference/auxiliary-iAztecDetails.md +++ b/programming/objectivec-swift/api-reference/auxiliary-iAztecDetails.md @@ -38,12 +38,6 @@ class AztecDetails : BarcodeDetails | [`columns`](#columns) | *NSInteger* | The number of columns in the Aztec barcode. | | [`layerNumber`](#layernumber) | *NSInteger* | Specifies the layer number of the Aztec barcode. A negative number (-1, -2, -3, -4) specifies a compact Aztec code. A positive number (1, 2, .. 32) specifies a normal (full-range) Aztec code. | -## Methods - -| Method | Description | -| ------ | ----------- | -| [`initWithAztecDetails`](#initwithaztecdetails) | Initializes a new instance of the DSAztecDetails class with the specified row count, column count, and layer number of the barcode. | - ### rows The number of rows of the Aztec barcode, indicating how many rows of modules it contains. @@ -94,30 +88,3 @@ Returns the layer number of the Aztec barcode. A negative number (-1, -2, -3, -4 ```swift var layerNumber: Int { get } ``` - -### initWithAztecDetails - -Initializes a new instance of the `DSAztecDetails` class with the specified row count, column count, and layer number of the Aztec barcode. - -
->- Objective-C ->- Swift -> ->1. -```objc -- (instancetype)initWithAztecDetails:(NSInteger)rows - columns:(NSInteger)columns - layerNumber:(NSInteger)layerNumber; -``` -2. -```swift -init(rows: Int, columns: Int, layerNumber: Int) -``` - -**Parameters** - -`rows`: The number of rows in the Aztec barcode. - -`columns`: The number of columns in the Aztec barcode. - -`layerNumber`: Specifies the layer number of the Aztec barcode. A negative number (-1, -2, -3, -4) specifies a compact Aztec code. A positive number (1, 2, .. 32) specifies a normal (full-range) Aztec code. diff --git a/programming/objectivec-swift/api-reference/auxiliary-iExtendedResult.md b/programming/objectivec-swift/api-reference/auxiliary-iExtendedResult.md index 7f83c977..15b251dd 100644 --- a/programming/objectivec-swift/api-reference/auxiliary-iExtendedResult.md +++ b/programming/objectivec-swift/api-reference/auxiliary-iExtendedResult.md @@ -80,11 +80,11 @@ Returns the type of the extended barcode result as a [`DSExtendedBarcodeResultTy > >1. ```objc -@property(nonatomic, assign, readonly) DSExtendedBarcodeResultType extendedBarcodeResultType; +- (DSExtendedBarcodeResultType)getExtendedBarcodeResultType; ``` 2. ```swift -var extendedBarcodeResultType: ExtendedBarcodeResultType { get } +func getExtendedBarcodeResultType() -> DSExtendedBarcodeResultType ``` **Return Value** @@ -101,11 +101,11 @@ Returns the degree of deformation or distortion of the decoded barcode. > >1. ```objc -@property(nonatomic, assign, readonly) NSInteger deformation; +- (NSInteger)getDeformation; ``` 2. ```swift -var deformation: Int { get } +func getDeformation() -> Int ``` **Return Value** @@ -122,11 +122,11 @@ Returns the clarity/quality level of the decoded barcode. > >1. ```objc -@property(nonatomic, assign, readonly) NSInteger clarity; +- (NSInteger)getClarity; ``` 2. ```swift -var clarity: Int { get } +func getClarity() -> Int ``` **Return Value** @@ -143,11 +143,11 @@ Returns the sampling image of the decoded barcode as a [`DSImageData`]({{ site.d > >1. ```objc -@property(nonatomic, nullable, readonly) DSImageData *samplingImage; +- (nullable DSImageData *)getSamplingImage; ``` 2. ```swift -var samplingImage: ImageData? { get } +func getSamplingImage() -> DSImageData? ``` **Return Value** diff --git a/programming/objectivec-swift/api-reference/auxiliary-iOneDCodeDetails.md b/programming/objectivec-swift/api-reference/auxiliary-iOneDCodeDetails.md index fb623438..0fe07852 100644 --- a/programming/objectivec-swift/api-reference/auxiliary-iOneDCodeDetails.md +++ b/programming/objectivec-swift/api-reference/auxiliary-iOneDCodeDetails.md @@ -51,7 +51,7 @@ A [NSData](https://developer.apple.com/documentation/foundation/nsdata){:target= > >1. ```objc -@property(nonatomic, nullable, readonly) NSData *startCharsBytes; +@property(nonatomic, readonly, copy, nullable) NSData *startCharsBytes; ``` 2. ```swift @@ -69,7 +69,7 @@ A [NSData](https://developer.apple.com/documentation/foundation/nsdata){:target= > >1. ```objc -@property(nonatomic, nullable, readonly) NSData *stopCharsBytes; +@property(nonatomic, readonly, copy, nullable) NSData *stopCharsBytes; ``` 2. ```swift @@ -86,7 +86,7 @@ A [NSData](https://developer.apple.com/documentation/foundation/nsdata){:target= > >1. ```objc -@property(nonatomic, nullable, readonly) NSData *checkDigitBytes; +@property(nonatomic, readonly, copy, nullable) NSData *checkDigitBytes; ``` 2. ```swift diff --git a/programming/objectivec-swift/api-reference/auxiliary-iQRCodeDetails.md b/programming/objectivec-swift/api-reference/auxiliary-iQRCodeDetails.md index d1a2e324..63abf6aa 100644 --- a/programming/objectivec-swift/api-reference/auxiliary-iQRCodeDetails.md +++ b/programming/objectivec-swift/api-reference/auxiliary-iQRCodeDetails.md @@ -227,7 +227,7 @@ The codewords of the QR Code. > >1. ```objc -@property (nonatomic, readonly, retain) NSData *codewords; +@property (nonatomic, readonly, copy, nullable) NSData *codewords; ``` 2. ```swift diff --git a/programming/objectivec-swift/api-reference/barcode-result-item.md b/programming/objectivec-swift/api-reference/barcode-result-item.md index 66dce2e0..b468ef6e 100644 --- a/programming/objectivec-swift/api-reference/barcode-result-item.md +++ b/programming/objectivec-swift/api-reference/barcode-result-item.md @@ -65,7 +65,7 @@ The format of the barcode. This format will be one of the [`DSBarcodeFormat`]({{ > >1. ```objc -@property(nonatomic, readonly) DSBarcodeFormat format; +@property (nonatomic, readonly, assign) DSBarcodeFormat format; ``` 2. ```swift @@ -82,7 +82,7 @@ The format of the barcode, but as a string instead of a `DSBarcodeFormat` enumer > >1. ```objc -@property(nonatomic, nullable, readonly) NSString *formatString; +@property (nonatomic, readonly, copy) NSString *formatString; ``` 2. ```swift @@ -99,7 +99,7 @@ The raw decoded text of the barcode. > >1. ```objc -@property(nonatomic, nullable, readonly) NSString *text; +@property (nonatomic, readonly, copy) NSString *text; ``` 2. ```swift @@ -116,7 +116,7 @@ The raw bytes of the decoded barcode text which is useful when the text string c > >1. ```objc -@property(nonatomic, nullable, readonly) NSData *bytes; +@property (nonatomic, readonly, copy) NSData *bytes; ``` 2. ```swift @@ -133,7 +133,7 @@ The location of the barcode as a [`DSQuadrilateral`]({{ site.dcvb_ios_api }}core > >1. ```objc -@property(nonatomic, nullable, readonly) DSQuadrilateral *location; +@property (nonatomic, readonly) DSQuadrilateral *location; ``` 2. ```swift @@ -150,7 +150,7 @@ The confidence of the decoded result, which is a measure of the result's accurac > >1. ```objc -@property(nonatomic, readonly) NSInteger confidence; +@property (nonatomic, readonly, assign) NSUInteger confidence; ``` 2. ```swift @@ -167,7 +167,7 @@ If the barcode is captured at an angle or is rotated by any measure, this proper > >1. ```objc -@property(nonatomic, readonly) NSInteger angle; +@property (nonatomic, readonly, assign) NSInteger angle; ``` 2. ```swift @@ -184,7 +184,7 @@ The size of the individual modules or elements within the barcode. > >1. ```objc -@property(nonatomic, readonly) NSInteger moduleSize; +@property (nonatomic, readonly, assign) NSInteger moduleSize; ``` 2. ```swift @@ -218,7 +218,7 @@ Specifies if the decoded barcode is a Direct Part Marking (DPM) code or not. To > >1. ```objc -@property(nonatomic, readonly) BOOL isDPM; +@property (nonatomic, readonly, assign) BOOL isDPM; ``` 2. ```swift @@ -235,7 +235,7 @@ Specifies if the decoded barcode is mirrored or not. Mirrored barcodes are read > >1. ```objc -@property(nonatomic, readonly) BOOL isMirrored; +@property (nonatomic, readonly, assign) BOOL isMirrored; ``` 2. ```swift diff --git a/programming/objectivec-swift/api-reference/candidate-barcode-zone.md b/programming/objectivec-swift/api-reference/candidate-barcode-zone.md index fd832a12..95d7c7c9 100644 --- a/programming/objectivec-swift/api-reference/candidate-barcode-zone.md +++ b/programming/objectivec-swift/api-reference/candidate-barcode-zone.md @@ -46,7 +46,7 @@ The location of the candidate barcode zone within the image represented as a [`D > >1. ```objc -@property (nonatomic, copy) DSQuadrilateral * location; +@property (nonatomic, strong) DSQuadrilateral *location; ``` 2. ```swift diff --git a/programming/objectivec-swift/api-reference/candidate-barcode-zones-unit.md b/programming/objectivec-swift/api-reference/candidate-barcode-zones-unit.md index 9acdf82a..6d8a7d89 100644 --- a/programming/objectivec-swift/api-reference/candidate-barcode-zones-unit.md +++ b/programming/objectivec-swift/api-reference/candidate-barcode-zones-unit.md @@ -98,7 +98,7 @@ Returns the [`DSCandidateBarcodeZone`](candidate-barcode-zone.md) from the full > >1. ```objc --(DSCandidateBarcodeZone *)getCandidateBarcodeZone:(NSInteger)index; +-(nullable DSCandidateBarcodeZone *)getCandidateBarcodeZone:(NSInteger)index; ``` 2. ```swift @@ -166,7 +166,7 @@ Adds a [`CandidateBarcodeZone`](candidate-barcode-zone.md) to the candidate barc >1. ```objc -(NSInteger)addCandidateBarcodeZone:(DSCandidateBarcodeZone*)barcodeZone - matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImage; + matrixToOriginalImage:(CGAffineTransform)matrixToOriginalImage; ``` 2. ```swift diff --git a/programming/objectivec-swift/api-reference/decoded-barcode-element.md b/programming/objectivec-swift/api-reference/decoded-barcode-element.md index b6d76a66..4a6f2065 100644 --- a/programming/objectivec-swift/api-reference/decoded-barcode-element.md +++ b/programming/objectivec-swift/api-reference/decoded-barcode-element.md @@ -50,6 +50,7 @@ class DecodedBarcodeElement: RegionObjectElement | [`getExtendedBarcodeResults`](#getextendedbarcoderesults) | Returns the extended barcode results of the decoded barcode. | | [`isDPM`](#isdpm) | Specifies if the decoded barcode is a DPM code or not. | | [`isMirrored`](#ismirrored) | Specifies if the decoded barcode is mirrored or not. | +| [`setLocation`](#setlocation) | Sets the location of the decoded barcode. | The following attributes are inherited from class [`DSRegionObjectElement`]({{ site.dcvb_ios_api }}core/intermediate-results/region-object-element.html). @@ -103,11 +104,11 @@ Set the text of the decoded barcode. The barcode bytes are changed as well to re > >1. ```objc -- (NSInteger)setText:(NSString *)text +- (void)setText:(NSString *)text ``` 2. ```swift -func setText(text: String) -> NSInteger +func setText(text: String) ``` **Parameters** @@ -149,11 +150,11 @@ Set the raw bytes of the decoded barcode. The text of the barcode will change to > >1. ```objc -- (NSInteger)setBytes:(NSData *)bytes +- (void)setBytes:(NSData *)bytes ``` 2. ```swift -func setBytes(bytes: NSData) -> NSInteger +func setBytes(bytes: NSData) ``` **Parameters** @@ -195,11 +196,11 @@ Set the format of the decoded barcode using a [`DSBarcodeFormat`]({{site.dcvb_en > >1. ```objc -- (NSInteger)setFormat:(DSBarcodeFormat)format +- (void)setFormat:(DSBarcodeFormat)format ``` 2. ```swift -func setFormat(_ format: BarcodeFormat) -> NSInteger +func setFormat(_ format: BarcodeFormat) ``` **Parameters** @@ -241,11 +242,11 @@ Set the confidence score of the decoded barcode. > >1. ```objc -- (NSInteger)setConfidence:(NSInteger)confidence +- (void)setConfidence:(NSInteger)confidence ``` 2. ```swift -func setConfidence(_ confidence: NSInteger) -> NSInteger +func setConfidence(_ confidence: NSInteger) ``` **Parameters** @@ -402,3 +403,28 @@ func isMirrored() -> Bool **Return Value** A `BOOL` value describing whether the barcode is mirrored or not. + +### setLocation + +Sets the location of the decoded barcode. + +
+>- Objective-C +>- Swift +> +>1. +```objc +- (NSInteger)setLocation:(DSQuadrilateral *)location; +``` +2. +```swift +func setLocation(_ location: DSQuadrilateral) +``` + +**Parameters** + +`[in] location`: The location of the decoded barcode as a [`DSQuadrilateral`]({{ site.dcvb_ios_api }}core/basic-structures/quadrilateral.html) object. + +**Return Value** + +Returns 0 if the location is set successfully, otherwise returns the error code. diff --git a/programming/objectivec-swift/api-reference/decoded-barcodes-result.md b/programming/objectivec-swift/api-reference/decoded-barcodes-result.md index 202f98f4..dcc6c8f1 100644 --- a/programming/objectivec-swift/api-reference/decoded-barcodes-result.md +++ b/programming/objectivec-swift/api-reference/decoded-barcodes-result.md @@ -56,7 +56,7 @@ An array of [`DSBarcodeResultItem`](barcode-result-item.md), which is the basic > >1. ```objc -@property(nonatomic, nullable, readonly) NSArray *items; +@property (nonatomic, readonly, copy, nullable) NSArray *items; ``` 2. ```swift diff --git a/programming/objectivec-swift/api-reference/deformation-resisted-barcode-image-unit.md b/programming/objectivec-swift/api-reference/deformation-resisted-barcode-image-unit.md index 3fedc593..6df12b45 100644 --- a/programming/objectivec-swift/api-reference/deformation-resisted-barcode-image-unit.md +++ b/programming/objectivec-swift/api-reference/deformation-resisted-barcode-image-unit.md @@ -51,7 +51,7 @@ Returns the deformation-resisted barcode as a [`DSDeformationResistedBarcode`](d > >1. ```objc --(DSDeformationResistedBarcode *)getDeformationResistedBarcode +-(DSDeformationResistedBarcode *)getDeformationResistedBarcode; ``` 2. ```swift diff --git a/programming/objectivec-swift/api-reference/deformation-resisted-barcode.md b/programming/objectivec-swift/api-reference/deformation-resisted-barcode.md index f8165d1c..5ebe2e2a 100644 --- a/programming/objectivec-swift/api-reference/deformation-resisted-barcode.md +++ b/programming/objectivec-swift/api-reference/deformation-resisted-barcode.md @@ -65,7 +65,7 @@ The location of the deformation-resisted barcode within the image represented as > >1. ```objc -@property (nonatomic, copy) DSQuadrilateral * location; +@property (nonatomic, strong) DSQuadrilateral * location; ``` 2. ```swift diff --git a/programming/objectivec-swift/api-reference/localized-barcode-element.md b/programming/objectivec-swift/api-reference/localized-barcode-element.md index 61c03d82..0c6cfa3f 100644 --- a/programming/objectivec-swift/api-reference/localized-barcode-element.md +++ b/programming/objectivec-swift/api-reference/localized-barcode-element.md @@ -31,13 +31,14 @@ class LocalizedBarcodeElement : RegionObjectElement | Methods | Description | | ------- | ----------- | -| [`init`](#init) | Create a new `DSLocalizedBarcodeElement` object. | +| [`init`](#init) | Creates a new `DSLocalizedBarcodeElement` object. | | [`getAngle`](#getangle) | Returns the orientation angle of the localized barcode. | | [`getConfidence`](#getconfidence) | Returns the confidence score of the localized barcode. | | [`getPossibleFormats`](#getpossibleformats) | Returns the possible formats of the localized barcode. | -| [`setPossibleFormats`](#setpossibleformats) | Set the possible formats of the localized barcode. | +| [`setPossibleFormats`](#setpossibleformats) | Sets the possible formats of the localized barcode. | | [`getPossibleFormatsString`](#getpossibleformatsstring) | Returns the possible formats of the localized barcode as a string. | | [`getModuleSize`](#getmodulesize) | Returns the module size of the localized barcode. | +| [`setLocation`](#setlocation) | Sets the location of the localized barcode. | The following attributes are inherited from class [`DSRegionObjectElement`]({{ site.dcvb_ios_api }}core/intermediate-results/region-object-element.html). @@ -190,3 +191,28 @@ func getModuleSize() -> NSInteger **Return Value** An integer representing the module size of the localized barcode. + +### setLocation + +Sets the location of the localized barcode. + +
+>- Objective-C +>- Swift +> +>1. +```objc +- (NSInteger)setLocation:(DSQuadrilateral *)location; +``` +2. +```swift +func setLocation(_ location: DSQuadrilateral) +``` + +**Parameters** + +`location`: The location of the localized barcode as a [`DSQuadrilateral`]({{ site.dcvb_ios_api }}core/basic-structures/quadrilateral.html) object. + +**Return Value** + +Returns 0 if the location is set successfully, otherwise returns the error code. diff --git a/programming/objectivec-swift/api-reference/localized-barcodes-unit.md b/programming/objectivec-swift/api-reference/localized-barcodes-unit.md index 95d4e32f..362c1f4e 100644 --- a/programming/objectivec-swift/api-reference/localized-barcodes-unit.md +++ b/programming/objectivec-swift/api-reference/localized-barcodes-unit.md @@ -98,7 +98,7 @@ Returns the [`LocalizedBarcodeElement`](localized-barcode-element.md) at the spe > >1. ```objc -- (DSLocalizedBarcodeElement *)getLocalizedBarcode:(NSInteger)index +- (nullable DSLocalizedBarcodeElement *)getLocalizedBarcode:(NSInteger)index ``` 2. ```swift @@ -140,11 +140,11 @@ Removes the [`LocalizedBarcodeElement`](localized-barcode-element.md) at the spe > >1. ```objc -- (void)removeLocalizedBarcode:(NSInteger)index +- (NSInteger)removeLocalizedBarcode:(NSInteger)index ``` 2. ```swift -func removeLocalizedBarcode(_ index: Int) +func removeLocalizedBarcode(_ index: Int) -> Int ``` **Parameters** diff --git a/programming/objectivec-swift/api-reference/simplified-barcode-reader-settings.md b/programming/objectivec-swift/api-reference/simplified-barcode-reader-settings.md index 77b6471c..941f5a25 100644 --- a/programming/objectivec-swift/api-reference/simplified-barcode-reader-settings.md +++ b/programming/objectivec-swift/api-reference/simplified-barcode-reader-settings.md @@ -194,7 +194,7 @@ Set the maximum available threads for a single task. > >1. ```objc -@property(nonatomic, assign) NSInteger maxThreadsInOneTask; +@property(nonatomic, assign) NSUInteger maxThreadsInOneTask; ``` 2. ```swift diff --git a/programming/objectivec-swift/release-notes/ios-11.md b/programming/objectivec-swift/release-notes/ios-11.md index e8efd4af..2523f4e8 100644 --- a/programming/objectivec-swift/release-notes/ios-11.md +++ b/programming/objectivec-swift/release-notes/ios-11.md @@ -49,7 +49,7 @@ noTitleIndex: true - **Flexible Configuration**: Extensive parameter customization for specific use cases and comprehensive model configuration options. - **Enterprise Ready**: Battle-tested stability for production environments. -### Changed +### New - Added a new method, [`switchCapturingTemplate`]({{ site.dcvb_ios_api }}capture-vision-router/multiple-file-processing.html#switchcapturingtemplate), which allows switching templates dynamically during the image processing workflow. - Added a new method, [`clearDLModelBuffers`]({{ site.dcvb_ios_api }}capture-vision-router/settings.html#cleardlmodelbuffers), to release memory by clearing buffered deep learning models.