All Implemented Interfaces:
```
public interface GenericDocumentRecognizer

                    
```
Component to scan image, detect different documents of known types, perform image optimization, cropping and (optionally) fields detection and fields' data recognition

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`GenericDocumentRecognizer.Companion`

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract GenericDocumentRecognitionResult`	`scanBitmap(Bitmap bitmap, Boolean shouldRecognize, Integer orientation)`	Scan the image to detect document and recognize data on it
`abstract GenericDocumentRecognitionResult`	`scanJpeg(ByteArray jpeg, Boolean shouldRecognize, Integer orientation)`	Scan the image to detect document and recognize data on it
`abstract GenericDocumentRecognitionResult`	`scanNv21(ByteArray nv21, Integer width, Integer height, Integer orientation, Rect finderRect, Boolean shouldRecognize)`	Scan the image to detect document and recognize data on it
`abstract Unit`	`clear()`	Clears the result accumulation cache (for live detection)
`abstract Float`	`getAcceptedSharpnessScore()`	Accepted minimal sharpness score.
`abstract Unit`	`setAcceptedSharpnessScore(Float acceptedSharpnessScore)`	Accepted minimal sharpness score.
`abstract List<RootDocumentType>`	`getAcceptedDocumentTypes()`	Accepted document types.
`abstract Unit`	`setAcceptedDocumentTypes(List<RootDocumentType> acceptedDocumentTypes)`	Accepted document types.
`abstract Set<String>`	`getExcludedFieldTypes()`	Set of secure fields which should be excluded from scanning process.
`abstract Unit`	`setExcludedFieldTypes(Set<String> excludedFieldTypes)`	Set of secure fields which should be excluded from scanning process.

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

- Constructor Detail
- Method Detail
  - scanBitmap
```
 abstract GenericDocumentRecognitionResult scanBitmap(Bitmap bitmap, Boolean shouldRecognize, Integer orientation)
```
    Scan the image to detect document and recognize data on it
    
    Parameters:
    
    bitmap - image
    
    shouldRecognize - whether to recognize field and their data.
    
    orientation - image orientation.
  - scanJpeg
```
 abstract GenericDocumentRecognitionResult scanJpeg(ByteArray jpeg, Boolean shouldRecognize, Integer orientation)
```
    Scan the image to detect document and recognize data on it
    
    Parameters:
    
    jpeg - image in form of jpeg-encoded byte array
    
    shouldRecognize - whether to recognize field and their data.
    
    orientation - image orientation.
  - scanNv21
```
 abstract GenericDocumentRecognitionResult scanNv21(ByteArray nv21, Integer width, Integer height, Integer orientation, Rect finderRect, Boolean shouldRecognize)
```
    Scan the image to detect document and recognize data on it
    
    Parameters:
    
    nv21 - image in form of nv21-encoded byte array
    
    width - image width, pixels
    
    height - image height, pixels
    
    orientation - image orientation.
    
    finderRect - if non-null - perform scanning only in given area.
    
    shouldRecognize - whether to recognize field and their data.
  - clear
```
 abstract Unit clear()
```
    Clears the result accumulation cache (for live detection)
  - getAcceptedSharpnessScore
```
 abstract Float getAcceptedSharpnessScore()
```
    Accepted minimal sharpness score. Images with a score less than that will be rejected with GenericDocumentRecognitionResult.RecognitionStatus.ErrorTooBlurry.
    Default is 0
    0 - any image will be accepted. 80 - a good compromise; the recommended setting. 100 - only very sharp images will be accepted.
  - setAcceptedSharpnessScore
```
 abstract Unit setAcceptedSharpnessScore(Float acceptedSharpnessScore)
```
    Accepted minimal sharpness score. Images with a score less than that will be rejected with GenericDocumentRecognitionResult.RecognitionStatus.ErrorTooBlurry.
    Default is 0
    0 - any image will be accepted. 80 - a good compromise; the recommended setting. 100 - only very sharp images will be accepted.
  - getAcceptedDocumentTypes
```
 abstract List<RootDocumentType> getAcceptedDocumentTypes()
```
    Accepted document types. All other document types will be ignored.
    By default - GenericDocumentRecognizer.ACCEPTED_TYPES
  - setAcceptedDocumentTypes
```
 abstract Unit setAcceptedDocumentTypes(List<RootDocumentType> acceptedDocumentTypes)
```
    Accepted document types. All other document types will be ignored.
    By default - GenericDocumentRecognizer.ACCEPTED_TYPES
  - getExcludedFieldTypes
```
 abstract Set<String> getExcludedFieldTypes()
```
    Set of secure fields which should be excluded from scanning process. All other fields will be scanned as usual. Field should be set ONLY as normalized field name. Example: DePassport.NormalizedFieldNames.NATIONALITY or DeIdCardBack.NormalizedFieldNames.HEIGHT
    By default - empty and all fields are scanned
  - setExcludedFieldTypes
```
 abstract Unit setExcludedFieldTypes(Set<String> excludedFieldTypes)
```
    Set of secure fields which should be excluded from scanning process. All other fields will be scanned as usual. Field should be set ONLY as normalized field name. Example: DePassport.NormalizedFieldNames.NATIONALITY or DeIdCardBack.NormalizedFieldNames.HEIGHT
    By default - empty and all fields are scanned

Interface GenericDocumentRecognizer

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

scanBitmap

scanJpeg

scanNv21

clear

getAcceptedSharpnessScore

setAcceptedSharpnessScore

getAcceptedDocumentTypes

setAcceptedDocumentTypes

getExcludedFieldTypes

setExcludedFieldTypes