Class ScanbotSDK

constructor

• new ScanbotSDK(): ScanbotSDK

• Returns ScanbotSDK

Static imageFilters

utils

• get utils(): PublicUtils

• Returns PublicUtils

version

• get version(): string

• Returns string

Static UI

• get UI(): typeof ScanbotSDKUI2

• Returns typeof ScanbotSDKUI2

applyFilter

• applyFilter(imageBuffer, filterType): Promise<ArrayBuffer>

• Parameters

  • imageBuffer: ArrayBuffer

  • filterType: ImageFilter

  Returns Promise<ArrayBuffer>

  Deprecated

  Use the new ImageProcessor API instead (see createImageProcessor).

beginPdf

• beginPdf(options?): Promise<PdfGenerator>

• Parameters

  • Optional options: PdfGenerationOptions

  Returns Promise<PdfGenerator>

beginTiff

• beginTiff(options?): Promise<TiffGenerator>

• Parameters

  • Optional options: TiffGenerationOptions

  Returns Promise<TiffGenerator>

createBarcodeScanner

• createBarcodeScanner(configuration): Promise<IBarcodeScannerHandle>

• Parameters

  • configuration: BarcodeScannerConfiguration

  Returns Promise<IBarcodeScannerHandle>

createDocumentQualityAnalyzer

• createDocumentQualityAnalyzer(config?): Promise<DocumentQualityAnalyzer>

• Parameters

  • Optional config: DocumentQualityAnalyzerConfiguration

  Returns Promise<DocumentQualityAnalyzer>

createDocumentScanner

• createDocumentScanner(configuration): Promise<IDocumentScannerHandle>

• View Components

  Parameters

  • configuration: DocumentScannerConfiguration

  Returns Promise<IDocumentScannerHandle>

createImageProcessor

• createImageProcessor(imageBuffer): Promise<ImageProcessor>

• Parameters

  • imageBuffer: ArrayBuffer

  Returns Promise<ImageProcessor>

createMrzScanner

• createMrzScanner(configuration): Promise<IMrzScannerHandle>

• Parameters

  • configuration: MrzScannerConfiguration

  Returns Promise<IMrzScannerHandle>

createOcrEngine

• createOcrEngine(options?): Promise<OcrEngine>

• Parameters

  • Optional options: {
        mode: string;
    }

    • mode: string

  Returns Promise<OcrEngine>

createSimpleMRZRecognizer

• createSimpleMRZRecognizer(): Promise<SimpleMrzRecognizer>

• Returns Promise<SimpleMrzRecognizer>

createTextDataScanner

• createTextDataScanner(configuration): Promise<ITextDataScannerHandle>

• Parameters

  • configuration: TextDataScannerConfiguration

  Returns Promise<ITextDataScannerHandle>

createVINScanner

• createVINScanner(configuration): Promise<ITextDataScannerHandle>

• Parameters

  • configuration: VINScannerConfiguration

  Returns Promise<ITextDataScannerHandle>

cropAndRotateImageCcw

• cropAndRotateImageCcw(imageBuffer, polygon, rotations): Promise<any>

• Parameters

  • imageBuffer: ArrayBuffer

  • polygon: Polygon

  • rotations: number

  Returns Promise<any>

detectAndCropDocument

• detectAndCropDocument(imageBuffer): Promise<ContourDetectionResult>

• Parameters

  • imageBuffer: ArrayBuffer

  Returns Promise<ContourDetectionResult>

detectBarcodes

• detectBarcodes(base64, engineMode?, barcodeFormats?, returnBarcodeImage?, gs1Handling?): Promise<BarcodeResult>

• Parameters

  • base64: string

  • Optional engineMode: EngineMode

  • Optional barcodeFormats: BarcodeFormat[]

  • Optional returnBarcodeImage: boolean

  • Optional gs1Handling: GS1Handling

  Returns Promise<BarcodeResult>

detectDocument

• detectDocument(imageBuffer, acceptedAngleScore?, acceptedSizeScore?, acceptedBrightnessThreshold?): Promise<ContourDetectionResult>

• Parameters

  • imageBuffer: ArrayBuffer

  • Optional acceptedAngleScore: number

  • Optional acceptedSizeScore: number

  • Optional acceptedBrightnessThreshold: number

  Returns Promise<ContourDetectionResult>

getLicenseInfo

• getLicenseInfo(): Promise<LicenseInfo>

• Misc. Features

  Returns Promise<LicenseInfo>

openCroppingView

• openCroppingView(configuration): Promise<ICroppingViewHandle>

• Parameters

  • configuration: CroppingViewConfiguration

  Returns Promise<ICroppingViewHandle>

release

• release(object, source?): Promise<void>

• Parameters

  • object: any

  • Optional source: string

  Returns Promise<void>

rotateImageCcw

• rotateImageCcw(imageBuffer, rotations): Promise<ArrayBuffer>

• Parameters

  • imageBuffer: ArrayBuffer

  • rotations: number

  Returns Promise<ArrayBuffer>

toDataUrl

• toDataUrl(imageBuffer): Promise<string>

• Image Operations

  Parameters

  • imageBuffer: ArrayBuffer

  Returns Promise<string>

Static initialize

• initialize(options): Promise<ScanbotSDK>

• Parameters

  • options: InitializationOptions

  Returns Promise<ScanbotSDK>