# GmsDocumentScannerOptions

public class **GmsDocumentScannerOptions** extends [Object](https://developer.android.com/reference/java/lang/Object.html)  
Options for `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScanner`.

### Nested Class Summary

|---|---|---|---|
| class | [GmsDocumentScannerOptions.Builder](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.Builder) || Builder for `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions`. |
| @interface | [GmsDocumentScannerOptions.CaptureMode](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.CaptureMode) || Scanner camera viewfinder capture mode. |
| @interface | [GmsDocumentScannerOptions.ResultFormat](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.ResultFormat) || Result format for the scanner. |
| @interface | [GmsDocumentScannerOptions.ScannerMode](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.ScannerMode) || Scanner mode which determines what features are enabled. |

### Constant Summary

|---|---|---|
| int | [CAPTURE_MODE_AUTO](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions#CAPTURE_MODE_AUTO) | `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.CaptureMode` for automatically triggering capture in scanner camera viewfinder. |
| int | [CAPTURE_MODE_MANUAL](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions#CAPTURE_MODE_MANUAL) | `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.CaptureMode` for manually triggering capture in scanner camera viewfinder. |
| int | [RESULT_FORMAT_JPEG](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions#RESULT_FORMAT_JPEG) |   |
| int | [RESULT_FORMAT_PDF](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions#RESULT_FORMAT_PDF) |   |
| int | [SCANNER_MODE_BASE](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions#SCANNER_MODE_BASE) | `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.ScannerMode` that only enables the basic features, for example, scanning with camera, document auto rotation, crop and rotation, adding or removing or reordering pages, saving as JPEGs or PDF. |
| int | [SCANNER_MODE_BASE_WITH_FILTER](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions#SCANNER_MODE_BASE_WITH_FILTER) | `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.ScannerMode` that only enables the basic features (see `#SCANNER_MODE_BASE`) plus filters. |
| int | [SCANNER_MODE_FULL](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions#SCANNER_MODE_FULL) | `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.ScannerMode` with the full feature set, for example, document image cleaning. |

### Field Summary

|---|---|---|
| public static final [GmsDocumentScannerOptions](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions) | [DEFAULT_OPTIONS](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions#DEFAULT_OPTIONS) | The default `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions`. |

### Public Method Summary

|---|---|
| boolean | [equals](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions#equals(java.lang.Object))([Object](https://developer.android.com/reference/java/lang/Object.html) o) Indicates whether some other object is "equal to" this one. |
| int | [hashCode](https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions#hashCode())() Returns a hash code value for the object. |

### Inherited Method Summary

From class java.lang.Object

|---|---|
| [Object](https://developer.android.com/reference/java/lang/Object.html) | clone() |
| boolean | equals([Object](https://developer.android.com/reference/java/lang/Object.html) arg0) |
| void | finalize() |
| final [Class](https://developer.android.com/reference/java/lang/Class.html)\<?\> | getClass() |
| int | hashCode() |
| final void | notify() |
| final void | notifyAll() |
| [String](https://developer.android.com/reference/java/lang/String.html) | toString() |
| final void | wait(long arg0, int arg1) |
| final void | wait(long arg0) |
| final void | wait() |

## Constants

#### public static final int
**CAPTURE_MODE_AUTO**

`https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.CaptureMode` for automatically triggering capture
in scanner camera viewfinder.
Constant Value: 1

#### public static final int
**CAPTURE_MODE_MANUAL**

`https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.CaptureMode` for manually triggering capture in
scanner camera viewfinder.
Constant Value: 2

#### public static final int
**RESULT_FORMAT_JPEG**

Constant Value: 101

#### public static final int
**RESULT_FORMAT_PDF**

Constant Value: 102

#### public static final int
**SCANNER_MODE_BASE**

`https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.ScannerMode` that only enables the basic features,
for example, scanning with camera, document auto rotation, crop and rotation, adding or
removing or reordering pages, saving as JPEGs or PDF.

In the future, major new features delivered along with Google Play services updates
will be disabled by default.
Constant Value: 3

#### public static final int
**SCANNER_MODE_BASE_WITH_FILTER**

`https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.ScannerMode` that only enables the basic features
(see `#SCANNER_MODE_BASE`) plus filters.

In the future, major new features delivered along with Google Play services updates
will be disabled by default.
Constant Value: 2

#### public static final int
**SCANNER_MODE_FULL**

`https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions.ScannerMode` with the full feature set, for
example, document image cleaning.

In the future, major new features delivered along with Google Play services updates
will be automatically enabled.
Constant Value: 1

## Fields

#### public static final GmsDocumentScannerOptions **DEFAULT_OPTIONS**

The default `https://developers.google.com/android/reference/com/google/mlkit/vision/documentscanner/GmsDocumentScannerOptions`.

This is equivalent to `new
GmsDocumentScannerOptions.Builder().build()`.

## Public Methods

#### public boolean **equals** ([Object](https://developer.android.com/reference/java/lang/Object.html) o)

Indicates whether some other object is "equal to" this one.

#### public int **hashCode** ()

Returns a hash code value for the object.