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
Copy file name to clipboardExpand all lines: README.md
+13-10Lines changed: 13 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ QuickCapture Mobile Scanning SDK Specially designed for native ANDROID from [Ext
7
7
8
8
> It's not "**just**" a scanning SDK. It's a "**document**" scanning/capture SDK evolved with **Best Quality**, **Highest Possible Compression**, **Image Optimisation**, of output document in mind.
9
9
10
-
> Control**DPI**,**Layout** & **Size** of output images, PDF & TIFF
10
+
> Controls**DPI**,**Layout** & **Size** of output images, PDF & TIFF
Or even you can download the **.aar** library file from GitHub's [releases page](https://github.com/ExtrieveTechnologies/QuickCapture_Android/releases/) and add the file dependency manually in to the project/app.
65
+
Or you can even download the **.aar** library file from GitHub's [releases page](https://github.com/ExtrieveTechnologies/QuickCapture_Android/releases/) and add the file dependency manually in to the project/app.
66
66
67
67
68
68
Compatibility
@@ -76,13 +76,13 @@ Compatibility
76
76
77
77
SDK have two core classes and supporting classes :
78
78
79
-
1.**CameraHelper** - *Handle the camera related operations. Basically, an activity.*
79
+
1.**CameraHelper** - *Handles the camera related operations. Basically, an activity.*
80
80
2.**ImgHelper** - *Purpose of this class is to handle all imaging related operations.*
81
-
3.**OpticalCodeHelper** - *Handle the Opticalcode (QR CODE & BAR CODE) related activities*
81
+
3.**OpticalCodeHelper** - *Handles the Opticalcode (QR CODE & BAR CODE) related activities*
82
82
4.**Config** - *Holds various configurations for SDK.*
83
83
84
84
85
-
Based on the requirement, any one or all classes can be used.And need to import those from the SDK.
85
+
Based on the requirement, any or all classes can be used. These classes need to be imported from the SDK.
86
86
```java
87
87
importcom.extrieve.quickcapture.sdk.*;
88
88
//OR : can import only required classes as per use cases.
@@ -113,7 +113,7 @@ SDK having multiple flows as follows :
**1. CAMERA_CAPTURE_REVIEW** - *Default flow of the CameraHelper.Includes Capture with SDK Camera -> Review Image.*
116
+
**1. CAMERA_CAPTURE_REVIEW** - *Default flow of the CameraHelper.Includes Capture with SDK Camera -> Review Image.*
117
117
118
118
```java
119
119
//JAVA
@@ -229,7 +229,7 @@ try {
229
229
}
230
230
```
231
231
232
-
**3. IMAGE_ATTACH_REVIEW** - *If user need to review an image from device / gallery - this option can be used.After attach each image,review and all functionalities depends on review can be avail*.
232
+
**3. IMAGE_ATTACH_REVIEW** - *If user needs to review an image from device / gallery - this option can be used.After attaching an image,review and all functionalities depends on review can be avail*.
233
233
234
234
```java
235
235
//JAVA
@@ -285,7 +285,9 @@ try {
285
285
}
286
286
```
287
287
## Config
288
-
SDK included a supporting class with static configuration - which includes all configurations related to SDK.Confg contains a sub configuration collection **CaptureSupport** - contains all the Capture & review related configurations.
288
+
SDK is included with a supporting class that has static configuration - this includes all configurations related to SDK.Config contains a collection of sub configurations which include:
289
+
290
+
-**CaptureSupport** - contains all the Capture & review related configurations.
289
291
Config.CaptureSupport : contains various configurations as follows:
290
292
291
293
-**OutputPath** - To set the output directory in which the captured images will be saved.Base app should have rights to write to the provided path.
@@ -327,7 +329,7 @@ Config.CaptureSupport : contains various configurations as follows:
327
329
//RBG (1) - Use capture flow in color mode.
328
330
//GREY (2) - Use capture flow in grey scale mode.
329
331
```
330
-
-**EnableFlash** - Enable Document capture specific flash control for SDK camera.
332
+
-**EnableFlash** - Enable Document capture specific to flash control for SDK camera.
331
333
```java
332
334
//JAVA
333
335
Config.CaptureSupport.EnableFlash = true;
@@ -360,6 +362,7 @@ Config.CaptureSupport : contains various configurations as follows:
360
362
//DISABLED (0) -Disable camera toggle option.
361
363
//ENABLE_BACK_DEFAULT (1) - Enable camera toggle option with Front camera by default.
362
364
//ENABLE_FRONT_DEFAULT (2) - Enable camera toggle option with Back camera by default.
365
+
363
366
**Common** - contains all the Capture & review related configurations.
364
367
Config.CaptureSupport : contains various configurations as follows:
365
368
-**SDKInfo** - Contains all version related information on SDK.
@@ -409,7 +412,7 @@ ImgHelper ImageHelper = new ImgHelper(this);
409
412
//Kotlin
410
413
varImageHelper:ImgHelper?=ImgHelper(this)
411
414
```
412
-
-***SetImageQuality*** - *Set the Quality of the image, Document_Qualityisused.If documents are used further for any automations and OCR, use Document_Quality.*
415
+
-***SetImageQuality*** - *Set the Quality of the image, Document_Quality is used. If documents are used further for any automations and OCR, use Document_Quality.*
0 commit comments