All Implemented Interfaces:: android.os.Parcelable


public final class DocumentScannerOutputSettings
 implements Parcelable

Configuration of the output settings.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private Integer`	`pagesScanLimit`
`private Integer`	`documentImageSizeLimit`
`private DocumentAnalysisMode`	`documentAnalysisMode`
`private ParametricFilter`	`defaultFilter`

Constructor Summary

Constructors
Constructor	Description
`DocumentScannerOutputSettings(Map<String, Object> source)`
`DocumentScannerOutputSettings(JSONObject json)`
`DocumentScannerOutputSettings(Integer pagesScanLimit, Integer documentImageSizeLimit, DocumentAnalysisMode documentAnalysisMode, ParametricFilter defaultFilter)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Integer`	`getPagesScanLimit()`	The limit of the number of pages that can be scanned.
`final Unit`	`setPagesScanLimit(Integer pagesScanLimit)`	The limit of the number of pages that can be scanned.
`final Integer`	`getDocumentImageSizeLimit()`	The limit of the size of the cropped document images.
`final Unit`	`setDocumentImageSizeLimit(Integer documentImageSizeLimit)`	The limit of the size of the cropped document images.
`final DocumentAnalysisMode`	`getDocumentAnalysisMode()`	Determines if the quality analysis for the acknowledgement mode will run on the filtered or the unfiltered image.
`final Unit`	`setDocumentAnalysisMode(DocumentAnalysisMode documentAnalysisMode)`	Determines if the quality analysis for the acknowledgement mode will run on the filtered or the unfiltered image.
`final ParametricFilter`	`getDefaultFilter()`	Determines the image filter to apply by default.
`final Unit`	`setDefaultFilter(ParametricFilter defaultFilter)`	Determines the image filter to apply by default.
`final JSONObject`	`toJson(ToJsonConfiguration config)`
`final DocumentScannerOutputSettings`	`clone()`
`final static DocumentScannerOutputSettings`	`default()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DocumentScannerOutputSettings
```
DocumentScannerOutputSettings(Map<String, Object> source)
```
  - DocumentScannerOutputSettings
```
DocumentScannerOutputSettings(JSONObject json)
```
  - DocumentScannerOutputSettings
```
DocumentScannerOutputSettings(Integer pagesScanLimit, Integer documentImageSizeLimit, DocumentAnalysisMode documentAnalysisMode, ParametricFilter defaultFilter)
```
- Method Detail
  - getPagesScanLimit
```
 final Integer getPagesScanLimit()
```
    The limit of the number of pages that can be scanned. Default is 0 (no limit).
    Default is 0
  - setPagesScanLimit
```
 final Unit setPagesScanLimit(Integer pagesScanLimit)
```
    The limit of the number of pages that can be scanned. Default is 0 (no limit).
    Default is 0
  - getDocumentImageSizeLimit
```
 final Integer getDocumentImageSizeLimit()
```
    The limit of the size of the cropped document images. If one of the dimensions of the cropped image is larger than the limit, the image is downscaled so that its longer dimension matches the limit. The default is 0 (no limit).
    Default is 0
  - setDocumentImageSizeLimit
```
 final Unit setDocumentImageSizeLimit(Integer documentImageSizeLimit)
```
    The limit of the size of the cropped document images. If one of the dimensions of the cropped image is larger than the limit, the image is downscaled so that its longer dimension matches the limit. The default is 0 (no limit).
    Default is 0
  - getDocumentAnalysisMode
```
 final DocumentAnalysisMode getDocumentAnalysisMode()
```
    Determines if the quality analysis for the acknowledgement mode will run on the filtered or the unfiltered image.
    Default is UNFILTERED_DOCUMENT
  - setDocumentAnalysisMode
```
 final Unit setDocumentAnalysisMode(DocumentAnalysisMode documentAnalysisMode)
```
    Determines if the quality analysis for the acknowledgement mode will run on the filtered or the unfiltered image.
    Default is UNFILTERED_DOCUMENT
  - getDefaultFilter
```
 final ParametricFilter getDefaultFilter()
```
    Determines the image filter to apply by default.
  - setDefaultFilter
```
 final Unit setDefaultFilter(ParametricFilter defaultFilter)
```
    Determines the image filter to apply by default.
  - toJson
```
 final JSONObject toJson(ToJsonConfiguration config)
```
  - clone
```
 final DocumentScannerOutputSettings clone()
```
  - default
```
 final static DocumentScannerOutputSettings default()
```

Class DocumentScannerOutputSettings

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentScannerOutputSettings

DocumentScannerOutputSettings

DocumentScannerOutputSettings

Method Detail

getPagesScanLimit

setPagesScanLimit

getDocumentImageSizeLimit

setDocumentImageSizeLimit

getDocumentAnalysisMode

setDocumentAnalysisMode

getDefaultFilter

setDefaultFilter

toJson

clone

default