Class DocumentScannerConfiguration

Configuration for the document scanner.

Constructors

constructor

Properties

engineMode parameters partiallyVisibleDocumentConfiguration processingMode

Constructors

constructor

Properties

engineMode

engineMode: DocumentScannerEngineMode = "ML"

The engine to use for document scanning.

Default is ML

parameters

parameters: DocumentScannerParameters = ...

Initial parameters for the document scanner.

partiallyVisibleDocumentConfiguration

partiallyVisibleDocumentConfiguration: PartiallyVisibleDocumentConfiguration = ...

Configuration for handling partially visible documents.

Has an effect only:

  • with ML engine mode
  • when configured with allowPartiallyVisibleDocuments set to true.

processingMode

processingMode: ProcessingMode = "AUTO"

In live mode, the document scanner will return only the best document contour. In single-shot mode it will return additional document contours, suitable for use in the cropping screen.

Default is AUTO

Settings

Member Visibility

Theme

On This Page

constructorengineModeparameterspartiallyVisibleDocumentConfigurationprocessingMode