Package io.scanbot.sdk.documentscanner

Class DocumentScannerConfiguration

java.lang.Object

io.scanbot.sdk.documentscanner.DocumentScannerConfiguration

public class DocumentScannerConfiguration
extends Object

Configuration for the document scanner.

Constructor Summary

Constructors

Constructor	Description
DocumentScannerConfiguration()	Constructs DocumentScannerConfiguration with default parameters.
DocumentScannerConfiguration(DocumentScannerEngineMode engineMode, ProcessingMode processingMode, DocumentScannerParameters parameters, PartiallyVisibleDocumentConfiguration partiallyVisibleDocumentConfiguration)	Constructs DocumentScannerConfiguration with the given params.

Method Summary

Modifier and Type	Method	Description
DocumentScannerEngineMode	getEngineMode()	Getter for engineMode field.
DocumentScannerParameters	getParameters()	Getter for parameters field.
PartiallyVisibleDocumentConfiguration	getPartiallyVisibleDocumentConfiguration()	Getter for partiallyVisibleDocumentConfiguration field.
ProcessingMode	getProcessingMode()	Getter for processingMode field.
void	setEngineMode(DocumentScannerEngineMode engineMode)	Setter for engineMode field.
void	setParameters(DocumentScannerParameters parameters)	Setter for parameters field.
void	setPartiallyVisibleDocumentConfiguration(PartiallyVisibleDocumentConfiguration partiallyVisibleDocumentConfiguration)	Setter for partiallyVisibleDocumentConfiguration field.
void	setProcessingMode(ProcessingMode processingMode)	Setter for processingMode field.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DocumentScannerConfiguration

public DocumentScannerConfiguration(DocumentScannerEngineMode engineMode,
 ProcessingMode processingMode,
 DocumentScannerParameters parameters,
 PartiallyVisibleDocumentConfiguration partiallyVisibleDocumentConfiguration)

Constructs DocumentScannerConfiguration with the given params.

Parameters:

engineMode - The engine to use for document scanning. Default is `ML`.

processingMode - 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`.

parameters - Initial parameters for the document scanner.

partiallyVisibleDocumentConfiguration - Configuration for handling partially visible documents. Has an effect only: - with ML engine mode - when configured with allowPartiallyVisibleDocuments set to true.

DocumentScannerConfiguration

public DocumentScannerConfiguration()

Constructs DocumentScannerConfiguration with default parameters.

Method Details

getEngineMode

public DocumentScannerEngineMode getEngineMode()

Getter for engineMode field. See constructor documentation for more information about the field.

Returns:

engineMode

setEngineMode

public void setEngineMode(DocumentScannerEngineMode engineMode)

Setter for engineMode field. See constructor documentation for more information about the field.

Parameters:

engineMode - Value to set.

getProcessingMode

public ProcessingMode getProcessingMode()

Getter for processingMode field. See constructor documentation for more information about the field.

Returns:

processingMode

setProcessingMode

public void setProcessingMode(ProcessingMode processingMode)

Setter for processingMode field. See constructor documentation for more information about the field.

Parameters:

processingMode - Value to set.

getParameters

public DocumentScannerParameters getParameters()

Getter for parameters field. See constructor documentation for more information about the field.

Returns:

parameters

setParameters

public void setParameters(DocumentScannerParameters parameters)

Setter for parameters field. See constructor documentation for more information about the field.

Parameters:

parameters - Value to set.

getPartiallyVisibleDocumentConfiguration

public PartiallyVisibleDocumentConfiguration getPartiallyVisibleDocumentConfiguration()

Getter for partiallyVisibleDocumentConfiguration field. See constructor documentation for more information about the field.

Returns:

partiallyVisibleDocumentConfiguration

setPartiallyVisibleDocumentConfiguration

public void setPartiallyVisibleDocumentConfiguration(PartiallyVisibleDocumentConfiguration partiallyVisibleDocumentConfiguration)

Setter for partiallyVisibleDocumentConfiguration field. See constructor documentation for more information about the field.

Parameters:

partiallyVisibleDocumentConfiguration - Value to set.