From f9fd0c21a396772f8bb803fa7b751bc6b48897bf Mon Sep 17 00:00:00 2001 From: DMGithubPublisher Date: Thu, 15 May 2025 16:09:00 +0800 Subject: [PATCH 1/2] update to internal commit 246a90f7 --- _config.yml | 2 + .../character-result-v2.6.1003.md | 93 ++++++ .../android/api-reference/character-result.md | 75 ++++- .../api-reference/raw-text-line-v2.6.1003.md | 191 +++++++++++ .../android/api-reference/raw-text-line.md | 17 + .../recognized-text-lines-result-v2.6.1003.md | 108 +++++++ .../recognized-text-lines-result.md | 73 +---- .../character-result-v2.6.1004.md | 163 ++++++++++ .../api-reference/character-result.md | 57 +++- .../api-reference/raw-text-line-v2.6.1004.md | 297 ++++++++++++++++++ .../api-reference/raw-text-line.md | 26 ++ .../recognized-text-lines-result-v2.6.1004.md | 145 +++++++++ .../recognized-text-lines-result.md | 100 +----- 13 files changed, 1184 insertions(+), 163 deletions(-) create mode 100644 programming/android/api-reference/character-result-v2.6.1003.md create mode 100644 programming/android/api-reference/raw-text-line-v2.6.1003.md create mode 100644 programming/android/api-reference/recognized-text-lines-result-v2.6.1003.md create mode 100644 programming/objectivec-swift/api-reference/character-result-v2.6.1004.md create mode 100644 programming/objectivec-swift/api-reference/raw-text-line-v2.6.1004.md create mode 100644 programming/objectivec-swift/api-reference/recognized-text-lines-result-v2.6.1004.md diff --git a/_config.yml b/_config.yml index 2fd8f79..f867820 100644 --- a/_config.yml +++ b/_config.yml @@ -3,6 +3,8 @@ repository: Dynamsoft-Docs/label-recognition-docs-mobile docFullPath: https://www.dynamsoft.com/label-recognition/docs/mobile/ firstLevelUrl: /label-recognition/docs/mobile/ docHomePage: /label-recognition/docs/mobile/introduction/ +needSearchIndex: true +searchNeedFilter: true enumerations: /label-recognition/docs/core/parameters/enum/ parameters-reference: /label-recognition/docs/core/parameters/reference/ diff --git a/programming/android/api-reference/character-result-v2.6.1003.md b/programming/android/api-reference/character-result-v2.6.1003.md new file mode 100644 index 0000000..c78e8ee --- /dev/null +++ b/programming/android/api-reference/character-result-v2.6.1003.md @@ -0,0 +1,93 @@ +--- +layout: default-layout +title: CharacterResult - Dynamsoft Label Recognizer Android Edition +description: The class CharacterResult of Dynamsoft Label Recognizer Android edition represents the result of a character recognition process. +keywords: Character result +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: CharacterResult +permalink: /programming/android/api-reference/character-result.html +--- + +# CharacterResult + +The `CharacterResult` class represents the result of a character recognition process. It contains the characters recognized (high, medium, and low confidence), their respective confidences, and the location of the character in a quadrilateral shape. + +## Definition + +*Namespace:* com.dynamsoft.dlr + +*Assembly:* DynamsoftLabelRecognizer.aar + +```java +class CharacterResult +``` + +## Methods + +| Method | Description | +| ------ | ----------- | +| [`getCharacterH`](#getcharacterh) | Returns the highest confidence character recognized. | +| [`getCharacterM`](#getcharacterm) | Returns the medium confidence character recognized. | +| [`getCharacterL`](#getcharacterl) | Returns the lowest confidence character recognized. | +| [`getLocation`](#getlocation) | Returns the location of the recognized character within the image. | +| [`getCharacterHConfidence`](#getcharacterhconfidence) | Returns the confidence score for the highest confidence character. | +| [`getCharacterMConfidence`](#getcharactermconfidence) | Returns the confidence score for the medium confidence character. | +| [`getCharacterLConfidence`](#getcharacterlconfidence) | Returns the confidence score for the lowest confidence character. | + +### getCharacterH + +Returns the highest confidence character recognized. + +```java +char getCharacterH(); +``` + +### getCharacterM + +Returns the medium confidence character recognized. + +```java +char getCharacterM(); +``` + +### getCharacterL + +Returns the lowest confidence character recognized. + +```java +char getCharacterL(); +``` + +### getLocation + +Returns the location of the recognized character within the image. + +```java +Quadrilateral getLocation(); +``` + +### getCharacterHConfidence + +Returns the confidence score for the highest confidence character. + +```java +int getCharacterHConfidence(); +``` + +### getCharacterMConfidence + +Returns the confidence score for the medium confidence character. + +```java +int characterMConfidence(); +``` + +### getCharacterLConfidence + +Returns the confidence score for the lowest confidence character. + +```java +int characterLConfidence(); +``` diff --git a/programming/android/api-reference/character-result.md b/programming/android/api-reference/character-result.md index c78e8ee..7cf6df6 100644 --- a/programming/android/api-reference/character-result.md +++ b/programming/android/api-reference/character-result.md @@ -28,13 +28,30 @@ class CharacterResult | Method | Description | | ------ | ----------- | +| [`CharacterResult`](#characterresult) | The constructor. | | [`getCharacterH`](#getcharacterh) | Returns the highest confidence character recognized. | +| [`setCharacterH`](#setcharacterh) | Sets the highest confidence character recognized. | | [`getCharacterM`](#getcharacterm) | Returns the medium confidence character recognized. | +| [`setCharacterM`](#setcharacterm) | Sets the medium confidence character recognized. | | [`getCharacterL`](#getcharacterl) | Returns the lowest confidence character recognized. | -| [`getLocation`](#getlocation) | Returns the location of the recognized character within the image. | +| [`setCharacterL`](#setcharacterl) | Sets the lowest confidence character recognized. | +| [`getLocation`](#getlocation) | Returns the location of the recognized character within the image. | +| [`setLocation`](#setlocation) | Sets the location of the recognized character within the image. | | [`getCharacterHConfidence`](#getcharacterhconfidence) | Returns the confidence score for the highest confidence character. | +| [`setCharacterHConfidence`](#setcharacterhconfidence) | Sets the confidence score for the highest confidence character. | | [`getCharacterMConfidence`](#getcharactermconfidence) | Returns the confidence score for the medium confidence character. | +| [`setCharacterMConfidence`](#setcharactermconfidence) | Sets the confidence score for the medium confidence character. | | [`getCharacterLConfidence`](#getcharacterlconfidence) | Returns the confidence score for the lowest confidence character. | +| [`setCharacterLConfidence`](#setcharacterlconfidence) | Sets the confidence score for the lowest confidence character. | + +### CharacterResult + +The constructor. + + +```java +CharacterResult(char characterH, char characterM, char characterL, int characterHConfidence, int characterMConfidence, int characterLConfidence, Quadrilateral location); +``` ### getCharacterH @@ -44,6 +61,14 @@ Returns the highest confidence character recognized. char getCharacterH(); ``` +### setCharacterH + +Sets the highest confidence character recognized. + +```java +setCharacterH(char characterH); +``` + ### getCharacterM Returns the medium confidence character recognized. @@ -52,6 +77,14 @@ Returns the medium confidence character recognized. char getCharacterM(); ``` +### setCharacterM + +Sets the medium confidence character recognized. + +```java +setCharacterM(char characterM); +``` + ### getCharacterL Returns the lowest confidence character recognized. @@ -60,6 +93,14 @@ Returns the lowest confidence character recognized. char getCharacterL(); ``` +### setCharacterL + +Sets the lowest confidence character recognized. + +```java +setCharacterL(char characterL); +``` + ### getLocation Returns the location of the recognized character within the image. @@ -68,6 +109,14 @@ Returns the location of the recognized character within the image. Quadrilateral getLocation(); ``` +### setLocation + +Sets the location of the recognized character within the image. + +```java +setLocation(Quadrilateral location); +``` + ### getCharacterHConfidence Returns the confidence score for the highest confidence character. @@ -76,6 +125,14 @@ Returns the confidence score for the highest confidence character. int getCharacterHConfidence(); ``` +### setCharacterHConfidence + +Sets the confidence score for the highest confidence character. + +```java +setCharacterHConfidence(int characterHConfidence); +``` + ### getCharacterMConfidence Returns the confidence score for the medium confidence character. @@ -84,6 +141,14 @@ Returns the confidence score for the medium confidence character. int characterMConfidence(); ``` +### setCharacterMConfidence + +Sets the confidence score for the medium confidence character. + +```java +setCharacterMConfidence(int characterMConfidence); +``` + ### getCharacterLConfidence Returns the confidence score for the lowest confidence character. @@ -91,3 +156,11 @@ Returns the confidence score for the lowest confidence character. ```java int characterLConfidence(); ``` + +### setCharacterLConfidence + +Sets the confidence score for the lowest confidence character. + +```java +setCharacterLConfidence(int characterLConfidence); +``` diff --git a/programming/android/api-reference/raw-text-line-v2.6.1003.md b/programming/android/api-reference/raw-text-line-v2.6.1003.md new file mode 100644 index 0000000..566f539 --- /dev/null +++ b/programming/android/api-reference/raw-text-line-v2.6.1003.md @@ -0,0 +1,191 @@ +--- +layout: default-layout +title: RawTextLine - Dynamsoft Label Recognizer iOS Edition +description: The class RawTextLine of Dynamsoft Label Recognizer iOS edition represents a unit which holds the raw text lines. +keywords: raw text lines unit, intermediate result unit +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: RawTextLine +--- + +# RawTextLine + +The `RawTextLine` class represents a text line in an image. It can be in one of the following states: + +- `TLS_LOCALIZED`: Localized but recognition not performed. +- `TLS_RECOGNITION_FAILED`: Recognition failed. +- `TLS_RECOGNIZED_SUCCESSFULLY`: Successfully recognized. + +## Definition + +*Namespace:* com.dynamsoft.dlr + +*Assembly:* DynamsoftLabelRecognizer.aar + +```java +class RawTextLine +``` + +## Methods + +| Methods | Description | +| ------- | ----------- | +| [`getText`](#gettext) | Returns the recognized text. | +| [`setText`](#settext) | Sets the recognized text. | +| [`getConfidence`](#getconfidence) | Returns the confidence level of the recognized text. | +| [`getCharacterResults`](#getcharacterresults) | Returns all the characters contained by the textline. | +| [`getRowNumber`](#getrownumber) | Returns the row number of the text line within the image. | +| [`setRowNumber`](#setrownumber) | Sets the row number of the text line within the image. | +| [`getSpecificationName`](#getspecificationname) | Get the name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. | +| [`setSpecificationName`](#setspecificationname) | Sets the name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. | +| [`getLocation`](#getlocation) | Returns the location of the text line. | +| [`setLocation`](#setlocation) | Sets the location of the text line. | + +### getText + +Returns the recognized text. + +```java +String getText(); +``` + +**Return value** + +Returns the text of the text line. + +### setText + +Returns the recognized text. + +```java +void setText(string text); +``` + +**Parameter** + +`text`: The text. + +**Return value** + +Returns the `ErrorCode` if failed. Otherwise, returns 0. + +### getConfidence + +Returns the confidence level of the recognized text. + +```java +int getConfidence(); +``` + +**Return value** + +Returns the confidence level of the text line. + +### getCharacterResults + +Returns all the characters contained by the textline in an array of [`CharacterResult`](character-result.md). + +```java +CharacterResult[] getCharacterResults(); +``` + +**Return value** + +Returns all the characters contained by the textline in an array of [`CharacterResult`](character-result.md). + +### getRowNumber + +Returns the row number of the text line within the image. + +```java +int getRowNumber(); +``` + +**Return value** + +Returns the row number of the text line within the image. + +### setRowNumber + +Sets the row number of the text line within the image. + +```java +int setRowNumber(int rowNumber); +``` + +**Parameter** + +`rowNumber`: The row number of the text line within the image. + +**Return value** + +Returns 0 if success, otherwise an error code. + +### getSpecificationName + +Returns the name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. + +```java +String getSpecificationName(); +``` + +**Return value** + +The name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. + +### setSpecificationName + +Sets the name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. + +```java +int setSpecificationName(String specificationName); +``` + +**Parameter** + +`specificationName`: The name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. + +**Return value** + +Returns 0 if success, otherwise an error code. + +### getLocation + +Returns a `Quadrilateral` object which represents the location of the text line. + +```java +Quadrilateral getLocation(); +``` + +**Return value** + +A `Quadrilateral` object which represents the location of the text line. + +### setLocation + +Set the location of the text line. + +```java +int setLocation(Quadrilateral location); +``` + +**Parameter** + +`location`: The location of the text line. + +**Return value** + +Returns 0 if success, otherwise an error code. + +### getStatus + +Returns the status of the text line. + +```java +RawTextLineStatus getStatus(); +``` + +**Return value** + +The status of the text line. diff --git a/programming/android/api-reference/raw-text-line.md b/programming/android/api-reference/raw-text-line.md index 566f539..481ea21 100644 --- a/programming/android/api-reference/raw-text-line.md +++ b/programming/android/api-reference/raw-text-line.md @@ -35,6 +35,7 @@ class RawTextLine | [`setText`](#settext) | Sets the recognized text. | | [`getConfidence`](#getconfidence) | Returns the confidence level of the recognized text. | | [`getCharacterResults`](#getcharacterresults) | Returns all the characters contained by the textline. | +| [`setCharacterResults`](#getcharacterresults) | Sets the character results. | | [`getRowNumber`](#getrownumber) | Returns the row number of the text line within the image. | | [`setRowNumber`](#setrownumber) | Sets the row number of the text line within the image. | | [`getSpecificationName`](#getspecificationname) | Get the name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. | @@ -94,6 +95,22 @@ CharacterResult[] getCharacterResults(); Returns all the characters contained by the textline in an array of [`CharacterResult`](character-result.md). +### setCharacterResults + +Sets the character results. + +```java +int setCharacterResults(CharacterResult[] characterResults); +``` + +**Parameter** + +`characterResults`: An array of [`CharacterResult`](character-result.md). + +**Return value** + +Returns 0 if success, otherwise an error code. + ### getRowNumber Returns the row number of the text line within the image. diff --git a/programming/android/api-reference/recognized-text-lines-result-v2.6.1003.md b/programming/android/api-reference/recognized-text-lines-result-v2.6.1003.md new file mode 100644 index 0000000..2877ff7 --- /dev/null +++ b/programming/android/api-reference/recognized-text-lines-result-v2.6.1003.md @@ -0,0 +1,108 @@ +--- +layout: default-layout +title: RecognizedTextLinesResult - Dynamsoft Label Recognizer Android Edition +description: The class RecognizedTextLinesResult of Dynamsoft Label Recognizer Android edition represents the result of a text recognition process. +keywords: Recognized text lines result +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: RecognizedTextLinesResult +permalink: /programming/android/api-reference/recognized-text-lines-result.html +--- + +# RecognizedTextLinesResult + +The `RecognizedTextLinesResult` class represents the overall result(s) of a text recognition process. It provides access to information about the recognized text lines, the original image, and any errors that occurred during the recognition process. + +## Definition + +*Namespace:* com.dynamsoft.dlr + +*Assembly:* DynamsoftLabelRecognizer.aar + +```java +class RecognizedTextLinesResult +``` + +## Methods + +| Method | Description | +| ------ | ----------- | +| [`getOriginalImageHashId`](#getoriginalimagehashid) | Gets the hash ID of the original image. | +| [`getOriginalImageTag`](#getoriginalimagetag) | Gets the tag of the original image. | +| [`getItems`](#getitems) | Gets the text line result item at the specified index. | +| [`getRotationTransformMatrix`](#getrotationtransformmatrix) | Get the rotation transformation matrix of the original image relative to the rotated image.| +| [`getErrorCode`](#geterrorcode) | Gets the error code of the recognition result, if an error occurred. | +| [`getErrorMessage`](#geterrormessage) | Gets the error message of the recognition result, if an error occurred. | + +### getOriginalImageHashId + +Get the hash id of the original image. You can use this ID to get the original image via the [`IntermediateResultManager`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-manager.html) class. + +```java +String getOriginalImageHashId(); +``` + +**Return value** + +Returns the hash ID of the original image as a string. + +### getOriginalImageTag + +Get the [`ImageTag`]({{ site.dcv_android_api }}core/basic-structures/image-tag.html) of the original image. The image tag contains info about the image such as the image ID and the image capture distance mode. + +```java +ImageTag getOriginalImageTag(); +``` + +**Return value** + +An [`ImageTag`]({{ site.dcv_android_api }}core/basic-structures/image-tag.html) object that contain the image extra info. + +### getItems + +Gets all the text line result(s) recognized from the image/frame in an array of [`DSTextLineResultItem`](text-line-result-item.md). + +```java +TextLineResultItem[] getItems(); +``` + +**Return value** + +Returns an array of `TextLineResultItem` that contains all text line recognition results. + +### getRotationTransformMatrix + +Get the rotation transformation matrix of the original image relative to the rotated image. + +```java +Matrix getRotationTransformMatrix(); +``` + +**Return Value** + +A `Matrix` which represents the rotation transform matrix. + +### getErrorCode + +Gets the error code of the recognition result, if an error occurred. + +```java +int getErrorCode(); +``` + +**Return value** + +Returns the error code of the recognition result, or 0 if no error occurred. + +### getErrorMessage + +Gets the error message of the recognition result, if an error occurred. + +```java +String getErrorMessage(); +``` + +**Return value** + +Returns a string that describes the error message. diff --git a/programming/android/api-reference/recognized-text-lines-result.md b/programming/android/api-reference/recognized-text-lines-result.md index 2877ff7..53f8084 100644 --- a/programming/android/api-reference/recognized-text-lines-result.md +++ b/programming/android/api-reference/recognized-text-lines-result.md @@ -21,43 +21,24 @@ The `RecognizedTextLinesResult` class represents the overall result(s) of a text *Assembly:* DynamsoftLabelRecognizer.aar ```java -class RecognizedTextLinesResult +class RecognizedTextLinesResult extends CapturedResultBase ``` ## Methods | Method | Description | | ------ | ----------- | -| [`getOriginalImageHashId`](#getoriginalimagehashid) | Gets the hash ID of the original image. | -| [`getOriginalImageTag`](#getoriginalimagetag) | Gets the tag of the original image. | | [`getItems`](#getitems) | Gets the text line result item at the specified index. | -| [`getRotationTransformMatrix`](#getrotationtransformmatrix) | Get the rotation transformation matrix of the original image relative to the rotated image.| -| [`getErrorCode`](#geterrorcode) | Gets the error code of the recognition result, if an error occurred. | -| [`getErrorMessage`](#geterrormessage) | Gets the error message of the recognition result, if an error occurred. | -### getOriginalImageHashId +The following methods are inherited from [`CapturedResultBase`]({{ site.dcv_android_api }}core/basic-structures/captured-result-base.html): -Get the hash id of the original image. You can use this ID to get the original image via the [`IntermediateResultManager`]({{ site.dcv_android_api }}core/intermediate-results/intermediate-result-manager.html) class. - -```java -String getOriginalImageHashId(); -``` - -**Return value** - -Returns the hash ID of the original image as a string. - -### getOriginalImageTag - -Get the [`ImageTag`]({{ site.dcv_android_api }}core/basic-structures/image-tag.html) of the original image. The image tag contains info about the image such as the image ID and the image capture distance mode. - -```java -ImageTag getOriginalImageTag(); -``` - -**Return value** - -An [`ImageTag`]({{ site.dcv_android_api }}core/basic-structures/image-tag.html) object that contain the image extra info. +| Method | Description | +| ------ | ----------- | +| [`getOriginalImageHashId`]({{ site.dcv_android_api }}core/basic-structures/captured-result-base.html#getoriginalimagehashid) | Gets the hash id of the original image. | +| [`getOriginalImageTag`]({{ site.dcv_android_api }}core/basic-structures/captured-result-base.html#getoriginalimagetag) | Gets the [ImageTag](image-tag.md) of the original image. | +| [`getRotationTransformMatrix`]({{ site.dcv_android_api }}core/basic-structures/captured-result-base.html#getrotationtransformmatrix) | Gets the rotation transformation matrix of the original image relative to the rotated image. | +| [`getErrorCode`]({{ site.dcv_android_api }}core/basic-structures/captured-result-base.html#geterrorcode) | Gets the error code of this result. | +| [`getErrorMessage`]({{ site.dcv_android_api }}core/basic-structures/captured-result-base.html#geterrormessage) | Gets the error message of this result. | ### getItems @@ -70,39 +51,3 @@ TextLineResultItem[] getItems(); **Return value** Returns an array of `TextLineResultItem` that contains all text line recognition results. - -### getRotationTransformMatrix - -Get the rotation transformation matrix of the original image relative to the rotated image. - -```java -Matrix getRotationTransformMatrix(); -``` - -**Return Value** - -A `Matrix` which represents the rotation transform matrix. - -### getErrorCode - -Gets the error code of the recognition result, if an error occurred. - -```java -int getErrorCode(); -``` - -**Return value** - -Returns the error code of the recognition result, or 0 if no error occurred. - -### getErrorMessage - -Gets the error message of the recognition result, if an error occurred. - -```java -String getErrorMessage(); -``` - -**Return value** - -Returns a string that describes the error message. diff --git a/programming/objectivec-swift/api-reference/character-result-v2.6.1004.md b/programming/objectivec-swift/api-reference/character-result-v2.6.1004.md new file mode 100644 index 0000000..968fd95 --- /dev/null +++ b/programming/objectivec-swift/api-reference/character-result-v2.6.1004.md @@ -0,0 +1,163 @@ +--- +layout: default-layout +title: DSCharacterResult - Dynamsoft Label Recognizer iOS Edition +description: The class DSCharacterResult of Dynamsoft Label Recognizer iOS edition represents the result of a character recognition process. +keywords: Character result +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: DSCharacterResult +permalink: /programming/objectivec-swift/api-reference/character-result.html +--- + +# DSCharacterResult + +The `DSCharacterResult` class represents the result of a character recognition process. It contains the characters recognized (high, medium, and low confidence), their respective confidences, and the location of the character in a quadrilateral shape. + +## Definition + +*Assembly:* DynamsoftLabelRecognizer.xcframework + +
+>- Objective-C +>- Swift +> +>1. +```objc +@interface DSCharacterResult : NSObject +``` +2. +```swift +class CharacterResult: NSObject +``` + +## Properties + +| Property | Type | Description | +| -------- | ---- | ----------- | +| [`characterH`](#characterh) | *unichar* | The character with high confidence. | +| [`characterM`](#characterm) | *unichar* | The character with medium confidence. | +| [`characterL`](#characterl) | *unichar* | The character with low confidence. | +| [`location`](#location) | *DSQuadrilateral \** | The location of the character in a quadrilateral shape. | +| [`characterHConfidence`](#characterhconfidence) | *NSInteger* | The confidence of the character with high confidence. | +| [`characterMConfidence`](#charactermconfidence) | *NSInteger* | The confidence of the character with medium confidence. | +| [`characterLConfidence`](#characterlconfidence) | *NSInteger* | The confidence of the character with low confidence. | + +### characterH + +The character with high confidence. + +
+>- Objective-C +>- Swift +> +>1. +```objc +@property (nonatomic, assign, readonly) unichar characterH; +``` +2. +```swift +var characterH: unichar { get } +``` + +### characterM + +The character with medium confidence. + +
+>- Objective-C +>- Swift +> +>1. +```objc +@property (nonatomic, assign, readonly) unichar characterM; +``` +2. +```swift +var characterM: unichar { get } +``` + +### characterL + +The character with low confidence. + +
+>- Objective-C +>- Swift +> +>1. +```objc +@property (nonatomic, assign, readonly) unichar characterL; +``` +2. +```swift +var characterL: unichar { get } +``` + +### location + +The location of the character in a quadrilateral shape. + +
+>- Objective-C +>- Swift +> +>1. +```objc +@property (nonatomic, nullable, readonly) DSQuadrilateral * location; +``` +2. +```swift +var location: Quadrilateral? { get } +``` + +### characterHConfidence + +The confidence of the character with high confidence. + +
+>- Objective-C +>- Swift +> +>1. +```objc +@property (nonatomic, assign, readonly) NSInteger characterHConfidence; +``` +2. +```swift +var characterHConfidence: Int { get } +``` + +### characterMConfidence + +The confidence of the character with medium confidence. + +
+>- Objective-C +>- Swift +> +>1. +```objc +@property (nonatomic, assign, readonly) NSInteger characterMConfidence; +``` +2. +```swift +var characterMConfidence: Int { get } +``` + +### characterLConfidence + +The confidence of the character with low confidence. + +
+>- Objective-C +>- Swift +> +>1. +```objc +@property (nonatomic, assign, readonly) NSInteger characterLConfidence; +``` +2. +```swift +var characterLConfidence: Int { get } +``` diff --git a/programming/objectivec-swift/api-reference/character-result.md b/programming/objectivec-swift/api-reference/character-result.md index 968fd95..f728fcb 100644 --- a/programming/objectivec-swift/api-reference/character-result.md +++ b/programming/objectivec-swift/api-reference/character-result.md @@ -31,7 +31,7 @@ The `DSCharacterResult` class represents the result of a character recognition p class CharacterResult: NSObject ``` -## Properties +## Properties & Methods | Property | Type | Description | | -------- | ---- | ----------- | @@ -43,6 +43,11 @@ class CharacterResult: NSObject | [`characterMConfidence`](#charactermconfidence) | *NSInteger* | The confidence of the character with medium confidence. | | [`characterLConfidence`](#characterlconfidence) | *NSInteger* | The confidence of the character with low confidence. | +| Methods | Description | +| ------- | ----------- | +| [`init`](#init) | Initializes a new instance of the `DSCharacterResult` class. | +| [`initWithCharacterH`](#initwithcharacterh) | Initializes a new instance of the `DSCharacterResult` class. | + ### characterH The character with high confidence. @@ -53,7 +58,7 @@ The character with high confidence. > >1. ```objc -@property (nonatomic, assign, readonly) unichar characterH; +@property (nonatomic, assign) unichar characterH; ``` 2. ```swift @@ -70,7 +75,7 @@ The character with medium confidence. > >1. ```objc -@property (nonatomic, assign, readonly) unichar characterM; +@property (nonatomic, assign) unichar characterM; ``` 2. ```swift @@ -87,7 +92,7 @@ The character with low confidence. > >1. ```objc -@property (nonatomic, assign, readonly) unichar characterL; +@property (nonatomic, assign) unichar characterL; ``` 2. ```swift @@ -104,7 +109,7 @@ The location of the character in a quadrilateral shape. > >1. ```objc -@property (nonatomic, nullable, readonly) DSQuadrilateral * location; +@property (nonatomic, nullable) DSQuadrilateral * location; ``` 2. ```swift @@ -121,7 +126,7 @@ The confidence of the character with high confidence. > >1. ```objc -@property (nonatomic, assign, readonly) NSInteger characterHConfidence; +@property (nonatomic, assign) NSInteger characterHConfidence; ``` 2. ```swift @@ -138,7 +143,7 @@ The confidence of the character with medium confidence. > >1. ```objc -@property (nonatomic, assign, readonly) NSInteger characterMConfidence; +@property (nonatomic, assign) NSInteger characterMConfidence; ``` 2. ```swift @@ -155,9 +160,45 @@ The confidence of the character with low confidence. > >1. ```objc -@property (nonatomic, assign, readonly) NSInteger characterLConfidence; +@property (nonatomic, assign) NSInteger characterLConfidence; ``` 2. ```swift var characterLConfidence: Int { get } ``` + +### init + +
+>- Objective-C +>- Swift +> +>1. +```objc +- (instancetype)init; +``` +2. +```swift +init() +``` + +### initWithCharacterH + +
+>- Objective-C +>- Swift +> +>1. +```objc +- (instancetype)initWithCharacterH:(unichar)characterH + characterM:(unichar)characterM + characterL:(unichar)characterL + characterHConfidence:(DSQuadrilateral *)characterHConfidence + characterMConfidence:(NSInteger)characterMConfidence + characterLConfidence:(NSInteger)characterLConfidence + location:(NSInteger)location; +``` +2. +```swift +init(characterH: unichar, characterM: unichar, characterL: unichar, characterHConfidence: Int, characterMConfidence: Int, characterLConfidence: Int, location: Int) +``` diff --git a/programming/objectivec-swift/api-reference/raw-text-line-v2.6.1004.md b/programming/objectivec-swift/api-reference/raw-text-line-v2.6.1004.md new file mode 100644 index 0000000..8f77044 --- /dev/null +++ b/programming/objectivec-swift/api-reference/raw-text-line-v2.6.1004.md @@ -0,0 +1,297 @@ +--- +layout: default-layout +title: DSRawTextLine - Dynamsoft Label Recognizer iOS Edition +description: The class DSRawTextLine of Dynamsoft Label Recognizer iOS edition represents a unit which holds the raw text lines. +keywords: raw text lines unit, intermediate result unit +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: DSRawTextLine +--- + +# DSRawTextLine + +The `DSRawTextLine` class represents a text line in an image. It can be in one of the following states: + +- `TLS_LOCALIZED`: Localized but recognition not performed. +- `TLS_RECOGNITION_FAILED`: Recognition failed. +- `TLS_RECOGNIZED_SUCCESSFULLY`: Successfully recognized. + +## Definition + +*Assembly:* DynamsoftLabelRecognizer.xcframework + +
+>- Objective-C +>- Swift +> +>1. +```objc +@interface DSRawTextLine: NSObject +``` +2. +```swift +class RawTextLine: NSObject +``` + +## Methods + +| Methods | Description | +| ------- | ----------- | +| [`getText`](#gettext) | Returns the recognized text. | +| [`setText`](#settext) | Sets the recognized text. | +| [`getConfidence`](#getconfidence) | Returns the confidence level of the recognized text. | +| [`getCharacterResults`](#getcharacterresults) | Returns all the characters contained by the textline. | +| [`getRowNumber`](#getrownumber) | Returns the row number of the text line within the image. | +| [`setRowNumber`](#setrownumber) | Sets the row number of the text line within the image. | +| [`getSpecificationName`](#getspecificationname) | Get the name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. | +| [`setSpecificationName`](#setspecificationname) | Sets the name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. | +| [`getLocation`](#getlocation) | Returns the location of the text line. | +| [`setLocation`](#setlocation) | Sets the location of the text line. | + +### getText + +Returns the recognized text. + +
+>- Objective-C +>- Swift +> +>1. +```objc +-(NSString*)getText; +``` +2. +```swift +func getText() -> String +``` + +**Return value** + +Returns the text of the text line. + +### setText + +Returns the recognized text. + +
+>- Objective-C +>- Swift +> +>1. +```objc +-(NSInteger)setText:(NSString *)text; +``` +2. +```swift +func setText(_ text: String) -> Int +``` + +**Parameter** + +`text`: The text. + +**Return value** + +Returns the `ErrorCode` if failed. Otherwise, returns 0. + +### getConfidence + +Returns the confidence level of the recognized text. + +
+>- Objective-C +>- Swift +> +>1. +```objc +-(NSInteger)getConfidence; +``` +2. +```swift +func getConfidence() -> Int +``` + +**Return value** + +Returns the confidence level of the text line. + +### getCharacterResults + +Returns all the characters contained by the textline in an array of [`DSCharacterResult`](character-result.md). + +
+>- Objective-C +>- Swift +> +>1. +```objc +-(nullable NSArray*)getCharacterResults; +``` +2. +```swift +func getCharacterResults() -> [CharacterResult] +``` + +**Return value** + +Returns all the characters contained by the textline in an array of [`DSCharacterResult`](character-result.md). + +### getRowNumber + +Returns the row number of the text line within the image. + +
+>- Objective-C +>- Swift +> +>1. +```objc +-(NSInteger)getRowNumber; +``` +2. +```swift +func getRowNumber() -> Int +``` + +**Return value** + +Returns the row number of the text line within the image. + +### setRowNumber + +Sets the row number of the text line within the image. + +
+>- Objective-C +>- Swift +> +>1. +```objc +-(NSInteger)setRowNumber:(NSInteger)rowNumber; +``` +2. +```swift +func setRowNumber(_ rowNumber: Int) -> Int +``` + +**Parameter** + +`rowNumber`: The row number of the text line within the image. + +**Return value** + +Returns 0 if success, otherwise an error code. + +### getSpecificationName + +Returns the name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. + +
+>- Objective-C +>- Swift +> +>1. +```objc +-(NSString *)getSpecificationName; +``` +2. +```swift +func getSpecificationName() -> String +``` + +**Return value** + +The name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. + +### setSpecificationName + +Sets the name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. + +
+>- Objective-C +>- Swift +> +>1. +```objc +-(NSInteger)setSpecificationName:(NSString *)specificationName; +``` +2. +```swift +func setSpecificationName(_ specificationName: String) -> Int +``` + +**Parameter** + +`specificationName`: The name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. + +**Return value** + +Returns 0 if success, otherwise an error code. + +### getLocation + +Returns a `Quadrilateral` object which represents the location of the text line. + +
+>- Objective-C +>- Swift +> +>1. +```objc +-(DSQuadrilateral *)getLocation; +``` +2. +```swift +func getLocation() -> Quadrilateral +``` + +**Return value** + +A `Quadrilateral` object which represents the location of the text line. + +### setLocation + +Set the location of the text line. + +
+>- Objective-C +>- Swift +> +>1. +```objc +-(NSInteger)setLocation:(DSQuadrilateral *)location; +``` +2. +```swift +func setLocation(_ location: Quadrilateral) -> Int +``` + +**Parameter** + +`location`: The location of the text line. + +**Return value** + +Returns 0 if success, otherwise an error code. + +### getStatus + +Returns the status of the text line. + +
+>- Objective-C +>- Swift +> +>1. +```objc +-(DSRawTextLineStatus)getStatus; +``` +2. +```swift +func getStatus() -> RawTextLineStatus +``` + +**Return value** + +The status of the text line. diff --git a/programming/objectivec-swift/api-reference/raw-text-line.md b/programming/objectivec-swift/api-reference/raw-text-line.md index 8f77044..10b24a4 100644 --- a/programming/objectivec-swift/api-reference/raw-text-line.md +++ b/programming/objectivec-swift/api-reference/raw-text-line.md @@ -42,6 +42,7 @@ class RawTextLine: NSObject | [`setText`](#settext) | Sets the recognized text. | | [`getConfidence`](#getconfidence) | Returns the confidence level of the recognized text. | | [`getCharacterResults`](#getcharacterresults) | Returns all the characters contained by the textline. | +| [`setCharacterResults`](#setcharacterresults) | Sets the characters results. | | [`getRowNumber`](#getrownumber) | Returns the row number of the text line within the image. | | [`setRowNumber`](#setrownumber) | Sets the row number of the text line within the image. | | [`getSpecificationName`](#getspecificationname) | Get the name of the [`TextLineSpecification`]({{site.dcv_parameter_reference}}text-line-specification/) object that generated this `TextLineResultItem`. | @@ -137,6 +138,31 @@ func getCharacterResults() -> [CharacterResult] Returns all the characters contained by the textline in an array of [`DSCharacterResult`](character-result.md). +### setCharacterResults + +Sets the characters results. + +
+>- Objective-C +>- Swift +> +>1. +```objc +-(NSInteger)setCharacterResults:(NSArray*)characterResults +``` +2. +```swift +func setCharacterResults(_ characterResults: [CharacterResult]) -> Int +``` + +**Parameters** + +`characterResults`: An array of [`DSCharacterResult`](character-result.md). + +**Return value** + +Returns 0 if success, otherwise an error code. + ### getRowNumber Returns the row number of the text line within the image. diff --git a/programming/objectivec-swift/api-reference/recognized-text-lines-result-v2.6.1004.md b/programming/objectivec-swift/api-reference/recognized-text-lines-result-v2.6.1004.md new file mode 100644 index 0000000..2917770 --- /dev/null +++ b/programming/objectivec-swift/api-reference/recognized-text-lines-result-v2.6.1004.md @@ -0,0 +1,145 @@ +--- +layout: default-layout +title: DSRecognizedTextLinesResult - Dynamsoft Label Recognizer iOS Edition +description: The class DSRecognizedTextLinesResult of Dynamsoft Label Recognizer iOS edition represents the result of a text recognition process. +keywords: Recognized text lines result +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: DSRecognizedTextLinesResult +permalink: /programming/objectivec-swift/api-reference/recognized-text-lines-result.html +--- + +# DSRecognizedTextLinesResult + +The `DSRecognizedTextLinesResult` class represents the overall result(s) of a text recognition process. It provides access to information about the recognized text lines, the original image, and any errors that occurred during the recognition process. + +## Definition + +*Assembly:* DynamsoftLabelRecognizer.xcframework + +
+>- Objective-C +>- Swift +> +>1. +```objc +@interface DSRecognizedTextLinesResult : NSObject +``` +2. +```swift +class RecognizedTextLinesResult: NSObject +``` + +## Properties + +| Property | Type | Description | +| -------- | ---- | ----------- | +| [`originalImageHashId`](#originalimagehashid) | *NSString \** | The hash ID of the original image. | +| [`originalImageTag`](#originalimagetag) | *DSImageTag \** | The tag of the original image stores in a [`DSImageTag`]({{ site.dcv_ios_api }}core/basic-structures/image-tag.html) object. | +| [`items`](#items) | *NSArray \** | All the text line result items that recognized from the image in an array of [`DSTextLineResultItem`](text-line-result-item.md). | +| [`rotationTransformMatrix`](#rotationtransformmatrix) | *CGAffineTransform* | The rotation transformation matrix of the original image relative to the rotated image.| +| [`errorCode`](#errorcode) | *NSInteger* | The error code of the recognition result, if an error occurred. | +| [`errorMessage`](#errormessage) | *NSString \** | The error message of the recognition result, if an error occurred. | + +### originalImageHashId + +The hash ID of the original image. + +
+>- Objective-C +>- Swift +> +>1. +```objc +@property (nonatomic, nullable, readonly) NSString* originalImageHashId; +``` +2. +```swift +var originalImageHashId: String? { get } +``` + +### originalImageTag + +The tag of the original image stores in a [`DSImageTag`]({{ site.dcv_ios_api }}core/basic-structures/image-tag.html) object. + +
+>- Objective-C +>- Swift +> +>1. +```objc +@property (nonatomic, nullable, readonly) DSImageTag* originalImageTag; +``` +2. +```swift +var originalImageTag: ImageTag? { get } +``` + +### items + +All the text line result items that recognized from the image in an array of [`DSTextLineResultItem`](text-line-result-item.md). + +
+>- Objective-C +>- Swift +> +>1. +```objc +@property (nonatomic, nullable, readonly) NSArray* items; +``` +2. +```swift +var items: [TextLineResultItem]? { get } +``` + +### rotationTransformMatrix + +Get the rotation transformation matrix of the original image relative to the rotated image. + +
+>- Objective-C +>- Swift +> +>1. +```objc +@property (nonatomic, nullable, assign, readonly) CGAffineTransform rotationTransformMatrix; +``` +2. +```swift +var rotationTransformMatrix: CGAffineTransform { get } +``` + +### errorCode + +Returns the error code of this result should something go wrong. + +
+>- Objective-C +>- Swift +> +>1. +```objc +@property (nonatomic, assign, readonly) NSInteger errorCode; +``` +2. +```swift +var errorCode: Int { get } +``` + +### errorMessage + +Returns the error message of this result should something go wrong. + +
+>- Objective-C +>- Swift +> +>1. +```objc +@property (nonatomic, assign, readonly) NSString * errorMessage; +``` +2. +```swift +var errorMessage: String { get } +``` diff --git a/programming/objectivec-swift/api-reference/recognized-text-lines-result.md b/programming/objectivec-swift/api-reference/recognized-text-lines-result.md index 2917770..7a57d4c 100644 --- a/programming/objectivec-swift/api-reference/recognized-text-lines-result.md +++ b/programming/objectivec-swift/api-reference/recognized-text-lines-result.md @@ -24,57 +24,28 @@ The `DSRecognizedTextLinesResult` class represents the overall result(s) of a te > >1. ```objc -@interface DSRecognizedTextLinesResult : NSObject +@interface DSRecognizedTextLinesResult : DSCapturedResultBase ``` 2. ```swift -class RecognizedTextLinesResult: NSObject +class RecognizedTextLinesResult: CapturedResultBase ``` ## Properties | Property | Type | Description | | -------- | ---- | ----------- | -| [`originalImageHashId`](#originalimagehashid) | *NSString \** | The hash ID of the original image. | -| [`originalImageTag`](#originalimagetag) | *DSImageTag \** | The tag of the original image stores in a [`DSImageTag`]({{ site.dcv_ios_api }}core/basic-structures/image-tag.html) object. | | [`items`](#items) | *NSArray \** | All the text line result items that recognized from the image in an array of [`DSTextLineResultItem`](text-line-result-item.md). | -| [`rotationTransformMatrix`](#rotationtransformmatrix) | *CGAffineTransform* | The rotation transformation matrix of the original image relative to the rotated image.| -| [`errorCode`](#errorcode) | *NSInteger* | The error code of the recognition result, if an error occurred. | -| [`errorMessage`](#errormessage) | *NSString \** | The error message of the recognition result, if an error occurred. | -### originalImageHashId +The following attributes are inherited from [`DSCapturedResultBase`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-base.html): -The hash ID of the original image. - -
->- Objective-C ->- Swift -> ->1. -```objc -@property (nonatomic, nullable, readonly) NSString* originalImageHashId; -``` -2. -```swift -var originalImageHashId: String? { get } -``` - -### originalImageTag - -The tag of the original image stores in a [`DSImageTag`]({{ site.dcv_ios_api }}core/basic-structures/image-tag.html) object. - -
->- Objective-C ->- Swift -> ->1. -```objc -@property (nonatomic, nullable, readonly) DSImageTag* originalImageTag; -``` -2. -```swift -var originalImageTag: ImageTag? { get } -``` +| Attributes | Type | Description | +| ---------- | ---- | ----------- | +| [`originalImageHashId`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-base.html#originalimagehashid) | *NSString \** | The hash id of the original image. | +| [`originalImageTag`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-base.html#originalimagetag) | *DSImageTag \** | The [DSImageTag](image-tag.md) of the original image. | +| [`rotationTransformMatrix`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-base.html#rotationtransformmatrix) | *CGAffineTransform* | The rotation transformation matrix of the original image relative to the rotated image. | +| [`errorCode`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-base.html#errorcode) | *NSInteger* | Get the error code of this result. | +| [`errorMessage`]({{ site.dcv_ios_api }}core/basic-structures/captured-result-base.html#errormessage) | *NSString \** | Get the error message of this result. | ### items @@ -92,54 +63,3 @@ All the text line result items that recognized from the image in an array of [`D ```swift var items: [TextLineResultItem]? { get } ``` - -### rotationTransformMatrix - -Get the rotation transformation matrix of the original image relative to the rotated image. - -
->- Objective-C ->- Swift -> ->1. -```objc -@property (nonatomic, nullable, assign, readonly) CGAffineTransform rotationTransformMatrix; -``` -2. -```swift -var rotationTransformMatrix: CGAffineTransform { get } -``` - -### errorCode - -Returns the error code of this result should something go wrong. - -
->- Objective-C ->- Swift -> ->1. -```objc -@property (nonatomic, assign, readonly) NSInteger errorCode; -``` -2. -```swift -var errorCode: Int { get } -``` - -### errorMessage - -Returns the error message of this result should something go wrong. - -
->- Objective-C ->- Swift -> ->1. -```objc -@property (nonatomic, assign, readonly) NSString * errorMessage; -``` -2. -```swift -var errorMessage: String { get } -``` From d363d34a4c9894264ab9ad48bdd197c255b312d8 Mon Sep 17 00:00:00 2001 From: DMGithubPublisher Date: Thu, 15 May 2025 17:12:13 +0800 Subject: [PATCH 2/2] update to internal commit f1646747 --- .../buffered-character-item-set.md | 2 +- .../api-reference/buffered-character-item.md | 2 +- .../api-reference/character-cluster.md | 2 +- .../character-result-v2.6.1003.md | 2 +- .../android/api-reference/character-result.md | 2 +- .../enum/raw-text-line-status.md | 28 ++++++++++++ .../api-reference/label-recognizer-module.md | 2 +- .../localized-text-line-element.md | 2 +- .../localized-text-lines-unit.md | 2 +- .../android/api-reference/raw-text-line.md | 2 +- .../api-reference/raw-text-lines-unit.md | 2 +- .../recognized-text-line-element-v2.2.3000.md | 2 +- .../recognized-text-line-element.md | 2 +- .../recognized-text-lines-result-v2.6.1003.md | 2 +- .../recognized-text-lines-result.md | 2 +- .../recognized-text-lines-unit.md | 2 +- .../simplified-label-recognizer-settings.md | 2 +- .../api-reference/text-line-result-item.md | 2 +- .../buffered-character-item-set.md | 2 +- .../api-reference/buffered-character-item.md | 2 +- .../api-reference/character-cluster.md | 2 +- .../api-reference/character-result.md | 2 +- .../enum/raw-text-line-status.md | 43 +++++++++++++++++++ .../api-reference/label-recognizer-module.md | 2 +- .../localized-text-line-element.md | 2 +- .../localized-text-lines-unit.md | 2 +- .../api-reference/raw-text-line.md | 2 +- .../api-reference/raw-text-lines-unit.md | 2 +- .../recognized-text-line-element.md | 2 +- .../recognized-text-lines-result.md | 2 +- .../recognized-text-lines-unit.md | 2 +- .../simplified-label-recognizer-settings.md | 2 +- .../api-reference/text-line-result-item.md | 2 +- 33 files changed, 102 insertions(+), 31 deletions(-) create mode 100644 programming/android/api-reference/enum/raw-text-line-status.md create mode 100644 programming/objectivec-swift/api-reference/enum/raw-text-line-status.md diff --git a/programming/android/api-reference/buffered-character-item-set.md b/programming/android/api-reference/buffered-character-item-set.md index 18306d5..5c7c755 100644 --- a/programming/android/api-reference/buffered-character-item-set.md +++ b/programming/android/api-reference/buffered-character-item-set.md @@ -17,7 +17,7 @@ The `BufferedCharacterItemSet` class represents the buffered characters and the *Namespace:* com.dynamsoft.dlr -*Assembly:* DynamsoftLabelRecognizer.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class BufferedCharacterItemSet diff --git a/programming/android/api-reference/buffered-character-item.md b/programming/android/api-reference/buffered-character-item.md index 3127efa..8baa231 100644 --- a/programming/android/api-reference/buffered-character-item.md +++ b/programming/android/api-reference/buffered-character-item.md @@ -17,7 +17,7 @@ The `BufferedCharacterItem` class represents a buffered character. *Namespace:* com.dynamsoft.dlr -*Assembly:* DynamsoftLabelRecognizer.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class BufferedCharacterItem diff --git a/programming/android/api-reference/character-cluster.md b/programming/android/api-reference/character-cluster.md index 72955a3..713e0d1 100644 --- a/programming/android/api-reference/character-cluster.md +++ b/programming/android/api-reference/character-cluster.md @@ -17,7 +17,7 @@ The `CharacterCluster` class represents the character clustering result. Each `C *Namespace:* com.dynamsoft.dlr -*Assembly:* DynamsoftLabelRecognizer.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class CharacterCluster diff --git a/programming/android/api-reference/character-result-v2.6.1003.md b/programming/android/api-reference/character-result-v2.6.1003.md index c78e8ee..bca8e3c 100644 --- a/programming/android/api-reference/character-result-v2.6.1003.md +++ b/programming/android/api-reference/character-result-v2.6.1003.md @@ -18,7 +18,7 @@ The `CharacterResult` class represents the result of a character recognition pro *Namespace:* com.dynamsoft.dlr -*Assembly:* DynamsoftLabelRecognizer.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class CharacterResult diff --git a/programming/android/api-reference/character-result.md b/programming/android/api-reference/character-result.md index 7cf6df6..f035f9c 100644 --- a/programming/android/api-reference/character-result.md +++ b/programming/android/api-reference/character-result.md @@ -18,7 +18,7 @@ The `CharacterResult` class represents the result of a character recognition pro *Namespace:* com.dynamsoft.dlr -*Assembly:* DynamsoftLabelRecognizer.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class CharacterResult diff --git a/programming/android/api-reference/enum/raw-text-line-status.md b/programming/android/api-reference/enum/raw-text-line-status.md new file mode 100644 index 0000000..b556a9d --- /dev/null +++ b/programming/android/api-reference/enum/raw-text-line-status.md @@ -0,0 +1,28 @@ +--- +layout: default-layout +title: RawTextLineStatus - Dynamsoft LabelRecognizer Enumerations +description: The enumeration RawTextLineStatus of Dynamsoft LabelRecognizer describes the final status of a raw text line. +keywords: Raw Text Line Status +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: RawTextLineStatus +codeAutoHeight: true +--- + +# Enumeration RawTextLineStatus + +`RawTextLineStatus` enumerates the final status of a raw text line. + +```java +@IntDef({}) +@Retention(RetentionPolicy.CLASS) +public @interface EnumRawTextLineStatus { + /** Localized but recognition not performed. */ + public static final int RTLS_LOCALIZED = 0; + /** Recognition failed. */ + public static final int RTLS_RECOGNITION_FAILED = 1; + /** Successfully recognized. */ + public static final int RTLS_RECOGNITION_SUCCEEDED = 2; +} EnumRawTextLineStatus; +``` diff --git a/programming/android/api-reference/label-recognizer-module.md b/programming/android/api-reference/label-recognizer-module.md index 9f1a4f5..ae0318b 100644 --- a/programming/android/api-reference/label-recognizer-module.md +++ b/programming/android/api-reference/label-recognizer-module.md @@ -17,7 +17,7 @@ The `LabelRecognizerModule` class defines general functions of the `DynamsoftLab *Namespace:* com.dynamsoft.dlr -*Assembly:* DynamsoftLabelRecognizer.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class LabelRecognizerModule diff --git a/programming/android/api-reference/localized-text-line-element.md b/programming/android/api-reference/localized-text-line-element.md index 7aa0570..c79eab9 100644 --- a/programming/android/api-reference/localized-text-line-element.md +++ b/programming/android/api-reference/localized-text-line-element.md @@ -18,7 +18,7 @@ The `LocalizedTextLineElement` class represents a localized text line element. I *Namespace:* com.dynamsoft.dlr.intermediate_results -*Assembly:* DynamsoftLabelRecognizer.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class LocalizedTextLineElement extends RegionObjectElement diff --git a/programming/android/api-reference/localized-text-lines-unit.md b/programming/android/api-reference/localized-text-lines-unit.md index cb50f35..7f8569a 100644 --- a/programming/android/api-reference/localized-text-lines-unit.md +++ b/programming/android/api-reference/localized-text-lines-unit.md @@ -18,7 +18,7 @@ The `LocalizedTextLinesUnit` class represents a unit that contains localized tex *Namespace:* com.dynamsoft.dlr.intermediate_results -*Assembly:* DynamsoftLabelRecognizer.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class LocalizedTextLinesUnit extends IntermediateResultUnit diff --git a/programming/android/api-reference/raw-text-line.md b/programming/android/api-reference/raw-text-line.md index 481ea21..8551172 100644 --- a/programming/android/api-reference/raw-text-line.md +++ b/programming/android/api-reference/raw-text-line.md @@ -21,7 +21,7 @@ The `RawTextLine` class represents a text line in an image. It can be in one of *Namespace:* com.dynamsoft.dlr -*Assembly:* DynamsoftLabelRecognizer.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class RawTextLine diff --git a/programming/android/api-reference/raw-text-lines-unit.md b/programming/android/api-reference/raw-text-lines-unit.md index 98782bc..4e056f0 100644 --- a/programming/android/api-reference/raw-text-lines-unit.md +++ b/programming/android/api-reference/raw-text-lines-unit.md @@ -19,7 +19,7 @@ The `RawTextLinesUnit` class represents a unit which holds the raw text lines. *Namespace:* com.dynamsoft.dlr -*Assembly:* DynamsoftLabelRecognizer.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class RawTextLine diff --git a/programming/android/api-reference/recognized-text-line-element-v2.2.3000.md b/programming/android/api-reference/recognized-text-line-element-v2.2.3000.md index 83d79d8..e34b5ee 100644 --- a/programming/android/api-reference/recognized-text-line-element-v2.2.3000.md +++ b/programming/android/api-reference/recognized-text-line-element-v2.2.3000.md @@ -17,7 +17,7 @@ The `RecognizedTextLineElement` class extends the [RegionObjectElement]({{ site. *Namespace:* com.dynamsoft.dlr.intermediate_results -*Assembly:* DynamsoftLabelRecognizer.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class RecognizedTextLineElement extends RegionObjectElement diff --git a/programming/android/api-reference/recognized-text-line-element.md b/programming/android/api-reference/recognized-text-line-element.md index cf41f3b..5f90694 100644 --- a/programming/android/api-reference/recognized-text-line-element.md +++ b/programming/android/api-reference/recognized-text-line-element.md @@ -18,7 +18,7 @@ The `RecognizedTextLineElement` class extends the [RegionObjectElement]({{ site. *Namespace:* com.dynamsoft.dlr.intermediate_results -*Assembly:* DynamsoftLabelRecognizer.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class RecognizedTextLineElement extends RegionObjectElement diff --git a/programming/android/api-reference/recognized-text-lines-result-v2.6.1003.md b/programming/android/api-reference/recognized-text-lines-result-v2.6.1003.md index 2877ff7..188fb84 100644 --- a/programming/android/api-reference/recognized-text-lines-result-v2.6.1003.md +++ b/programming/android/api-reference/recognized-text-lines-result-v2.6.1003.md @@ -18,7 +18,7 @@ The `RecognizedTextLinesResult` class represents the overall result(s) of a text *Namespace:* com.dynamsoft.dlr -*Assembly:* DynamsoftLabelRecognizer.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class RecognizedTextLinesResult diff --git a/programming/android/api-reference/recognized-text-lines-result.md b/programming/android/api-reference/recognized-text-lines-result.md index 53f8084..573a4cf 100644 --- a/programming/android/api-reference/recognized-text-lines-result.md +++ b/programming/android/api-reference/recognized-text-lines-result.md @@ -18,7 +18,7 @@ The `RecognizedTextLinesResult` class represents the overall result(s) of a text *Namespace:* com.dynamsoft.dlr -*Assembly:* DynamsoftLabelRecognizer.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class RecognizedTextLinesResult extends CapturedResultBase diff --git a/programming/android/api-reference/recognized-text-lines-unit.md b/programming/android/api-reference/recognized-text-lines-unit.md index 8db4bce..92fd72d 100644 --- a/programming/android/api-reference/recognized-text-lines-unit.md +++ b/programming/android/api-reference/recognized-text-lines-unit.md @@ -18,7 +18,7 @@ The `RecognizedTextLinesUnit` class represents an intermediate result unit conta *Namespace:* com.dynamsoft.dlr.intermediate_results -*Assembly:* DynamsoftLabelRecognizer.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class RecognizedTextLinesUnit extends IntermediateResultUnit diff --git a/programming/android/api-reference/simplified-label-recognizer-settings.md b/programming/android/api-reference/simplified-label-recognizer-settings.md index 59c4ae5..8e8e159 100644 --- a/programming/android/api-reference/simplified-label-recognizer-settings.md +++ b/programming/android/api-reference/simplified-label-recognizer-settings.md @@ -16,7 +16,7 @@ The `SimplifiedLabelRecognizerSettings` class contains settings for label recogn *Namespace:* com.dynamsoft.dlr -*Assembly:* DynamsoftLabelRecognizer.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class SimplifiedLabelRecognizerSettings diff --git a/programming/android/api-reference/text-line-result-item.md b/programming/android/api-reference/text-line-result-item.md index 061a2f5..69f5423 100644 --- a/programming/android/api-reference/text-line-result-item.md +++ b/programming/android/api-reference/text-line-result-item.md @@ -17,7 +17,7 @@ The `TextLineResultItem` class represents a single text line result item recogni *Namespace:* com.dynamsoft.dlr -*Assembly:* DynamsoftLabelRecognizer.aar +*Assembly:* DynamsoftCaptureVisionBundle.aar ```java class TextLineResultItem extends CapturedResultItem diff --git a/programming/objectivec-swift/api-reference/buffered-character-item-set.md b/programming/objectivec-swift/api-reference/buffered-character-item-set.md index 9cbc929..ece8e4b 100644 --- a/programming/objectivec-swift/api-reference/buffered-character-item-set.md +++ b/programming/objectivec-swift/api-reference/buffered-character-item-set.md @@ -15,7 +15,7 @@ The `DSBufferedCharacterItemSet` class represents the buffered characters and th ## Definition -*Assembly:* DynamsoftLabelRecognizer.xcframework +*Assembly:* DynamsoftCaptureVisionBundle.xcframework
>- Objective-C diff --git a/programming/objectivec-swift/api-reference/buffered-character-item.md b/programming/objectivec-swift/api-reference/buffered-character-item.md index 176397a..e2b0503 100644 --- a/programming/objectivec-swift/api-reference/buffered-character-item.md +++ b/programming/objectivec-swift/api-reference/buffered-character-item.md @@ -15,7 +15,7 @@ The `DSBufferedCharacterItem` class represents a buffered character. ## Definition -*Assembly:* DynamsoftLabelRecognizer.xcframework +*Assembly:* DynamsoftCaptureVisionBundle.xcframework
>- Objective-C diff --git a/programming/objectivec-swift/api-reference/character-cluster.md b/programming/objectivec-swift/api-reference/character-cluster.md index 264112c..b489ddd 100644 --- a/programming/objectivec-swift/api-reference/character-cluster.md +++ b/programming/objectivec-swift/api-reference/character-cluster.md @@ -15,7 +15,7 @@ The `DSCharacterCluster` class represents the character clustering result. Each ## Definition -*Assembly:* DynamsoftLabelRecognizer.xcframework +*Assembly:* DynamsoftCaptureVisionBundle.xcframework
>- Objective-C diff --git a/programming/objectivec-swift/api-reference/character-result.md b/programming/objectivec-swift/api-reference/character-result.md index f728fcb..448213d 100644 --- a/programming/objectivec-swift/api-reference/character-result.md +++ b/programming/objectivec-swift/api-reference/character-result.md @@ -16,7 +16,7 @@ The `DSCharacterResult` class represents the result of a character recognition p ## Definition -*Assembly:* DynamsoftLabelRecognizer.xcframework +*Assembly:* DynamsoftCaptureVisionBundle.xcframework
>- Objective-C diff --git a/programming/objectivec-swift/api-reference/enum/raw-text-line-status.md b/programming/objectivec-swift/api-reference/enum/raw-text-line-status.md new file mode 100644 index 0000000..94a9daa --- /dev/null +++ b/programming/objectivec-swift/api-reference/enum/raw-text-line-status.md @@ -0,0 +1,43 @@ +--- +layout: default-layout +title: RawTextLineStatus - Dynamsoft LabelRecognizer Enumerations +description: The enumeration RawTextLineStatus of Dynamsoft LabelRecognizer describes the final status of a raw text line. +keywords: Raw Text Line Status +needGenerateH3Content: true +needAutoGenerateSidebar: true +noTitleIndex: true +breadcrumbText: RawTextLineStatus +codeAutoHeight: true +--- + +# Enumeration RawTextLineStatus + +`RawTextLineStatus` enumerates the final status of a raw text line. + +
+ >- Objective-C + >- Swift + > +> +```objc +typedef NS_ENUM(NSInteger, DSRawTextLineStatus) +{ + /** Localized but recognition not performed. */ + DSRawTextLineStatusLocalized, + /** Recognition failed. */ + DSRawTextLineStatusRecognitionFailed, + /** Successfully recognized. */ + DSRawTextLineStatusRecognitionSucceeded +}NS_SWIFT_NAME(RawTextLineStatus); +``` +> +```swift +enum RawTextLineStatus: Int { + /** Localized but recognition not performed. */ + case localized + /** Recognition failed. */ + case recognitionFailed + /** Successfully recognized. */ + case recognitionSucceeded +} +``` diff --git a/programming/objectivec-swift/api-reference/label-recognizer-module.md b/programming/objectivec-swift/api-reference/label-recognizer-module.md index 71ab40f..7124ec6 100644 --- a/programming/objectivec-swift/api-reference/label-recognizer-module.md +++ b/programming/objectivec-swift/api-reference/label-recognizer-module.md @@ -15,7 +15,7 @@ The `DSLabelRecognizerModule` class defines general functions in the label recog ## Definition -*Assembly:* DynamsoftLabelRecognizer.xcframework +*Assembly:* DynamsoftCaptureVisionBundle.xcframework
>- Objective-C diff --git a/programming/objectivec-swift/api-reference/localized-text-line-element.md b/programming/objectivec-swift/api-reference/localized-text-line-element.md index 0a814e5..4100cec 100644 --- a/programming/objectivec-swift/api-reference/localized-text-line-element.md +++ b/programming/objectivec-swift/api-reference/localized-text-line-element.md @@ -16,7 +16,7 @@ The `DSLocalizedTextLineElement` class represents a localized text line element. ## Definition -*Assembly:* DynamsoftLabelRecognizer.xcframework +*Assembly:* DynamsoftCaptureVisionBundle.xcframework
>- Objective-C diff --git a/programming/objectivec-swift/api-reference/localized-text-lines-unit.md b/programming/objectivec-swift/api-reference/localized-text-lines-unit.md index d77226c..f4e0b4d 100644 --- a/programming/objectivec-swift/api-reference/localized-text-lines-unit.md +++ b/programming/objectivec-swift/api-reference/localized-text-lines-unit.md @@ -15,7 +15,7 @@ The `DSLocalizedTextLinesUnit` class represents a unit that contains localized t ## Definition -*Assembly:* DynamsoftLabelRecognizer.xcframework +*Assembly:* DynamsoftCaptureVisionBundle.xcframework
>- Objective-C diff --git a/programming/objectivec-swift/api-reference/raw-text-line.md b/programming/objectivec-swift/api-reference/raw-text-line.md index 10b24a4..7ed177d 100644 --- a/programming/objectivec-swift/api-reference/raw-text-line.md +++ b/programming/objectivec-swift/api-reference/raw-text-line.md @@ -19,7 +19,7 @@ The `DSRawTextLine` class represents a text line in an image. It can be in one o ## Definition -*Assembly:* DynamsoftLabelRecognizer.xcframework +*Assembly:* DynamsoftCaptureVisionBundle.xcframework
>- Objective-C diff --git a/programming/objectivec-swift/api-reference/raw-text-lines-unit.md b/programming/objectivec-swift/api-reference/raw-text-lines-unit.md index b683887..332b861 100644 --- a/programming/objectivec-swift/api-reference/raw-text-lines-unit.md +++ b/programming/objectivec-swift/api-reference/raw-text-lines-unit.md @@ -15,7 +15,7 @@ The `DSRawTextLinesUnit` class represents a unit which holds the raw text lines. ## Definition -*Assembly:* DynamsoftLabelRecognizer.xcframework +*Assembly:* DynamsoftCaptureVisionBundle.xcframework
>- Objective-C diff --git a/programming/objectivec-swift/api-reference/recognized-text-line-element.md b/programming/objectivec-swift/api-reference/recognized-text-line-element.md index 1b75986..3a41bfb 100644 --- a/programming/objectivec-swift/api-reference/recognized-text-line-element.md +++ b/programming/objectivec-swift/api-reference/recognized-text-line-element.md @@ -15,7 +15,7 @@ The `DSRecognizedTextLineElement` class represents a line of recognized text in ## Definition -*Assembly:* DynamsoftLabelRecognizer.xcframework +*Assembly:* DynamsoftCaptureVisionBundle.xcframework
>- Objective-C diff --git a/programming/objectivec-swift/api-reference/recognized-text-lines-result.md b/programming/objectivec-swift/api-reference/recognized-text-lines-result.md index 7a57d4c..a9a472c 100644 --- a/programming/objectivec-swift/api-reference/recognized-text-lines-result.md +++ b/programming/objectivec-swift/api-reference/recognized-text-lines-result.md @@ -16,7 +16,7 @@ The `DSRecognizedTextLinesResult` class represents the overall result(s) of a te ## Definition -*Assembly:* DynamsoftLabelRecognizer.xcframework +*Assembly:* DynamsoftCaptureVisionBundle.xcframework
>- Objective-C diff --git a/programming/objectivec-swift/api-reference/recognized-text-lines-unit.md b/programming/objectivec-swift/api-reference/recognized-text-lines-unit.md index fc77d0a..43dd45c 100644 --- a/programming/objectivec-swift/api-reference/recognized-text-lines-unit.md +++ b/programming/objectivec-swift/api-reference/recognized-text-lines-unit.md @@ -15,7 +15,7 @@ The `DSRecognizedTextLinesUnit` class represents an intermediate result unit con ## Definition -*Assembly:* DynamsoftLabelRecognizer.xcframework +*Assembly:* DynamsoftCaptureVisionBundle.xcframework
>- Objective-C diff --git a/programming/objectivec-swift/api-reference/simplified-label-recognizer-settings.md b/programming/objectivec-swift/api-reference/simplified-label-recognizer-settings.md index 2648a61..5dfc9dc 100644 --- a/programming/objectivec-swift/api-reference/simplified-label-recognizer-settings.md +++ b/programming/objectivec-swift/api-reference/simplified-label-recognizer-settings.md @@ -15,7 +15,7 @@ The `DSSimplifiedLabelRecognizerSettings` class contains settings for label reco ## Definition -*Assembly:* DynamsoftLabelRecognizer.xcframework +*Assembly:* DynamsoftCaptureVisionBundle.xcframework
>- Objective-C diff --git a/programming/objectivec-swift/api-reference/text-line-result-item.md b/programming/objectivec-swift/api-reference/text-line-result-item.md index cfda277..c1559cd 100644 --- a/programming/objectivec-swift/api-reference/text-line-result-item.md +++ b/programming/objectivec-swift/api-reference/text-line-result-item.md @@ -15,7 +15,7 @@ The `DSTextLineResultItem` class represents a single text line result item recog ## Definition -*Assembly:* DynamsoftLabelRecognizer.xcframework +*Assembly:* DynamsoftCaptureVisionBundle.xcframework
>- Objective-C