Skip to content

Commit 23ed83e

Browse files
Update README.md
1 parent d264fb5 commit 23ed83e

1 file changed

Lines changed: 47 additions & 37 deletions

File tree

README.md

Lines changed: 47 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
<img class="img-fluid" align="center" src="https://github.com/ExtrieveTechnologies/QuickCapture/blob/main/QuickCapture.png?raw=true" width="30%" alt="img-verification"><a align="center" href='https://play.google.com/store/apps/details?id=com.extrieve.exScan&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1' title="Click to download android app" target="_blank" rel="noopener noreferrer"><img align="center" width="150px" alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png'/></a><img align="right" class="img-fluid" padding="10px" src="https://github.com/ExtrieveTechnologies/QuickCapture/blob/main/android.png?raw=true?raw=true" alt="img-verification">
23

34

@@ -47,7 +48,7 @@ repositories {
4748
4849
//Then add implementation for SDK in dependencies in build.gradle (module:<yourmodulename>)
4950
dependencies {
50-
implementation 'com.extrieve.quickcapture:QCv4:4.0.9'
51+
implementation 'com.extrieve.quickcapture:QCv4:4.0.10'
5152
}
5253
```
5354

@@ -57,7 +58,7 @@ Or Maven:
5758
<dependency>
5859
<groupId>com.extrieve.quickcapture</groupId>
5960
<artifactId>QCv4</artifactId>
60-
<version>4.0.9</version>
61+
<version>4.0.10</version>
6162
</dependency>
6263
```
6364

@@ -66,9 +67,9 @@ Or even you can download the **.aar** library file from GitHub's [releases page]
6667

6768
Compatibility
6869
-------------
69-
* **JAVA 11 Support**: QuickCapture v3 requires JAVA version 11 support for the application.
70-
* **Minimum Android SDK**: QuickCapture v3 requires a minimum API level of 21.
71-
* **Compiled SDK Version**: QuickCapture v3 compiled against **API 34**.
70+
* **JAVA 17 Support**: QuickCapture v4 requires JAVA version 17 support for the application.
71+
* **Minimum Android SDK**: QuickCapture v4 requires a minimum API level of 21.
72+
* **Compiled SDK Version**: QuickCapture v4 compiled against **API 34**.
7273

7374

7475
## API and integration Details - Available properties and method
@@ -77,9 +78,8 @@ SDK have two core classes and supporting classes :
7778

7879
1. **CameraHelper** - *Handle the camera related operations. Basically, an activity.*
7980
2. **ImgHelper** - *Purpose of this class is to handle all imaging related operations.*
80-
3. **OpticalCodeHelper** - *Handle the camera related operations. Basically, an activity.*
81-
4. **Config** - *Holds various configurations SDK.*
82-
5. **ImgException** - *Handle all exceptions on image related operations on ImgHelper.*
81+
3. **OpticalCodeHelper** - *Handle the Opticalcode (QR CODE & BAR CODE) related activities*
82+
4. **Config** - *Holds various configurations for SDK.*
8383

8484

8585
Based on the requirement, any one or all classes can be used.And need to import those from the SDK.
@@ -88,6 +88,7 @@ Based on the requirement, any one or all classes can be used.And need to import
8888
//OR : can import only required classes as per use cases.
8989
import com.extrieve.quickcapture.sdk.ImgHelper;
9090
import com.extrieve.quickcapture.sdk.CameraHelper;
91+
import com.extrieve.quickcapture.sdk.OpticalCodeHelper;
9192
import com.extrieve.quickcapture.sdk.Config;
9293
import com.extrieve.quickcapture.sdk.ImgException;
9394
```
@@ -283,7 +284,7 @@ try {
283284
Toast.makeText(this, "Failed to open camera -" + ex.message, Toast.LENGTH_LONG).show()
284285
}
285286
```
286-
## Confg
287+
## Config
287288
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.
288289
Config.CaptureSupport : contains various configurations as follows:
289290

@@ -344,15 +345,23 @@ Config.CaptureSupport : contains various configurations as follows:
344345
//Kotlin
345346
Config!!.CaptureSupport!!.CaptureSound = true;
346347
```
347-
- **DeviceInfo** - Will share all general information about the device.
348+
349+
- **CameraToggle** - Toggle camera between front and back.
348350
```java
349351
//JAVA
350-
Config.CaptureSupport.DeviceInfo;
352+
Config.CaptureSupport.CameraToggle = CameraToggleType.ENABLE_BACK_DEFAULT;
353+
//DISABLED (0) -Disable camera toggle option.
354+
//ENABLE_BACK_DEFAULT (1) - Enable camera toggle option with Front camera by default.
355+
//ENABLE_FRONT_DEFAULT (2) - Enable camera toggle option with Back camera by default.
351356
```
352357
```kotlin
353358
//Kotlin
354-
Config!!.CaptureSupport!!.DeviceInfo;
355-
```
359+
Config!!.CaptureSupport!!.CameraToggle = CameraToggleType!!.ENABLE_BACK_DEFAULT;
360+
//DISABLED (0) -Disable camera toggle option.
361+
//ENABLE_BACK_DEFAULT (1) - Enable camera toggle option with Front camera by default.
362+
//ENABLE_FRONT_DEFAULT (2) - Enable camera toggle option with Back camera by default.
363+
**Common** - contains all the Capture & review related configurations.
364+
Config.CaptureSupport : contains various configurations as follows:
356365
- **SDKInfo** - Contains all version related information on SDK.
357366
```java
358367
//JAVA
@@ -362,22 +371,34 @@ Config.CaptureSupport : contains various configurations as follows:
362371
//Kotlin
363372
Config!!.CaptureSupport!!.SDKInfo;
364373
```
365-
366-
- **CameraToggle** - Toggle camera between front and back.
374+
- **DeviceInfo** - Will share all general information about the device.
367375
```java
368376
//JAVA
369-
Config.CaptureSupport.CameraToggle = CameraToggleType.ENABLE_BACK_DEFAULT;
370-
//DISABLED (0) -Disable camera toggle option.
371-
//ENABLE_BACK_DEFAULT (1) - Enable camera toggle option with Front camera by default.
372-
//ENABLE_FRONT_DEFAULT (2) - Enable camera toggle option with Back camera by default.
377+
Config.CaptureSupport.DeviceInfo;
373378
```
374379
```kotlin
375380
//Kotlin
376-
Config!!.CaptureSupport!!.CameraToggle = CameraToggleType!!.ENABLE_BACK_DEFAULT;
377-
//DISABLED (0) -Disable camera toggle option.
378-
//ENABLE_BACK_DEFAULT (1) - Enable camera toggle option with Front camera by default.
379-
//ENABLE_FRONT_DEFAULT (2) - Enable camera toggle option with Back camera by default.
381+
Config!!.CaptureSupport!!.DeviceInfo;
382+
```
383+
384+
385+
**License** - contains all the Capture & review related configurations.
386+
Config.CaptureSupport : contains various configurations as follows: ```
387+
388+
- ***Activate*** - *Set the Layout for the images generated/processed by the system.*
389+
```java
390+
//JAVA
391+
Config.License.Activate(hostApplicationContext,licenseString);
392+
```
393+
```kotlin
394+
//Kotlin
395+
Config!!.License!!.Activate(hostApplicationContext,licenseString)
380396
```
397+
>*Available layouts* : A1, A2, A3, **A4**, A5, A6, A7,PHOTO & CUSTOM
398+
399+
*A4 is the most recommended layout for document capture scenarios.*
400+
401+
381402
## ImgHelper
382403
Following are the options/methods available from class **ImgHelper** :
383404
```java
@@ -563,14 +584,9 @@ As a part of exceptional error handling **ImgException** class is available.
563584

564585
//Read lic asset file locally or provide a file url
565586
// eg : String licData = readAssetFile("com.extrieve.lic", this);
566-
//Pass liscence data to UnlockImagingLibrary method on object(imageHelper) of ImgHelper class.
567-
Boolean IsUnlocked = ImageHelper.UnlockImagingLibrary(licData)
568-
569-
/*
570-
boolean UnlockImagingLibrary(String licenseFileData)
571-
throws Exception
572-
*/
573-
587+
//Pass liscence data to Activate method on Config.License.
588+
String licStr = "<Provide license string here >";
589+
Boolean IsUnlocked = Config.License.Activate(this,licStr);
574590
```
575591

576592
```kotlin
@@ -580,12 +596,6 @@ boolean UnlockImagingLibrary(String licenseFileData)
580596
// eg : String licData = readAssetFile("com.extrieve.lic", this);
581597
//Pass liscence data to UnlockImagingLibrary method on object(imageHelper) of ImgHelper class.
582598
val isUnlocked: Boolean = imageHelper!!.UnlockImagingLibrary(licData)
583-
584-
/*
585-
boolean UnlockImagingLibrary(String licenseFileData)
586-
throws Exception
587-
*/
588-
589599
```
590600

591601

0 commit comments

Comments
 (0)