Skip to content

Commit 5080a0a

Browse files
Update README.md
1 parent 75f7c4f commit 5080a0a

File tree

1 file changed

+49
-48
lines changed

1 file changed

+49
-48
lines changed

README.md

Lines changed: 49 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ This class will be implemented as an activity. This class can be ini
7070
```
7171

7272
```java
73-
Intent CameraIntent = new Intent(this,Class.forName("com.extrieve.quickcapture.sdk.CameraHelper")); UriphotoURI = Uri.parse(CameraSupport.CamConfigClass.OutputPath);
73+
Intent CameraIntent = new Intent(this,Class.forName("com.extrieve.quickcapture.sdk.CameraHelper")); UriphotoURI = Uri.parse(Config.CaptureSupport.OutputPath);
7474
this.grantUriPermission(this.getPackageName(),photoURI,Intent.FLAG_GRANT_WRITE_URI_PERMISSION | Intent.FLAG_GRANT_READ_URI_PERMISSION);
7575
if (Build.VERSION.SDK_INT <= Build.VERSION_CODES.LOLLIPOP) {
7676
CameraIntent.addFlags(Intent.FLAG_GRANT_WRITE_URI_PERMISSION);
@@ -93,12 +93,13 @@ protected void onActivityResult(int requestCode, int resultCode, @Nullable
9393
finishActivity(REQUEST_CODE_FILE_RETURN);
9494
}
9595
```
96-
Camera Helper having a supporting class with static configuration
97-
CameraSupport.CamConfigClass.CamConfigClass : contains various configurations as follows:
96+
SDK included a a supporting class with static configuration - which includes all configurations related to SDK.
97+
- Confg contains a sub configuration collection **CaptureSupport** - contains all the Capture & review related configurations.
98+
Config.CaptureSupport : contains various configurations as follows:
9899

99100
- **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.
100101
```java
101-
CameraSupport.CamConfigClass.OutputPath = pass output path as string;
102+
Config.CaptureSupport.OutputPath = "pass output path sd string";
102103
```
103104
- **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
104105
> if MaxPage <= 0 / not set: means unlimited.If MaxPage >= 1:
@@ -109,61 +110,31 @@ CameraSupport.CamConfigClass.CamConfigClass : contains various configuration
109110
// MaxPage > 1 : Limited Multi Capture Mode
110111
public static int MaxPage = 0;
111112
```
112-
- **ColorMode** - To Set the capture color mode- supporting color and grayscale.
113-
- **EnableFlash** - Enable Document capture specific flash control for SDK camera.
113+
- **ColorMode** - To Set the capture color mode - supporting color and grayscale.
114+
-
115+
- **EnableFlash** - Enable Document capture specific flash control for SDK camera.
114116
```java
115-
CameraSupport.CamConfigClass.EnableFlash = true;
117+
Config.CaptureSupport.EnableFlash = true;
116118
```
117119
- **CaptureSound** - To Enable camera capture sound.
118120
```java
119121
CameraSupport.CamConfigClass.CaptureSound = true;
120122
```
121123
- **DeviceInfo** - Will share all general information about the device.
122124
```java
123-
CameraSupport.CamConfigClass.DeviceInfo;
125+
Config.CaptureSupport.DeviceInfo;
124126
```
125127
- **SDKInfo** - Contains all version related information on SDK.
126128
```java
127-
CameraSupport.CamConfigClass.SDKInfo;
129+
Config.CaptureSupport.SDKInfo;
128130
```
129131

130-
- CameraToggle - Toggle camera between front and back.
132+
- **CameraToggle** - Toggle camera between front and back.
131133
```java
132-
CameraSupport.CamConfigClass.CameraToggle = 2;
133-
//0-Disable camera toggle option.
134-
//1-Enable camera toggle option with Front camera by default.
135-
//2-Enable camera toggle option with Back camera by default.
136-
```
137-
138-
- **GetTiffForLastCapture** - Build Tiff file output file from last captured set of images.
139-
```java
140-
CameraHelper.GetTiffForLastCapture(outPutFileWithpath);
141-
//on success, will respond with string : "SUCCESS:::TiffFilePath";
142-
//use ":::" char. key to split the response.
143-
//on failure,will respond with string : "FAILED:::Reason for failure";
144-
//use ":::" char. key to split the response.
145-
//on failure, error details can collect from CameraSupport.CamConfigClass.LastLogInfo
146-
```
147-
- **GetPDFForLastCapture** - Build PDF file output file from last captured set of images.
148-
```java
149-
CameraHelper.GetPDFForLastCapture(outPutFileWithpath);
150-
//on success, will respond with string : "SUCCESS:::PdfFilePath";
151-
//use ":::" char. key to split the response.
152-
//on failure,will respond with string : "FAILED:::Reason for failure";
153-
//use ":::" char. key to split the response.
154-
//on failure, error details can collect from CameraSupport.CamConfigClass.LastLogInfo
155-
```
156-
- **BuildTiff** - Build .tiff file output from the list of images shared.
157-
```java
158-
CameraHelper.BuildTiff(ArrayList<String> ImageCol, String OutputTiffFilePath)
159-
*@param "Image File path collection as ArrayList<String>"
160-
*@return on failure = "FAILED:::REASON" || on success = "SUCCESS:::TIFF file path".
161-
```
162-
- **BuildPDF** - Build PDF file output file from last captured set of images.
163-
```java
164-
CameraHelper.BuildPDF(outPutFileWithpath);
165-
*@param "Image File path collection as ArrayList<String>"
166-
*@return on failure = "FAILED:::REASON" || on success = "SUCCESS:::PDF file path".
134+
Config.CaptureSupport.CameraToggle = CameraToggleType.ENABLE_BACK_DEFAULT;
135+
//DISABLED (0) -Disable camera toggle option.
136+
//ENABLE_BACK_DEFAULT (1) -Enable camera toggle option with Front camera by default.
137+
//ENABLE_FRONT_DEFAULT (2) -Enable camera toggle option with Back camera by default.
167138
```
168139
## ImgHelper
169140
Following are the options/methods available from class **ImgHelper** :
@@ -217,7 +188,7 @@ ImgHelper ImageHelper = new ImgHelper(this);
217188
- ***CompressToJPEG*** - *This method will Compress the provided bitmap image and will save to given path..*
218189
```java
219190

220-
Boolean Iscompressed = CompressToJPEG(bitmap,outputFilePath);
191+
Boolean Iscompressed = ImageHelper.CompressToJPEG(bitmap,outputFilePath);
221192
/*
222193
Boolean CompressToJPEG(Bitmap bm,String outputFilePath)
223194
throws ImgException
@@ -228,12 +199,42 @@ ImgHelper ImageHelper = new ImgHelper(this);
228199
- ***rotateBitmap*** - *This method will rotate the image to preferred orientation.*
229200
```java
230201

231-
Bitmap rotatedBm = rotateBitmapDegree(nBm, RotationDegree);
202+
Bitmap rotatedBm = ImageHelper.rotateBitmapDegree(nBm, RotationDegree);
232203
/*
233204
Bitmap rotateBitmapDegree(Bitmap bitmap,int Degree)
234205
throws ImgException
235206
*/
236-
```
207+
```
208+
- **GetTiffForLastCapture** - Build Tiff file output file from last captured set of images.
209+
```java
210+
ImageHelper.GetTiffForLastCapture(outPutFileWithpath);
211+
//on success, will respond with string : "SUCCESS:::TiffFilePath";
212+
//use ":::" char. key to split the response.
213+
//on failure,will respond with string : "FAILED:::Reason for failure";
214+
//use ":::" char. key to split the response.
215+
//on failure, error details can collect from CameraSupport.CamConfigClass.LastLogInfo
216+
```
217+
- **GetPDFForLastCapture** - Build PDF file output file from last captured set of images.
218+
```java
219+
ImageHelper.GetPDFForLastCapture(outPutFileWithpath);
220+
//on success, will respond with string : "SUCCESS:::PdfFilePath";
221+
//use ":::" char. key to split the response.
222+
//on failure,will respond with string : "FAILED:::Reason for failure";
223+
//use ":::" char. key to split the response.
224+
//on failure, error details can collect from CameraSupport.CamConfigClass.LastLogInfo
225+
```
226+
- **BuildTiff** - Build .tiff file output from the list of images shared.
227+
```java
228+
ImageHelper.BuildTiff(ArrayList<String> ImageCol, String OutputTiffFilePath)
229+
*@param "Image File path collection as ArrayList<String>"
230+
*@return on failure = "FAILED:::REASON" || on success = "SUCCESS:::TIFF file path".
231+
```
232+
- **BuildPDF** - Build PDF file output file from last captured set of images.
233+
```java
234+
ImageHelper.BuildPDF(outPutFileWithpath);
235+
*@param "Image File path collection as ArrayList<String>"
236+
*@return on failure = "FAILED:::REASON" || on success = "SUCCESS:::PDF file path".
237+
```
237238

238239
## ImgException
239240
As a part of exceptional error handling **ImgException** class is available.

0 commit comments

Comments
 (0)