# ScanbotSdk class

Main class to access the Scanbot SDK functionalities.

## Constructors

ScanbotSdk.new()

## 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

document ↔ ScanbotDocument
  Instance for handling document-related operations.
  getter/setter pair
imageOperations ↔ ScanbotImageOperations
  Instance for handling general image operations.
  getter/setter pair
recognizeOperations ↔ ScanbotImageRecognitionOperations
  Instance for handling image recognition operations like MRZ, medical certificate, etc.
  getter/setter pair

## Static Methods

analyzeDocumentQuality(String imageFileUri, DocumentQualityAnalyzerConfiguration configuration) → Future<DocumentQualityAnalyzerResult>
  Analyzes a still image located at `imageFileUri` to detect document quality.
analyzeQualityOfDocument(Page page, {Size? analyzerImageSizeLimit}) → Future<DocumentQualityAnalyzerResult>
  Analyzes the quality of a document in the given `page`.
applyImageFilter(Page page, List<ParametricFilter> filters) → Future<Page>
  Applies a list of `filters` to the DOCUMENT image of the given `page`.
cleanupStorage() → Future
  Cleans up the SDK's internal storage folder.
createPage(Uri originalImageFileUri, bool shouldDetectDocument, {Size? originalImageSizeLimit, Size? documentImageSizeLimit}) → Future<Page>
  Creates a new Page from an image file located at `originalImageFileUri`.
createPageWithImageBytes(Uint8List imageBytes, bool shouldDetectDocument, {Size? originalImageSizeLimit, Size? documentImageSizeLimit}) → Future<Page>
  Creates a new Page from image `imageBytes`.
createPdf(List<Page> pages, PdfConfiguration pdfConfiguration, [OcrOptions? ocrConfiguration = null]) → Future<Uri>
  Creates a multi-page PDF document from the given `pages` and stores it as a file.
createTiff(List<Page> pages, TiffGeneratorParameters options) → Future<Uri>
  Creates a multi-page TIFF image from the given `pages`.
cropAndRotatePage(Page page, List<PolygonPoint> polygon, int rotationsCount) → Future<Page>
  Crops and rotates the images of the given `page` according to `polygon` points.
deletePage(Page page) → Future<void>
  Deletes the given `page` and all related files from the SDK's internal storage.
detectBarcodesOnImage(Uri imageFileUri, BarcodeScannerConfiguration barcodeScannerConfiguration) → Future<BarcodeScannerResult>
  Detects barcodes in an image specified by `imageFileUri`.
detectDocument(Page page) → Future<Page>
  Performs automatic document detection on the original image of the given `page`.
getLicenseStatus() → Future<SdkLicenseStatus>
  Returns the current license status of the Scanbot SDK.
getOcrConfigs() → Future<SdkOcrConfig>
  Retrieves the current OCR configuration including installed languages.
initScanbotSdk(ScanbotSdkConfig config) → Future<SdkLicenseStatus>
  Initializes the Scanbot SDK with the given `config`.
makeSnapshot() → Future<ImageRefPoolSnapshot?>
  Takes a snapshot of the current ImageRefPool state.
performOcr(List<Page> pages, OcrOptions options) → Future<PagesOcrResult>
  Performs OCR on the DOCUMENT images of the provided `pages`.
performOCR(PerformOCRArguments args) → Future<PerformOCRResult>
  Performs OCR on the given input `args`.
refreshImageUris(List<Page> pages) → Future<List<Page>>
  Refreshes the image URIs of the given `pages`.
rotatePageClockwise(Page page, int rotationsCount) → Future<Page>
  Rotates all images of the given `page` clockwise.

## Constants

channel → const MethodChannel
  Internal method channel for communication with native Scanbot SDK.