GmsDocumentScannerOptions

  • GmsDocumentScannerOptions provides options for the GmsDocumentScanner.

  • Nested classes define the Builder, CaptureMode, ResultFormat, and ScannerMode for GmsDocumentScannerOptions.

  • Constants are provided for automatic and manual capture modes, JPEG and PDF result formats, and base, base with filter, and full scanner modes.

  • A default GmsDocumentScannerOptions instance is available.

  • Public methods include equals and hashCode for object comparison and hashing.
public class GmsDocumentScannerOptions extends Object

Options for GmsDocumentScanner.

Nested Class Summary

class GmsDocumentScannerOptions.Builder Builder for GmsDocumentScannerOptions. 
@interface GmsDocumentScannerOptions.CaptureMode Scanner camera viewfinder capture mode. 
@interface GmsDocumentScannerOptions.ResultFormat Result format for the scanner. 
@interface GmsDocumentScannerOptions.ScannerMode Scanner mode which determines what features are enabled. 

Constant Summary

int CAPTURE_MODE_AUTO GmsDocumentScannerOptions.CaptureMode for automatically triggering capture in scanner camera viewfinder.
int CAPTURE_MODE_MANUAL GmsDocumentScannerOptions.CaptureMode for manually triggering capture in scanner camera viewfinder.
int RESULT_FORMAT_JPEG
int RESULT_FORMAT_PDF
int SCANNER_MODE_BASE 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 GmsDocumentScannerOptions.ScannerMode that only enables the basic features (see #SCANNER_MODE_BASE) plus filters.
int SCANNER_MODE_FULL GmsDocumentScannerOptions.ScannerMode with the full feature set, for example, document image cleaning.

Field Summary

public static final GmsDocumentScannerOptions DEFAULT_OPTIONS The default GmsDocumentScannerOptions.

Public Method Summary

boolean
equals(Object o)
Indicates whether some other object is "equal to" this one.
int
hashCode()
Returns a hash code value for the object.

Inherited Method Summary

Constants

public static final int CAPTURE_MODE_AUTO

GmsDocumentScannerOptions.CaptureMode for automatically triggering capture in scanner camera viewfinder.

Constant Value: 1

public static final int CAPTURE_MODE_MANUAL

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

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

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

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 GmsDocumentScannerOptions.

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

Public Methods

public boolean equals (Object o)

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

public int hashCode ()

Returns a hash code value for the object.