Index (gssdk-scanflow API)

A B C D E F G H I J L M N O P R S T V
All Classes All Packages

A

A4 - com.geniusscansdk.scanflow.ScanConfiguration.PdfPageSize: A4 page size
ALL - Static variable in enum com.geniusscansdk.scanflow.ScanConfiguration.Action
ALL - Static variable in enum com.geniusscansdk.scanflow.ScanConfiguration.OcrOutputFormat
AUTO - com.geniusscansdk.scanflow.ScanConfiguration.FlashMode

B

backgroundColor - Variable in class com.geniusscansdk.scanflow.ScanConfiguration: UI background color.
BLACK_AND_WHITE - com.geniusscansdk.scanflow.ScanConfiguration.Filter: Filter used to enhance documents with white background and black foreground
BorderDetectionFragment - Class in com.geniusscansdk.scanflow
BorderDetectionFragment() - Constructor for class com.geniusscansdk.scanflow.BorderDetectionFragment

C

CAMERA - com.geniusscansdk.scanflow.ScanConfiguration.Source: A camera screen will be displayed to capture an image.
CameraFragment - Class in com.geniusscansdk.scanflow
CameraFragment() - Constructor for class com.geniusscansdk.scanflow.CameraFragment
code - Variable in enum com.geniusscansdk.scanflow.ScanConfiguration.FlashMode
COLOR - com.geniusscansdk.scanflow.ScanConfiguration.Filter: Filter used to enhance documents with white background and color foreground
com.geniusscansdk.scanflow - package com.geniusscansdk.scanflow
CORRECT_DISTORTION - com.geniusscansdk.scanflow.ScanConfiguration.Action: Correct the distortion of the image (due to folding...)
createScanFlowIntent(Context, ScanConfiguration) - Static method in class com.geniusscansdk.scanflow.ScanFlow: See ScanFlow.scanWithConfiguration(Activity, ScanConfiguration)

D

defaultFilter - Variable in class com.geniusscansdk.scanflow.ScanConfiguration: Force the use of a specific post processing filter.
defaultFlashMode - Variable in class com.geniusscansdk.scanflow.ScanConfiguration: The default flash mode used when capturing a page.

E

EDIT_FILTER - com.geniusscansdk.scanflow.ScanConfiguration.Action: Edit the post processing filter applied to the image
enhancedImageFile - Variable in class com.geniusscansdk.scanflow.ScanResult.Scan: The image after the processing operations (perspective correction, filter…).
errorCode - Variable in class com.geniusscansdk.scanflow.PromiseResult
errorMessage - Variable in class com.geniusscansdk.scanflow.PromiseResult

F

finishWithError(Exception) - Method in class com.geniusscansdk.scanflow.ScanActivity
FIT - com.geniusscansdk.scanflow.ScanConfiguration.PdfPageSize: PDF page with a width of 8.27 inch (A4 width) and fitting height.
flashButtonHidden - Variable in class com.geniusscansdk.scanflow.ScanConfiguration: The visibility of the flash button.
foregroundColor - Variable in class com.geniusscansdk.scanflow.ScanConfiguration: UI foreground color (text and icons).
fromCodes(List<String>) - Static method in enum com.geniusscansdk.scanflow.ScanConfiguration.Action
fromCodes(List<String>) - Static method in enum com.geniusscansdk.scanflow.ScanConfiguration.OcrOutputFormat

G

GALLERY - com.geniusscansdk.scanflow.ScanConfiguration.Source: Open photo picker, the chosen picture is provided as an input to the scan flow.
generateDocument(Context, Map<String, Object>, Map<String, Object>) - Static method in class com.geniusscansdk.scanflow.PluginBridge
getCameraCallback() - Method in class com.geniusscansdk.scanflow.CameraFragment
getPromiseResultFromActivityResult(Context, int, int, Intent) - Static method in class com.geniusscansdk.scanflow.PluginBridge: Convert the intent response into a PromiseResult.
getScanResultFromActivityResult(Intent) - Static method in class com.geniusscansdk.scanflow.ScanFlow: Extract the result of the scan flow if it was successful or throws an error if something went wrong.

H

highlightColor - Variable in class com.geniusscansdk.scanflow.ScanConfiguration: Color of the document detection overlay.
HOCR - com.geniusscansdk.scanflow.ScanConfiguration.OcrOutputFormat: Output OCR result in HOCR format
hocrTextLayout - Variable in class com.geniusscansdk.scanflow.ScanResult.OcrResult: The recognized text in hOCR format (with position, style)

I

iconResId - Variable in enum com.geniusscansdk.scanflow.ScanConfiguration.FlashMode
IMAGE - com.geniusscansdk.scanflow.ScanConfiguration.Source: An image is provided as an input to the scan flow.
init(Context, String) - Static method in class com.geniusscansdk.scanflow.ScanFlow: Initialize the SDK with a license key.
internalMode - Variable in enum com.geniusscansdk.scanflow.ScanConfiguration.FlashMode
isError - Variable in class com.geniusscansdk.scanflow.PromiseResult

J

jpegQuality - Variable in class com.geniusscansdk.scanflow.ScanConfiguration: JPEG quality used to compress captured images.

L

languages - Variable in class com.geniusscansdk.scanflow.ScanConfiguration.OcrConfiguration: The language codes for which to run text recognition.
languagesDirectory - Variable in class com.geniusscansdk.scanflow.ScanConfiguration.OcrConfiguration: Folder containing the language files used for text recognition.
LETTER - com.geniusscansdk.scanflow.ScanConfiguration.PdfPageSize: Letter page size

M

MONOCHROME - com.geniusscansdk.scanflow.ScanConfiguration.Filter: Pure black and white, resulting in smaller files
multiPage - Variable in class com.geniusscansdk.scanflow.ScanConfiguration: Multipage mode.
multiPageDocument - Variable in class com.geniusscansdk.scanflow.ScanResult: Document containing the pages that were scanned during the scan flow.
multiPageFormat - Variable in class com.geniusscansdk.scanflow.ScanConfiguration: Format of the document created with all the captured pages.

N

newInstance(Page, ScanConfiguration) - Static method in class com.geniusscansdk.scanflow.PostProcessingFragment
newInstance(Page, ScanConfiguration, Fragment) - Static method in class com.geniusscansdk.scanflow.BorderDetectionFragment
newInstance(ScanConfiguration) - Static method in class com.geniusscansdk.scanflow.CameraFragment
NONE - com.geniusscansdk.scanflow.ScanConfiguration.Filter: No filter is applied
NONE - com.geniusscansdk.scanflow.ScanConfiguration.MultiPageFormat

O

ocrConfiguration - Variable in class com.geniusscansdk.scanflow.ScanConfiguration: Configuration of the text recognition.
OcrConfiguration() - Constructor for class com.geniusscansdk.scanflow.ScanConfiguration.OcrConfiguration
ocrResult - Variable in class com.geniusscansdk.scanflow.ScanResult.Scan: Result of text recognition for this captured image.
OcrResult(String, String) - Constructor for class com.geniusscansdk.scanflow.ScanResult.OcrResult
OFF - com.geniusscansdk.scanflow.ScanConfiguration.FlashMode
ON - com.geniusscansdk.scanflow.ScanConfiguration.FlashMode
onActivityResult(int, int, Intent) - Method in class com.geniusscansdk.scanflow.PostProcessingFragment
onBackPressed() - Method in class com.geniusscansdk.scanflow.ScanActivity
onCreate(Bundle) - Method in class com.geniusscansdk.scanflow.BorderDetectionFragment
onCreate(Bundle) - Method in class com.geniusscansdk.scanflow.CameraFragment
onCreate(Bundle) - Method in class com.geniusscansdk.scanflow.PostProcessingFragment
onCreate(Bundle) - Method in class com.geniusscansdk.scanflow.ScanActivity
onCreateView(LayoutInflater, ViewGroup, Bundle) - Method in class com.geniusscansdk.scanflow.BorderDetectionFragment
onCreateView(LayoutInflater, ViewGroup, Bundle) - Method in class com.geniusscansdk.scanflow.CameraFragment
onCreateView(LayoutInflater, ViewGroup, Bundle) - Method in class com.geniusscansdk.scanflow.PostProcessingFragment
onDestroy() - Method in class com.geniusscansdk.scanflow.ScanActivity
onLayout(boolean, int, int, int, int) - Method in class com.geniusscansdk.scanflow.PreviewRootLayout
onMeasure(int, int) - Method in class com.geniusscansdk.scanflow.PreviewRootLayout
onPause() - Method in class com.geniusscansdk.scanflow.CameraFragment
onRequestPermissionsResult(int, String[], int[]) - Method in class com.geniusscansdk.scanflow.CameraFragment
onResume() - Method in class com.geniusscansdk.scanflow.BorderDetectionFragment
onResume() - Method in class com.geniusscansdk.scanflow.CameraFragment
onResume() - Method in class com.geniusscansdk.scanflow.PostProcessingFragment
onSaveInstanceState(Bundle) - Method in class com.geniusscansdk.scanflow.ScanActivity
originalImageFile - Variable in class com.geniusscansdk.scanflow.ScanResult.Scan: The original image that was captured by the camera.
outputFormats - Variable in class com.geniusscansdk.scanflow.ScanConfiguration.OcrConfiguration: The formats in which the OCR result is made available in the ScanFlow result.

P

PDF - com.geniusscansdk.scanflow.ScanConfiguration.MultiPageFormat
pdfFile - Variable in class com.geniusscansdk.scanflow.ScanResult: Deprecated.
Replaced by ScanResult.multiPageDocument
pdfFontFile - Variable in class com.geniusscansdk.scanflow.ScanConfiguration: Custom font file used during the PDF generation to embed an invisible text layer.
pdfMaxScanDimension - Variable in class com.geniusscansdk.scanflow.ScanConfiguration: Max scan dimension in pixels when generating the PDF file.
pdfPageSize - Variable in class com.geniusscansdk.scanflow.ScanConfiguration: Determine the size of the pages when generating the PDF.
PHOTO - com.geniusscansdk.scanflow.ScanConfiguration.Filter: Filter used to enhance photos, magazine covers...
PluginBridge - Class in com.geniusscansdk.scanflow: This class contains static methods that should be used to interface with plugins (Cordova, React Native...).
PluginBridge() - Constructor for class com.geniusscansdk.scanflow.PluginBridge
postProcessingActions - Variable in class com.geniusscansdk.scanflow.ScanConfiguration: Select which actions are displayed in the post processing screen Default is everything.
PostProcessingFragment - Class in com.geniusscansdk.scanflow
PostProcessingFragment() - Constructor for class com.geniusscansdk.scanflow.PostProcessingFragment
PreviewRootLayout - Class in com.geniusscansdk.scanflow: Custom implementation of LinearLayout used as the root view of the Camera Preview screen.
PreviewRootLayout(Context, AttributeSet) - Constructor for class com.geniusscansdk.scanflow.PreviewRootLayout
PromiseResult - Class in com.geniusscansdk.scanflow

R

RAW_TEXT - com.geniusscansdk.scanflow.ScanConfiguration.OcrOutputFormat: Output OCR result as raw text
reject(String, String) - Static method in class com.geniusscansdk.scanflow.PromiseResult
REQUEST_CODE - Static variable in class com.geniusscansdk.scanflow.BorderDetectionFragment
resolve() - Static method in class com.geniusscansdk.scanflow.PromiseResult
resolve(HashMap<String, Object>) - Static method in class com.geniusscansdk.scanflow.PromiseResult
result - Variable in class com.geniusscansdk.scanflow.PromiseResult
ROTATE - com.geniusscansdk.scanflow.ScanConfiguration.Action: Rotate image

S

Scan(File, File, ScanResult.OcrResult) - Constructor for class com.geniusscansdk.scanflow.ScanResult.Scan
SCAN_REQUEST - Static variable in class com.geniusscansdk.scanflow.ScanFlow
ScanActivity - Class in com.geniusscansdk.scanflow
ScanActivity() - Constructor for class com.geniusscansdk.scanflow.ScanActivity
ScanConfiguration - Class in com.geniusscansdk.scanflow: Options allowing to customize the scan flow
ScanConfiguration() - Constructor for class com.geniusscansdk.scanflow.ScanConfiguration
ScanConfiguration.Action - Enum in com.geniusscansdk.scanflow: Actions displayed on the post processing screen
ScanConfiguration.Filter - Enum in com.geniusscansdk.scanflow: The post processing filter to apply to the image.
ScanConfiguration.FlashMode - Enum in com.geniusscansdk.scanflow
ScanConfiguration.MultiPageFormat - Enum in com.geniusscansdk.scanflow
ScanConfiguration.OcrConfiguration - Class in com.geniusscansdk.scanflow
ScanConfiguration.OcrOutputFormat - Enum in com.geniusscansdk.scanflow: The various formats into which the OCR result can be made available.
ScanConfiguration.PdfPageSize - Enum in com.geniusscansdk.scanflow: Physical size of pages in the generated PDF file
ScanConfiguration.Source - Enum in com.geniusscansdk.scanflow: The source of the scan flow.
ScanFlow - Class in com.geniusscansdk.scanflow
ScanFlow() - Constructor for class com.geniusscansdk.scanflow.ScanFlow
ScanResult - Class in com.geniusscansdk.scanflow: Result of the scan flow
ScanResult() - Constructor for class com.geniusscansdk.scanflow.ScanResult
ScanResult.OcrResult - Class in com.geniusscansdk.scanflow
ScanResult.Scan - Class in com.geniusscansdk.scanflow: A single page that was scanned during the scan flow.
scans - Variable in class com.geniusscansdk.scanflow.ScanResult: List of pages that were scanned during the scan flow.
scanWithConfiguration(Activity, ScanConfiguration) - Static method in class com.geniusscansdk.scanflow.ScanFlow: Start a scan flow to capture several pages and process them.
scanWithConfiguration(Activity, Map<String, Object>) - Static method in class com.geniusscansdk.scanflow.PluginBridge: See ScanFlow.scanWithConfiguration(Activity, ScanConfiguration)
setLicenseKey(Context, String) - Static method in class com.geniusscansdk.scanflow.PluginBridge: Initialize the SDK with a license key.
setQuadrangleToFullImage() - Method in class com.geniusscansdk.scanflow.BorderDetectionFragment
source - Variable in class com.geniusscansdk.scanflow.ScanConfiguration: The source for the scanned documents (camera, image...).
sourceImage - Variable in class com.geniusscansdk.scanflow.ScanConfiguration: The source image if ScanConfiguration.source is ScanConfiguration.Source.IMAGE.

T

text - Variable in class com.geniusscansdk.scanflow.ScanResult.OcrResult: Raw text recognized in the image
TEXT_LAYER_IN_PDF - com.geniusscansdk.scanflow.ScanConfiguration.OcrOutputFormat: Add OCR result as a text layer in the generated PDF file (if any)
TIFF - com.geniusscansdk.scanflow.ScanConfiguration.MultiPageFormat
toFilterType() - Method in enum com.geniusscansdk.scanflow.ScanConfiguration.Filter
toPDFSize() - Method in enum com.geniusscansdk.scanflow.ScanConfiguration.PdfPageSize

V

valueOf(String) - Static method in enum com.geniusscansdk.scanflow.ScanConfiguration.Action: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.geniusscansdk.scanflow.ScanConfiguration.Filter: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.geniusscansdk.scanflow.ScanConfiguration.FlashMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.geniusscansdk.scanflow.ScanConfiguration.MultiPageFormat: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.geniusscansdk.scanflow.ScanConfiguration.OcrOutputFormat: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.geniusscansdk.scanflow.ScanConfiguration.PdfPageSize: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.geniusscansdk.scanflow.ScanConfiguration.Source: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.geniusscansdk.scanflow.ScanConfiguration.Action: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.geniusscansdk.scanflow.ScanConfiguration.Filter: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.geniusscansdk.scanflow.ScanConfiguration.FlashMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.geniusscansdk.scanflow.ScanConfiguration.MultiPageFormat: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.geniusscansdk.scanflow.ScanConfiguration.OcrOutputFormat: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.geniusscansdk.scanflow.ScanConfiguration.PdfPageSize: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.geniusscansdk.scanflow.ScanConfiguration.Source: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I J L M N O P R S T V
All Classes All Packages