quickcapture 1.0.10 quickcapture: ^1.0.10 copied to clipboard
QuickCapture AI Based Mobile Document Scanning plugin for Flutter From Extrieve.
quickcapture #
Extrieve Technologies - Your Expert in Document Management & AI Solutions
Flutter plugin QuickCapture makes it possible to scan documents using mobile devices.
With the simple integration of this plugin, mobile applications can reliably scan documents using the camera on a user's mobile device. High-quality documents are captured with optimised focus control.
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.
Control DPI,Layout & Size of output images, PDF & TIFF
Developer-friendly & Easy to integration SDK.
Documents can be compressed,optimised & converted to make them smaller, which speeds up uploads and uses less infrastructure.
Also can build PDF and TIFF output from the captured images or even convert images to PDF and TIFF.
For more information : Checkout
Compatibility
-
JAVA 17 Support: Requires JAVA version 17 support for the application.
-
Minimum Android SDK: Requires a minimum API 21
-
Target SDK Version: Supported latest API 35.
-
Compiled SDK Version: compiled against API 34.
-
Minimum IOS: requires a minimum iOS 11.
Other available platform options #
API Details #
1. activateLicense
#
Activates the license for using the QuickCapture plugin.
Usage
Future<bool?> activateLicense({
required String android,
required String ios,
});
Parameters
android
: The license string for Android.ios
: The license string for iOS.
Return Value
true
if the license was successfully activated.false
ornull
if activation failed.
Example
Future<void> activateLicense() async {
String androidLicense = "<ANDROID_LICENSE>";
String iosLicense = "<IOS_LICENSE>";
bool? isActivated = await _quickCapturePlugin.activateLicense(
android: androidLicense,
ios: iosLicense,
);
if (isActivated == true) {
print("License activated successfully.");
} else {
print("License activation failed.");
}
}
2. initialize
#
Initializes the QuickCapture plugin. This method must be called before using other methods.
Usage
void initialize();
Example
@override
void initState() {
super.initState();
_quickCapturePlugin.initialize();
}
3. startCapture
#
Starts the document capture process and returns the details of the captured images.
Usage
Future<String?> startCapture();
Return Value
- A JSON string containing details of the captured images.
Example
Future<void> startCapture() async {
String? response = await _quickCapturePlugin.startCapture();
if (response != null) {
Map<String, dynamic> jsonResponse = jsonDecode(response);
List<String> capturedImages = List<String>.from(jsonResponse['fileCollection']);
print("Captured Images: $capturedImages");
} else {
print("Capture failed or cancelled.");
}
}
4. buildPDFForLastCapture
#
Builds a PDF file from the images captured in the last session.
Usage
Future<String?> buildPDFForLastCapture();
Return Value
- A string containing the file path of the generated PDF.
Example
Future<void> buildPDF() async {
String? pdfPath = await _quickCapturePlugin.buildPDFForLastCapture();
if (pdfPath != null) {
print("PDF generated at: $pdfPath");
} else {
print("Failed to generate PDF.");
}
}
5. buildTIFFForLastCapture
#
Builds a TIFF file from the images captured in the last session.
Usage
Future<String?> buildTIFFForLastCapture();
Return Value
- A string containing the file path of the generated TIFF.
Example
Future<void> buildTIFF() async {
String? tiffPath = await _quickCapturePlugin.buildTIFFForLastCapture();
if (tiffPath != null) {
print("TIFF generated at: $tiffPath");
} else {
print("Failed to generate TIFF.");
}
}
Method Summary #
Method | Description | Return Value |
---|---|---|
activateLicense |
Activates the license for the plugin. | true on success, false /null otherwise. |
initialize |
Initializes the plugin. | void |
startCapture |
Starts the document capture process. | JSON string with capture details. |
buildPDFForLastCapture |
Builds a PDF from the last capture. | File path of the generated PDF. |
buildTIFFForLastCapture |
Builds a TIFF from the last capture. | File path of the generated TIFF. |
Notes #
- Initialization: Always call
initialize
before using any other methods. - License Activation: Ensure to activate the license before using the plugin's functionalities.
- Error Handling: Handle
null
responses gracefully to avoid crashes.
For more information, refer to the official documentation.