Skip to main content

SDK Feature Overview | Flutter Document Scanner

The Scanbot SDK offers a number of features, most of which are available both as a Ready-To-Use UI (RTU UI) solution and as a classic component:

  • (Deprecated) RTU UI is easy to use (sometimes involving little more than adding a few lines of code), but has limited customization options.
  • RTU UI v2 is our brand new implementation of the RTU UI components, written from scratch. It features a new visual style and much more customizable UI and behavior.
  • Classic components are usually somewhat harder to integrate. However, they provide maximum levels of customization. This allows seamlessly blending in with the rest of your application, supporting its design code and UX.

Scanners and Detectors​

Barcode and QR-Code Scanner​

  • Detector: ScanbotSdk.detectBarcodesOnImage() - Detect and decode multiple types of barcodes in an image.
  • Ready-to-use UI component: ScanbotSdkUiV2.startBarcodeScanner() - A customizable camera-based view controller to detect QR and barcodes.
  • Classic component: BarcodeScannerCamera - A Widget subclass to display a camera screen for barcode detection.
  • Feature in detail - Detailed description with usage examples.

Document Scanner​

  • Detector: ScanbotSdk.document.detectDocument() - Detects the document contour in an image.
  • Ready-to-use UI component: ScanbotSdkUiV2.startDocumentScanner() - A customizable camera-based view controller for scanning documents.
  • Classic component: DocumentScannerCamera - A Widget subclass to display a camera screen for document scanning.
  • Feature in detail - Detailed description with usage examples.

PDF and TIFF Creation​

  • Create PDF: ScanbotSdk.document.createPDFForDocument() - Converts a collection of document images into a PDF file.
  • Create TIFF: ScanbotSdk.document.createTIFFForDocument() - Converts a collection of document images into a multi-page TIFF file.
  • Feature in detail - Detailed description of PDF creation.
  • Feature in detail - Detailed description of TIFF creation.

Page Operations (Deprecated)​

  • Rotate Page: ScanbotSdk.rotatePageClockwise() - Rotates all images in a page by 90 degrees for the specified number of rotations.
  • Crop and Rotate Page: ScanbotSdk.cropAndRotatePage() - Crops and rotates all images of the given page using a polygon and rotation count.
  • Apply Filters: ScanbotSdk.applyImageFilter() - Applies filters to the final document image of a page.
  • Create Page: ScanbotSdk.createPage() - Creates a page from an image file URI and optionally detects the document.
  • Create Page from Image Bytes: ScanbotSdk.createPageWithImageBytes() - Creates a page using raw image bytes.
  • Refresh Image URIs: ScanbotSdk.refreshImageUris() - Refreshes the image file URIs of the given pages.

Document Management​

  • Create Document: ScanbotSdk.document.createDocument() - Creates a new document from scratch.
  • Add Page: ScanbotSdk.document.addPage() - Adds a new page to a document and returns the updated document.
  • Move Page: ScanbotSdk.document.movePage() - Moves a page within a document and returns the updated document.
  • Modify Page: ScanbotSdk.document.modifyPage() - Updates a page in a document and returns the updated document.
  • Delete Document: ScanbotSdk.document.deleteDocument() - Deletes a document by its ID.
  • Delete All Documents: ScanbotSdk.document.deleteAllDocuments() - Deletes all stored documents.
  • Remove Page: ScanbotSdk.document.removePageFromDocument() - Removes a specific page from a document.
  • Remove All Pages: ScanbotSdk.document.removeAllPages() - Removes all pages from a document.
  • Load Document: ScanbotSdk.document.loadDocument() - Loads a document by its ID.
  • Clone Document: ScanbotSdk.document.cloneDocument() - Clones a document by its ID.
  • Check Document Exists: ScanbotSdk.document.documentExists() - Checks if a document exists by its ID.
  • Get Stored Document IDs: ScanbotSdk.document.storedDocumentIDs() - Retrieves all stored document IDs.

Image Operations​

  • Create TIFF from Images: ScanbotImageOperations.createTIFFFromImages() - Converts a list of images into a multi-page TIFF file.
  • Create PDF from Images: ScanbotImageOperations.createPDFForImages() - Converts a list of images into a PDF file.
  • Extract Images from PDF: ScanbotImageOperations.extractImagesFromPdf() - Extracts individual images from a PDF document.
  • Rotate Image: ScanbotImageOperations.rotateImage() - Rotates an image by a specified angle.
  • Apply Filters to Image: ScanbotImageOperations.applyFiltersOnImage() - Applies one or more filters to an image.

Optical Character Recognition (OCR)​

  • Perform OCR: ScanbotSdk.performOcr() - Performs optical character recognition on document images.
  • Get OCR Configs: ScanbotSdk.getOcrConfigs() - Retrieves the current OCR configurations, such as installed OCR languages.
  • Feature in detail - Detailed description with usage examples.

Quality Analysis​

  • Analyze Document Quality: ScanbotSdk.analyzeQualityOfDocument() - Analyzes the quality of a document image and calculates its text quality.

Storage​

  • Cleanup Storage: ScanbotSdk.cleanupStorage() - Deletes all stored pages and documents from the SDK storage.
  • Delete Page: ScanbotSdk.deletePage() - Deletes a specific page and its associated files.
  • Feature in detail - Detailed description with usage examples.

Storage Encryption​

  • Decrypt Data: ScanbotEncryptionHandler.getDecryptedDataFromFile() - Decrypts files that were saved using the SDK's encryption features.
  • Feature in detail - Detailed description with usage examples.

Examples​

For more details about the RTU-UI Components please check our Example App scanbot-sdk-example-flutter:

Flutter API Docs:​

Want to scan longer than one minute?

Generate a free trial license to test the Scanbot SDK thoroughly.

Get your free Trial License

What do you think of this documentation?

On this page

Scroll to top