Skip to content

Commit 2cc09c7

Browse files
authored
Update README.md
1 parent 2126f70 commit 2cc09c7

1 file changed

Lines changed: 95 additions & 0 deletions

File tree

README.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,25 @@ The SDK includes a supporting class called for static configuration. This class
361361
//Kotlin
362362
Config!!.CaptureSupport!!.CaptureSound = true;
363363
```
364+
- **CaptureReview** - To Enables or disables review after capture.
365+
```java
366+
//JAVA
367+
Config.CaptureSupport.CaptureReview = true; //By default it is enabled
368+
```
369+
```kotlin
370+
//Kotlin
371+
Config!!.CaptureSupport!!.CaptureReview = true; //By default it is enabled
372+
```
373+
374+
- **ShowCaptureCountAndLimit** - Displays the count and limit of captures.
375+
```java
376+
//JAVA
377+
Config.CaptureSupport.ShowCaptureCountAndLimit = true; //By default it is enabled
378+
```
379+
```kotlin
380+
//Kotlin
381+
Config!!.CaptureSupport!!.ShowCaptureCountAndLimit = true; //By default it is enabled
382+
```
364383

365384
- **CameraToggle** - Toggle camera between front and back.
366385
```java
@@ -378,6 +397,82 @@ The SDK includes a supporting class called for static configuration. This class
378397
//ENABLE_FRONT_DEFAULT (2) - Enable camera toggle option with Back camera by default.
379398
```
380399

400+
- **EnableTorchOnLowLight** - Enables or Disable automatic torch turning on when low light detected.
401+
```java
402+
//JAVA
403+
Config.CaptureSupport.EnableTorchOnLowLight = false; // By Default it is disabled.
404+
```
405+
```kotlin
406+
//Kotlin
407+
408+
Config!!.CaptureSupport!!.EnableTorchOnLowLight = false; // By Default it is disabled.
409+
```
410+
411+
- **PerspectiveCorrection** - Applies perspective correction if enabled after crop.
412+
```java
413+
//JAVA
414+
Config.CaptureSupport.PerspectiveCorrection = true; // By Default it is enabled.
415+
```
416+
```kotlin
417+
//Kotlin
418+
419+
Config!!.CaptureSupport!!.PerspectiveCorrection = true; // By Default it is enabled.
420+
```
421+
422+
- **DocumentCropping** - Specifies the cropping behavior after capturing an image.
423+
```java
424+
//JAVA
425+
//CroppingType options are as follows:
426+
//AutoCapture - Automatically crops the captured image.
427+
//AssistedCapture - Provides assistance to the user for cropping.
428+
//AutoCrop - Automatically detects and crops the content.
429+
//Disabled - No cropping is performed.
430+
Config.CaptureSupport.DocumentCropping = Config.CaptureSupport.CroppingType.AssistedCapture; // Default value.
431+
```
432+
```kotlin
433+
//Kotlin
434+
//CroppingType options are as follows:
435+
//AutoCapture - Automatically crops the captured image.
436+
//AssistedCapture - Provides assistance to the user for cropping.
437+
//AutoCrop - Automatically detects and crops the content.
438+
//Disabled - No cropping is performed.
439+
Config!!.CaptureSupport!!.DocumentCropping = Config.CaptureSupport.CroppingType.AssistedCapture; // Default value.
440+
```
441+
442+
- **CropFilter** - Specifies the type of image filter to apply after cropping.
443+
```java
444+
//JAVA
445+
//CropImageFilterType options are as follows:
446+
//NONE - No image enhancement.
447+
//ENHANCE - Enhances the image quality.
448+
//GRAY - Converts the image to grayscale.
449+
//XEROX - Applies a Xerox photocopy style effect.
450+
Config.CaptureSupport.CropFilter = Config.CaptureSupport.CropImageFilterType.NONE; //Default value
451+
```
452+
```kotlin
453+
//Kotlin
454+
//CropImageFilterType options are as follows:
455+
//NONE - No image enhancement.
456+
//ENHANCE - Enhances the image quality.
457+
//GRAY - Converts the image to grayscale.
458+
//XEROX - Applies a Xerox photocopy style effect.
459+
Config!!.CaptureSupport!!.CropFilter = Config.CaptureSupport.CropImageFilterType.NONE; // Default value.
460+
```
461+
462+
463+
**Review** - Contains all the Review related configurations. **Config.CaptureSupport.Review** contains various configurations as follows:
464+
- ***EnableAutoCorrectDocAngle*** - *Toggle the auto rotation feature when image is attached to the review screen.*
465+
```java
466+
//JAVA
467+
Config.CaptureSupport.Review.EnableAutoCorrectDocAngle = false; //to disable this feature
468+
```
469+
```kotlin
470+
//Kotlin
471+
Config!!.CaptureSupport!!.Review!!.EnableAutoCorrectDocAngle = false;
472+
```
473+
> **Note** : For any scenario (Normal photo capture) if auto rotation is not needed then host application should disbale it using this config.
474+
475+
381476
**Common** - Contains various configurations as follows:
382477

383478
- **SDKInfo** - Contains all version related information on SDK.

0 commit comments

Comments
 (0)