Skip to content

Commit ccee93c

Browse files
Update README.md
1 parent fe1c236 commit ccee93c

1 file changed

Lines changed: 28 additions & 27 deletions

File tree

README.md

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ SDK have two core classes and supporting classes :
7070
4. **ImgException** - *Handle all exceptions on image related operations on ImgHelper.*
7171

7272

73-
Based on the requirement, any one or all classes can be used. And need to import those from the SDK.
73+
Based on the requirement, any one or all classes can be used.And need to import those from the SDK.
7474
```java
7575
import com.extrieve.quickcapture.sdk.*;
7676
//OR : can import only required classes as per use cases.
@@ -273,9 +273,9 @@ try {
273273
```
274274
## Confg
275275
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.
276-
Config.CaptureSupport : contains various configurations as follows:
276+
Config.CaptureSupport : contains various configurations as follows:
277277

278-
- **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.
278+
- **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.
279279
```java
280280
//JAVA
281281
Config.CaptureSupport.OutputPath = "pass output path sd string";
@@ -284,7 +284,7 @@ Config.CaptureSupport : contains various configurations as follows:
284284
//Kotlin
285285
Config!!.CaptureSupport!!.OutputPath = "pass output path sd string";
286286
```
287-
- **MaxPage** - To set the number of captures to do on each camera session. And this can also control whether the capture mode is single or multi i.e
287+
- **MaxPage** - To set the number of captures to do on each camera session. And this can also control whether the capture mode is single or multi i.e :
288288
> if MaxPage <= 0 / not set: means unlimited.If MaxPage >= 1:
289289
> means limited.
290290
```java
@@ -317,22 +317,22 @@ Config.CaptureSupport : contains various configurations as follows:
317317
- **EnableFlash** - Enable Document capture specific flash control for SDK camera.
318318
```java
319319
//JAVA
320-
Config.CaptureSupport.EnableFlash = true;
320+
Config.CaptureSupport.EnableFlash = true;
321321
```
322322
```kotlin
323323
//Kotlin
324-
Config!!.CaptureSupport!!.EnableFlash = true;
324+
Config!!.CaptureSupport!!.EnableFlash = true;
325325
```
326-
- **CaptureSound** - To Enable camera capture sound.
326+
- **CaptureSound** - To Enable camera capture sound.
327327
```java
328328
//JAVA
329-
Config.CaptureSupport.CaptureSound = true;
329+
Config.CaptureSupport.CaptureSound = true;
330330
```
331331
```kotlin
332332
//Kotlin
333-
Config!!.CaptureSupport!!.CaptureSound = true;
333+
Config!!.CaptureSupport!!.CaptureSound = true;
334334
```
335-
- **DeviceInfo** - Will share all general information about the device.
335+
- **DeviceInfo** - Will share all general information about the device.
336336
```java
337337
//JAVA
338338
Config.CaptureSupport.DeviceInfo;
@@ -341,7 +341,7 @@ Config.CaptureSupport : contains various configurations as follows:
341341
//Kotlin
342342
Config!!.CaptureSupport!!.DeviceInfo;
343343
```
344-
- **SDKInfo** - Contains all version related information on SDK.
344+
- **SDKInfo** - Contains all version related information on SDK.
345345
```java
346346
//JAVA
347347
Config.CaptureSupport.SDKInfo;
@@ -356,18 +356,18 @@ Config.CaptureSupport : contains various configurations as follows:
356356
//JAVA
357357
Config.CaptureSupport.CameraToggle = CameraToggleType.ENABLE_BACK_DEFAULT;
358358
//DISABLED (0) -Disable camera toggle option.
359-
//ENABLE_BACK_DEFAULT (1) -Enable camera toggle option with Front camera by default.
360-
//ENABLE_FRONT_DEFAULT (2) -Enable camera toggle option with Back camera by default.
359+
//ENABLE_BACK_DEFAULT (1) - Enable camera toggle option with Front camera by default.
360+
//ENABLE_FRONT_DEFAULT (2) - Enable camera toggle option with Back camera by default.
361361
```
362362
```kotlin
363363
//Kotlin
364364
Config!!.CaptureSupport!!.CameraToggle = CameraToggleType!!.ENABLE_BACK_DEFAULT;
365365
//DISABLED (0) -Disable camera toggle option.
366-
//ENABLE_BACK_DEFAULT (1) -Enable camera toggle option with Front camera by default.
367-
//ENABLE_FRONT_DEFAULT (2) -Enable camera toggle option with Back camera by default.
366+
//ENABLE_BACK_DEFAULT (1) - Enable camera toggle option with Front camera by default.
367+
//ENABLE_FRONT_DEFAULT (2) - Enable camera toggle option with Back camera by default.
368368
```
369369
## ImgHelper
370-
Following are the options/methods available from class **ImgHelper** :
370+
Following are the options/methods available from class **ImgHelper** :
371371
```java
372372
//JAVA
373373
ImgHelper ImageHelper = new ImgHelper(this);
@@ -407,7 +407,7 @@ var ImageHelper: ImgHelper? = ImgHelper(this)
407407

408408
*A4 is the most recommended layout for document capture scenarios.*
409409

410-
- ***SetDPI*** - *Set DPI (depth per inch) for the image.*
410+
- ***SetDPI*** - *Set DPI(depth per inch) for the image.*
411411
```java
412412
//JAVA
413413
ImageHelper.SetDPI(ImgHelper.DPI.DPI_200.ordinal());
@@ -470,7 +470,7 @@ var ImageHelper: ImgHelper? = ImgHelper(this)
470470
var thumb = ImageHelper!!.rotateBitmapDegree(bitmap, RotationDegree);
471471

472472
```
473-
- **GetTiffForLastCapture** - Build Tiff file output file from last captured set of images.
473+
- **GetTiffForLastCapture** - Build Tiff file output file from last captured set of images.
474474
```java
475475
//JAVA
476476
ImageHelper.GetTiffForLastCapture(outPutFileWithpath);
@@ -500,25 +500,26 @@ var ImageHelper: ImgHelper? = ImgHelper(this)
500500
var thumb = ImageHelper!!.GetPDFForLastCapture(outPutFileWithpath);
501501

502502
```
503-
- **BuildTiff** - Build .tiff file output from the list of images shared.
503+
- **BuildTiff** - Build .tiff file output from the list of images shared.
504504
```java
505505
//JAVA
506-
ImageHelper.BuildTiff(ImageCol,OutputTiffFilePath)
507-
*@param "Image File path collection as ArrayList<String>"
508-
*@param "Output Tiff FilePath as String.
509-
*@return on failure = "FAILED:::REASON" || on success = "SUCCESS:::TIFF file path".
506+
ImageHelper.BuildTiff(ImageCol,OutputTiffFilePath);
507+
*@param "Image File path collection as ArrayList<String>".
508+
*@param "Output Tiff FilePath as String".
509+
*@return on failure = "FAILED:::REASON" || on success = "SUCCESS:::TIFF file path".
510510
```
511511
```kotlin
512512
//KOTLIN
513513
var thumb = ImageHelper!!.BuildTiff(ImageCol,OutputTiffFilePath);
514514

515515
```
516-
- **BuildPDF** - Build PDF file output file from last captured set of images.
516+
- **BuildPDF** - Build PDF file output file from last captured set of images.
517517
```java
518518
//JAVA
519-
ImageHelper.BuildPDF(outPutFileWithpath);
520-
*@param "Image File path collection as ArrayList<String>"
521-
*@return on failure = "FAILED:::REASON" || on success = "SUCCESS:::PDF file path".
519+
ImageHelper.BuildPDF(ImageCol,outPutPDFFileWithpath);
520+
*@param "Image File path collection as ArrayList<String>"
521+
*@param "Output Tiff FilePath as String".
522+
*@return on failure = "FAILED:::REASON" || on success = "SUCCESS:::PDF file path".
522523
```
523524
```kotlin
524525
//KOTLIN

0 commit comments

Comments
 (0)