FaceImageOptions (LibDocumentVerification API)

All Known Implementing Classes:

BlinkIdCombinedRecognizer
```
public interface FaceImageOptions
```

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String CLASS_NAME

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`setReturnFaceImage(boolean displayFaceImage)`	Sets whether face image from document should be available in `FaceImageResult`.
`boolean`	`shouldReturnFaceImage()`	Returns whether face image will be available in `FaceImageResult`.

- Field Detail
  - CLASS_NAME
```
@NonNull
static final java.lang.String CLASS_NAME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - setReturnFaceImage
```
void setReturnFaceImage(boolean displayFaceImage)
```
    Sets whether face image from document should be available in FaceImageResult. If enabled, get image using FaceImageResult.getFaceImage() By default, this is set to 'false'. IMPORTANT NOTE: If you set MicroblinkSDK.setIntentDataTransferMode(com.microblink.documentverification.intent.IntentDataTransferMode) to IntentDataTransferMode.STANDARD recognizer which contains encoded image cannot be parcelized and passed by Intent extras because of Android limitations on intent extras size. If you are using one of the provided scan activities and expect receiving scan results in Activity.onActivityResult(int, int, android.content.Intent) method use either IntentDataTransferMode.OPTIMISED or IntentDataTransferMode.PERSISTED_OPTIMISED
    
    Parameters:
    
    displayFaceImage - whether face image will be available in FaceImageResult.
  - shouldReturnFaceImage
```
boolean shouldReturnFaceImage()
```
    Returns whether face image will be available in FaceImageResult. By default, this is set to 'false'.
    
    Returns:
    
    whether face image will be available in FaceImageResult.