You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
BarcodeApi | [**getBarcodeRecognize**](docs/index.md#getbarcoderecognize) | **GET** /barcode/{name}/recognize | Recognize barcode from a file on server.
118
-
BarcodeApi | [**postBarcodeRecognizeFromUrlOrContent**](docs/index.md#postbarcoderecognizefromurlorcontent) | **POST** /barcode/recognize | Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image or encoded with base64.
118
+
BarcodeApi | [**postBarcodeRecognizeFromUrlOrContent**](docs/index.md#postbarcoderecognizefromurlorcontent) | **POST** /barcode/recognize | Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image with content-type \"application/octet-stream\". An image can also be passed as a form field.
119
119
BarcodeApi | [**postGenerateMultiple**](docs/index.md#postgeneratemultiple) | **POST** /barcode/generateMultiple | Generate multiple barcodes and return in response stream
120
120
BarcodeApi | [**putBarcodeGenerateFile**](docs/index.md#putbarcodegeneratefile) | **PUT** /barcode/{name}/generate | Generate barcode and save on server (from query params or from file with json or xml content)
121
121
BarcodeApi | [**putBarcodeRecognizeFromBody**](docs/index.md#putbarcoderecognizefrombody) | **PUT** /barcode/{name}/recognize | Recognition of a barcode from file on server with parameters in body.
Copy file name to clipboardExpand all lines: docs/index.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,7 +78,7 @@ Name | Type | Description | Notes
78
78
**rectWidth** | **number**| Set Width of area for recognition. | [optional]
79
79
**rectHeight** | **number**| Set Height of area for recognition. | [optional]
80
80
**stripFNC** | **boolean**| Value indicating whether FNC symbol strip must be done. | [optional]
81
-
**timeout** | **number**| Timeout of recognition process. | [optional]
81
+
**timeout** | **number**| Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. | [optional]
82
82
**medianSmoothingWindowSize** | **number**| Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set. | [optional]
83
83
**allowMedianSmoothing** | **boolean**| Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes. | [optional]
84
84
**allowComplexBackground** | **boolean**| Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode. | [optional]
@@ -102,7 +102,7 @@ Name | Type | Description | Notes
102
102
**skipDiagonalSearch** | **boolean**| Allows detector to skip search for diagonal barcodes. Setting it to false will increase detection time but allow to find diagonal barcodes that can be missed otherwise. Enabling of diagonal search leads to a bigger detection time. | [optional]
103
103
**readTinyBarcodes** | **boolean**| Allows engine to recognize tiny barcodes on large images. Ignored if AllowIncorrectBarcodes is set to True. Default value: False. | [optional]
104
104
**australianPostEncodingTable** | 'CTable', 'NTable', 'Other' | Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other. | [optional]
105
-
**ignoreEndingFillingPatternsForCTable** | **boolean**| The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequnce\"333\" of filling paterns is decoded as letter \"z\". | [optional]
105
+
**ignoreEndingFillingPatternsForCTable** | **boolean**| The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequence\"333\" of filling patterns is decoded as letter \"z\". | [optional]
106
106
**rectangleRegion** | **string**| | [optional]
107
107
**storage** | **string**| The image storage. | [optional]
108
108
**folder** | **string**| The image folder. | [optional]
@@ -115,7 +115,7 @@ Name | Type | Description | Notes
115
115
116
116
### postBarcodeRecognizeFromUrlOrContent
117
117
118
-
Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image or encoded with base64.
118
+
Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image with content-type \"application/octet-stream\". An image can also be passed as a form field.
@@ -134,7 +134,7 @@ Name | Type | Description | Notes
134
134
**rectWidth** | **number**| Set Width of area for recognition. | [optional]
135
135
**rectHeight** | **number**| Set Height of area for recognition. | [optional]
136
136
**stripFNC** | **boolean**| Value indicating whether FNC symbol strip must be done. | [optional]
137
-
**timeout** | **number**| Timeout of recognition process. | [optional]
137
+
**timeout** | **number**| Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout. | [optional]
138
138
**medianSmoothingWindowSize** | **number**| Window size for median smoothing. Typical values are 3 or 4. Default value is 3. AllowMedianSmoothing must be set. | [optional]
139
139
**allowMedianSmoothing** | **boolean**| Allows engine to enable median smoothing as additional scan. Mode helps to recognize noised barcodes. | [optional]
140
140
**allowComplexBackground** | **boolean**| Allows engine to recognize color barcodes on color background as additional scan. Extremely slow mode. | [optional]
@@ -158,7 +158,7 @@ Name | Type | Description | Notes
158
158
**skipDiagonalSearch** | **boolean**| Allows detector to skip search for diagonal barcodes. Setting it to false will increase detection time but allow to find diagonal barcodes that can be missed otherwise. Enabling of diagonal search leads to a bigger detection time. | [optional]
159
159
**readTinyBarcodes** | **boolean**| Allows engine to recognize tiny barcodes on large images. Ignored if AllowIncorrectBarcodes is set to True. Default value: False. | [optional]
160
160
**australianPostEncodingTable** | 'CTable', 'NTable', 'Other' | Interpreting Type for the Customer Information of AustralianPost BarCode.Default is CustomerInformationInterpretingType.Other. | [optional]
161
-
**ignoreEndingFillingPatternsForCTable** | **boolean**| The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequnce\"333\" of filling paterns is decoded as letter \"z\". | [optional]
161
+
**ignoreEndingFillingPatternsForCTable** | **boolean**| The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequence\"333\" of filling patterns is decoded as letter \"z\". | [optional]
162
162
**rectangleRegion** | **string**| | [optional]
163
163
**url** | **string**| The image file url. | [optional]
Copy file name to clipboardExpand all lines: docs/models.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1765,7 +1765,7 @@ interface ReaderParams {
1765
1765
stripFNC?:boolean;
1766
1766
1767
1767
/**
1768
-
* Timeout of recognition process.
1768
+
* Timeout of recognition process in milliseconds. Default value is 15_000 (15 seconds). In case of a timeout RequestTimeout (408) status will be returned. Try reducing the image size to avoid timeout.
* The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequnce \"333\" of filling paterns is decoded as letter \"z\".
1888
+
* The flag which force AustraliaPost decoder to ignore last filling patterns in Customer Information Field during decoding as CTable method. CTable encoding method does not have any gaps in encoding table and sequence \"333\" of filling patterns is decoded as letter \"z\".
0 commit comments