ScannerPro class

Top-level facade class providing high-level, 1-line static methods for document parsing, OCR text extraction, image scanning, PDF processing, image compression, encrypted storage, quality analysis, and checksum validation across all 18 ScannerPro vision modes.

Constructors

ScannerPro()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

version → String

Current SDK version string.

no setter

Static Methods

analyzeQuality(Uint8List imageBytes, {int width = 640, int height = 480}) → ScanQualityReport

Analyzes scan image quality (blur, light, skew, contrast).

batchExportToPdf({required List<ScanResult> results, String title = 'ScannerPro Batch Export', bool enableCompression = true, String? watermarkText}) → Uint8List

Batch exports multiple scan results into a single multi-page PDF byte buffer.

compressImage(Uint8List imageBytes, {double quality = 0.85}) → CompressionResult

Compresses raw image bytes using quality-based compression.

decryptScan(EncryptedScanData encrypted, {required String password}) → ScanResult?

Decrypts an EncryptedScanData envelope back to a ScanResult.

encryptScan(ScanResult result, {required String password, Duration? ttl}) → EncryptedScanData

Encrypts a ScanResult with the given password for secure storage.

enhanceDocument(Uint8List bytes, DocumentFilterMode filterMode, {int? width, int? height, int binarizationThreshold = 128}) → Uint8List

Priority 4: High-level Auto Document Enhancement filter API.

exportToJpgBytes(ScanResult result) → Uint8List

Exports a scan result as simulated JPG byte buffer.

exportToPdfBytes({required List<ScanResult> results, String title = 'ScannerPro Document Export', String? watermarkText, String? password, bool isEncrypted = false, bool digitalSignature = false, bool enableCompression = true}) → Uint8List

Exports a list of scan results to PDF raw byte buffer.

exportToPngBytes(ScanResult result) → Uint8List

Exports a scan result as simulated PNG byte buffer.

scanAadhaar(String rawTextOrXml) → ScanResult

Scans and parses an Indian Aadhaar card from raw text or Secure QR XML payload.

scanBarcode(dynamic input, {ScanMode mode = ScanMode.barcode}) → Future<ScanResult>

Priority 3: High-level Multi-format Barcode & QR Code Scanner API.

scanBusinessCard(String rawText) → ScanResult

Scans and parses a Business Card text block into contact attributes.

scanBytes(Uint8List bytes, {ScanMode mode = ScanMode.qr}) → Future<ScanResult>

High-level API to scan a raw byte buffer bytes under specified mode.

scanDocument(dynamic input) → Future<ScanResult>

Priority 2: High-level Document Edge Detection & Perspective Scanner API.

scanDrivingLicense(String rawText) → ScanResult

Scans and parses a Driving License PDF417 payload or card OCR string.

scanImage(dynamic imageInput, {ScanMode mode = ScanMode.qr}) → Future<ScanResult>

High-level API to scan an image file or byte buffer for barcodes/OCR text.

scanOcr(dynamic input) → Future<ScanResult>

Priority 1: High-level Optical Character Recognition (OCR) API on file/bytes/asset input.

scanPanCard(String rawOcrText) → ScanResult

Scans and parses an Income Tax PAN Card from raw OCR text string.

scanPassport(String mrzString) → ScanResult

Scans and parses a Passport MRZ string (ICAO Doc 9303 standard).

scanPDF(dynamic pdfInput, {ScanMode mode = ScanMode.ocr}) → Future<ScanResult>

High-level API to extract barcodes, QR codes, or run OCR from a PDF document file or byte payload.

scanVin(String rawText) → ScanResult

Scans and parses a 17-character Vehicle Identification Number (ISO 3779).

validateResult(ScanResult result) → ValidationResult

Validates a ScanResult payload using rule-based checksums (EAN, Verhoeff, ITD, ISO 3779, ICAO 9303).