Skip navigation links
A B C D E F G H I L M N O P R S T U V W 

A

addFrameHandler(PreviewBuffer.FrameHandler) - Method in interface net.doo.snap.camera.PreviewBuffer
Registers PreviewBuffer.FrameHandler which will receive preview frames from camera.
addPage(Page) - Method in class net.doo.snap.entity.SnappingDraft
Adds page in the end
addPage(int, Page) - Method in class net.doo.snap.entity.SnappingDraft
Adds page to given position
addPictureCallback(PictureCallback) - Method in class net.doo.snap.camera.ScanbotCameraView
Adds callback which will be notified when picture will be taken.
addResultHandler(BarcodeDetectorFrameHandler.ResultHandler) - Method in class net.doo.snap.camera.BarcodeDetectorFrameHandler
Registers result handler which will be notified about barcode/QR code detection results.
addResultHandler(ContourDetectorFrameHandler.ResultHandler) - Method in class net.doo.snap.camera.ContourDetectorFrameHandler
Registers result handler which will be notified about contour detection results.
addResultHandler(PayFormScannerFrameHandler.ResultHandler) - Method in class net.doo.snap.payformscanner.PayFormScannerFrameHandler
Registers result handler which will be notified about pay form detection results.
allBlobsAvailable(Collection<Blob>) - Method in class net.doo.snap.blob.BlobManager
 
attach(ScanbotCameraView) - Static method in class net.doo.snap.camera.AutoSnappingController
attach(ScanbotCameraView, ContourDetectorFrameHandler) - Static method in class net.doo.snap.camera.AutoSnappingController
Convenience method for attaching AutoSnappingController to camera view and ContourDetectorFrameHandler.
attach(ScanbotCameraView, ScanbotSDK) - Static method in class net.doo.snap.camera.BarcodeDetectorFrameHandler
Convenience method for creating new BarcodeDetectorFrameHandler and adding it as PreviewBuffer.FrameHandler to given camera view.
attach(ScanbotCameraView) - Static method in class net.doo.snap.camera.ContourDetectorFrameHandler
Convenience method for creating new ContourDetectorFrameHandler and adding it as PreviewBuffer.FrameHandler to given camera view.
attach(ScanbotCameraView, PayFormScanner) - Static method in class net.doo.snap.payformscanner.PayFormScannerFrameHandler
Convenience method for creating new PayFormScannerFrameHandler and adding it as PreviewBuffer.FrameHandler to given camera view.
autoFocus() - Method in class net.doo.snap.camera.ScanbotCameraView
Performs auto-focus.
AutoSnappingController - Class in net.doo.snap.camera
Controls auto-snapping process by observing contour detection results from ContourDetectorFrameHandler.
AutoSnappingController(ScanbotCameraView, ContourDetectorFrameHandler) - Constructor for class net.doo.snap.camera.AutoSnappingController
 
AutoSnappingController.AutoSnappingCallback - Interface in net.doo.snap.camera
Called right before auto-snapping routine takes picture.

B

bankDataBlob() - Method in class net.doo.snap.blob.BlobFactory
 
barcodeDetector() - Method in class net.doo.snap.ScanbotSDK
Provides ScanbotBarcodeDetector.
BarcodeDetectorFrameHandler - Class in net.doo.snap.camera
Performs barcode/QR code detection on camera preview frames.
BarcodeDetectorFrameHandler(Context, ScanbotSDK) - Constructor for class net.doo.snap.camera.BarcodeDetectorFrameHandler
 
BarcodeDetectorFrameHandler.ResultHandler - Interface in net.doo.snap.camera
Continiously notified about barcode/QR code detection results.
Blob - Class in net.doo.snap.entity
Binary large object, which might be stored either on remote storage or downloaded into local storage
Blob(String, String) - Constructor for class net.doo.snap.entity.Blob
 
BlobFactory - Class in net.doo.snap.blob
Creates Blobs depending on their purpose
BlobFactory(BlobStoreStrategy, RemoteStorage, DocumentClassifier) - Constructor for class net.doo.snap.blob.BlobFactory
 
blobFactory() - Method in class net.doo.snap.ScanbotSDK
Provides BlobFactory.
BlobManager - Class in net.doo.snap.blob
Manages binary files on local filesystem and provides access to binary files stored remotely
BlobManager(BlobStoreStrategy, DownloadManager, SharedPreferences, AssetManager, BlobFactory) - Constructor for class net.doo.snap.blob.BlobManager
 
blobManager() - Method in class net.doo.snap.ScanbotSDK
Provides BlobManager.
blobsToDownload(Collection<Language>) - Method in class net.doo.snap.blob.BlobManager
 
blockType - Variable in class net.doo.snap.process.OcrResultBlock
The type of the block.
boundingBox - Variable in class net.doo.snap.process.OcrResultBlock
The bounding box of the receiver in normalized unit coordinate space Left, Top:(0.0, 0.0) - Right, Bottom(1.0, 1.0).
boundingBoxWithImageSize - Variable in class net.doo.snap.process.OcrResultBlock
The bounding box of the receiver in absolute image coordinate system.
buildPage(Bitmap, int, int) - Method in class net.doo.snap.persistence.PageFactory
Builds new Page from provided data.
buildPage(byte[], int, int) - Method in class net.doo.snap.persistence.PageFactory
Builds new Page from provided data.
buildPage(Bitmap) - Method in class net.doo.snap.persistence.PageFactory
Builds new Page from provided data.
buildPage(byte[]) - Method in class net.doo.snap.persistence.PageFactory
Builds new Page from provided data.
buildPage(String, byte[], int, int) - Method in class net.doo.snap.persistence.PageFactory
Builds new Page from provided data.
buildPage(File) - Method in class net.doo.snap.persistence.PageFactory
Builds new Page from provided data.

C

CameraOpenCallback - Interface in net.doo.snap.camera
Called when camera is opened and ready for shooting
Cleaner - Class in net.doo.snap.persistence.cleanup
Deletes unreferenced pages and documents from filesystem.
Cleaner(UnreferencedSourcesProvider, PageStoreStrategy, DocumentStoreStrategy, ProcessingInfoProvider) - Constructor for class net.doo.snap.persistence.cleanup.Cleaner
 
cleaner() - Method in class net.doo.snap.ScanbotSDK
Provides Cleaner.
cleanUp() - Method in class net.doo.snap.persistence.cleanup.Cleaner
Deletes unreferenced pages and documents from filesystem.
cleanUpPagesData(Page[]) - Method in class net.doo.snap.persistence.cleanup.Cleaner
Cleans up all temporary pages data
confidenceValue - Variable in class net.doo.snap.process.OcrResultBlock
The confidence value describes how confident the OCR engine was when detecting the letters and words.
continuousFocus() - Method in class net.doo.snap.camera.ScanbotCameraView
Cancels auto-focus and performs continuous-focus.
ContourDetectorFrameHandler - Class in net.doo.snap.camera
Performs contour detection on camera preview frames.
ContourDetectorFrameHandler(Context) - Constructor for class net.doo.snap.camera.ContourDetectorFrameHandler
 
ContourDetectorFrameHandler.DetectedFrame - Class in net.doo.snap.camera
Contour detection results alongside with information about frame
ContourDetectorFrameHandler.ResultHandler - Interface in net.doo.snap.camera
Continiously notified about contour detection results.
CREATOR - Static variable in class net.doo.snap.entity.Document
 
CREATOR - Static variable in class net.doo.snap.entity.Page
 
CREATOR - Static variable in class net.doo.snap.entity.SnappingDraft
 
CREATOR - Static variable in class net.doo.snap.process.util.DocumentDraft
 

D

d(String, String) - Method in interface net.doo.snap.util.log.Logger
Writes tag and message to the log on Logger.Level.Debug
DEFAULT_POLYGON - Static variable in class net.doo.snap.ui.EditPolygonImageView
 
deletePage(int) - Method in class net.doo.snap.entity.SnappingDraft
Deletes Page at given position
deletePage(Page) - Method in class net.doo.snap.entity.SnappingDraft
Deletes Page if possible
describeContents() - Method in class net.doo.snap.entity.Document
 
describeContents() - Method in class net.doo.snap.entity.Page
 
describeContents() - Method in class net.doo.snap.entity.SnappingDraft
 
describeContents() - Method in class net.doo.snap.process.util.DocumentDraft
 
DetectedFrame(DetectionResult, List<PointF>, int, int, int) - Constructor for class net.doo.snap.camera.ContourDetectorFrameHandler.DetectedFrame
Deprecated.
DetectedFrame(DetectionResult, List<PointF>, int, int, int, double) - Constructor for class net.doo.snap.camera.ContourDetectorFrameHandler.DetectedFrame
 
detectionResult - Variable in class net.doo.snap.camera.ContourDetectorFrameHandler.DetectedFrame
Contour detection result status.
detectionScore - Variable in class net.doo.snap.camera.ContourDetectorFrameHandler.DetectedFrame
Score of detected frame as double value in [0.0, 100.0].
dispatchDraw(Canvas) - Method in class net.doo.snap.ui.EditPolygonImageView
 
dispatchDraw(Canvas) - Method in class net.doo.snap.ui.MagnifierView
 
dispatchDraw(Canvas) - Method in class net.doo.snap.ui.PolygonView
 
Document - Class in net.doo.snap.entity
Document model used in the application and database.
Document() - Constructor for class net.doo.snap.entity.Document
 
Document(Parcel) - Constructor for class net.doo.snap.entity.Document
 
documentClassifierBlobs(Language) - Method in class net.doo.snap.blob.BlobFactory
 
DocumentDraft - Class in net.doo.snap.process.util
Contains meta information about document being saved
DocumentDraft(Document, Page...) - Constructor for class net.doo.snap.process.util.DocumentDraft
 
DocumentDraft(Parcel) - Constructor for class net.doo.snap.process.util.DocumentDraft
 
DocumentDraftExtractor - Interface in net.doo.snap.process.draft
Creates Document and Page from SnappingDraft and wraps them in DocumentDraft
documentDraftExtractor() - Method in class net.doo.snap.ScanbotSDK
documentDraftExtractor(DocumentDraftExtractor) - Method in class net.doo.snap.ScanbotSDKInitializer
Adjust this parameter to specify snapped pages should be combined into documents and in which format
DocumentProcessingResult - Class in net.doo.snap.process
Result of the document draft processing
DocumentProcessingResult(Document, List<Page>, File) - Constructor for class net.doo.snap.process.DocumentProcessingResult
 
DocumentProcessor - Class in net.doo.snap.process
Saves pdf documents using DocumentDraft source Call in a background thread only.
DocumentProcessor(DocumentStoreStrategy, Resources, BitmapLruCache, PageProcessor, ComposerFactory, <any>, Cleaner) - Constructor for class net.doo.snap.process.DocumentProcessor
 
documentProcessor() - Method in class net.doo.snap.ScanbotSDK

E

e(String, String) - Method in interface net.doo.snap.util.log.Logger
Writes tag and message to the log on Logger.Level.Error
EditPolygonImageView - Class in net.doo.snap.ui
Shows image of document and polygon, which contains document coordinates with ability to change polygon corners and edges Magnifier is shown when polygon corners are moved
EditPolygonImageView(Context, AttributeSet) - Constructor for class net.doo.snap.ui.EditPolygonImageView
Constructor to embed view in XML layout
equals(Object) - Method in class net.doo.snap.entity.Blob
 
equals(Object) - Method in class net.doo.snap.entity.Document
 
equals(Object) - Method in class net.doo.snap.entity.Page
 
extract(SnappingDraft) - Method in interface net.doo.snap.process.draft.DocumentDraftExtractor
extract(SnappingDraft) - Method in class net.doo.snap.process.draft.MultipleDocumentsDraftExtractor
 

F

fetch(Blob, boolean) - Method in class net.doo.snap.blob.BlobManager
Launches asynchronous fetch of a given Blob if it is not already available in local destination folder.
FileChooserUtils - Class in net.doo.snap.util
Provides methods for extracting image path from chooser
FileChooserUtils() - Constructor for class net.doo.snap.util.FileChooserUtils
 
FILTERED_FOLDER - Static variable in class net.doo.snap.entity.Page
 
forJpeg() - Static method in class net.doo.snap.process.draft.MultipleDocumentsDraftExtractor
 
forPdf() - Static method in class net.doo.snap.process.draft.MultipleDocumentsDraftExtractor
 
frameHeight - Variable in class net.doo.snap.camera.ContourDetectorFrameHandler.DetectedFrame
Height of the frame before rotation
frameOrientation - Variable in class net.doo.snap.camera.ContourDetectorFrameHandler.DetectedFrame
Rotation of the frame in degrees relatively to what is seen on the screen.
frameWidth - Variable in class net.doo.snap.camera.ContourDetectorFrameHandler.DetectedFrame
Width of the frame before rotation

G

getAllLanguagesWithAvailableOcrBlobs() - Method in class net.doo.snap.blob.BlobManager
 
getBanksDataFile() - Method in class net.doo.snap.blob.BlobManager
 
getDataColumn(Context, Uri, String, String[]) - Static method in class net.doo.snap.util.FileChooserUtils
Get the value of the data column for this Uri.
getDate() - Method in class net.doo.snap.entity.Document
 
getDetectedLines() - Method in interface net.doo.snap.intelligence.OcrPdfRenderer.RenderIterator
 
getDetectedParagraphs() - Method in interface net.doo.snap.intelligence.OcrPdfRenderer.RenderIterator
 
getDetectedText() - Method in interface net.doo.snap.intelligence.OcrPdfRenderer.RenderIterator
 
getDetectedWords() - Method in interface net.doo.snap.intelligence.OcrPdfRenderer.RenderIterator
 
getDocument() - Method in class net.doo.snap.process.DocumentProcessingResult
 
getDocument() - Method in class net.doo.snap.process.util.DocumentDraft
 
getDocumentFile() - Method in class net.doo.snap.process.DocumentProcessingResult
 
getDocumentName() - Method in class net.doo.snap.entity.SnappingDraft
 
getDocumentType() - Method in class net.doo.snap.entity.Document
 
getFileName() - Method in enum net.doo.snap.entity.Page.ImageType
 
getId() - Method in class net.doo.snap.entity.Document
 
getId() - Method in class net.doo.snap.entity.Page
 
getImageSize(Page.ImageType) - Method in class net.doo.snap.entity.Page
 
getIso1Code() - Method in enum net.doo.snap.entity.Language
 
getIsoCode() - Method in enum net.doo.snap.entity.Language
 
getLanguage() - Method in class net.doo.snap.entity.Document
 
getLastProcessedPage() - Method in interface net.doo.snap.intelligence.OcrPdfRenderer.RenderIterator
 
getLastProcessedPosition() - Method in interface net.doo.snap.intelligence.OcrPdfRenderer.RenderIterator
 
getLocalPath() - Method in class net.doo.snap.entity.Blob
 
getMimeByName(String) - Static method in class net.doo.snap.util.thread.MimeUtils
Detects MIME from document or file name.
getName() - Method in class net.doo.snap.entity.Document
 
getOCRBlobsDirectory() - Method in class net.doo.snap.blob.BlobManager
 
getOcrStatus() - Method in class net.doo.snap.entity.Document
 
getOcrText() - Method in class net.doo.snap.entity.Document
 
getOptimizationType() - Method in class net.doo.snap.entity.Page
 
getPage(int) - Method in class net.doo.snap.entity.SnappingDraft
 
getPages() - Method in class net.doo.snap.entity.SnappingDraft
 
getPages() - Method in class net.doo.snap.process.DocumentProcessingResult
 
getPages() - Method in class net.doo.snap.process.util.DocumentDraft
 
getPagesCount() - Method in class net.doo.snap.entity.Document
 
getParameters() - Method in class net.doo.snap.entity.Page
 
getPath(Context, Uri) - Static method in class net.doo.snap.util.FileChooserUtils
Get a file path from a Uri.
getPolygon() - Method in class net.doo.snap.entity.Page
 
getPolygon() - Method in class net.doo.snap.ui.EditPolygonImageView
 
getPosition(Page) - Method in class net.doo.snap.entity.SnappingDraft
 
getPreviewBuffer() - Method in class net.doo.snap.camera.ScanbotCameraView
 
getRemotePath() - Method in class net.doo.snap.entity.Blob
 
getRotationType() - Method in class net.doo.snap.entity.Page
 
getSize() - Method in class net.doo.snap.entity.Document
 
getSupportedPictureSizes() - Method in class net.doo.snap.camera.ScanbotCameraView
 
getSupportedPreviewSizes() - Method in class net.doo.snap.camera.ScanbotCameraView
 
getThumbnailUri() - Method in class net.doo.snap.entity.Document
 
getUnreferencedDocuments() - Method in interface net.doo.snap.persistence.cleanup.UnreferencedSourcesProvider
 
getUnreferencedPages() - Method in interface net.doo.snap.persistence.cleanup.UnreferencedSourcesProvider
 

H

handleFrame(byte[], int, int, int) - Method in class net.doo.snap.camera.BarcodeDetectorFrameHandler
 
handleFrame(byte[], int, int, int) - Method in class net.doo.snap.camera.ContourDetectorFrameHandler
 
handleFrame(byte[], int, int, int) - Method in interface net.doo.snap.camera.PreviewBuffer.FrameHandler
Invoked for every new camera preview frame
handleFrame(byte[], int, int, int) - Method in class net.doo.snap.payformscanner.PayFormScannerFrameHandler
 
handleResult(Result) - Method in interface net.doo.snap.camera.BarcodeDetectorFrameHandler.ResultHandler
Called every time barcode/QR code detection was performed on a frame.
handleResult(ContourDetectorFrameHandler.DetectedFrame) - Method in interface net.doo.snap.camera.ContourDetectorFrameHandler.ResultHandler
Called every time contour detection was performed on a frame.
handleResult(DetectionResult) - Method in interface net.doo.snap.payformscanner.PayFormScannerFrameHandler.ResultHandler
Called every time pay form detection was performed on a frame.
handleResult(ContourDetectorFrameHandler.DetectedFrame) - Method in class net.doo.snap.ui.PolygonView
 
hasActiveDownloads() - Method in class net.doo.snap.blob.BlobManager
 
hashCode() - Method in class net.doo.snap.entity.Blob
 
hashCode() - Method in class net.doo.snap.entity.Document
 
hashCode() - Method in class net.doo.snap.entity.Page
 
heightInches - Variable in enum net.doo.snap.util.bitmap.ImageQualityOptimizer.PaperFormat
 

I

i(String, String) - Method in interface net.doo.snap.util.log.Logger
Writes tag and message to the log on Logger.Level.Information
ImageQualityOptimizer - Class in net.doo.snap.util.bitmap
ImageQualityOptimizer() - Constructor for class net.doo.snap.util.bitmap.ImageQualityOptimizer
 
ImageQualityOptimizer.PaperFormat - Enum in net.doo.snap.util.bitmap
Contains common paper formats (width and height in inches)
initialize(Application) - Method in class net.doo.snap.ScanbotSDKInitializer
Initializes Scanbot SDK library
isBlobAvailable(Blob) - Method in class net.doo.snap.blob.BlobManager
 
isCombined() - Method in class net.doo.snap.entity.SnappingDraft
 
isDownloadsDocument(Uri) - Static method in class net.doo.snap.util.FileChooserUtils
 
isEmpty() - Method in class net.doo.snap.entity.SnappingDraft
 
isEnabled() - Method in class net.doo.snap.camera.AutoSnappingController
 
isEnabled() - Method in class net.doo.snap.camera.BarcodeDetectorFrameHandler
 
isEnabled() - Method in class net.doo.snap.camera.ContourDetectorFrameHandler
 
isEnabled() - Method in class net.doo.snap.payformscanner.PayFormScannerFrameHandler
 
isExternalStorageDocument(Uri) - Static method in class net.doo.snap.util.FileChooserUtils
 
isInitialized() - Static method in class net.doo.snap.ScanbotSDKInitializer
 
isLicenseActive() - Method in class net.doo.snap.ScanbotSDK
isLicenseValid() - Method in class net.doo.snap.ScanbotSDK
Provides the status of the license.
isMediaDocument(Uri) - Static method in class net.doo.snap.util.FileChooserUtils
 
isProcessed() - Method in class net.doo.snap.entity.Page
 

L

Language - Enum in net.doo.snap.entity
Natural language
languageByIso(String) - Static method in enum net.doo.snap.entity.Language
 
languageClassifierBlobPath(Application, String) - Method in class net.doo.snap.ScanbotSDKInitializer
Set Scanbot SDK language classifier blob path
languageCodes(Collection<Language>) - Static method in enum net.doo.snap.entity.Language
 
languageDetectorBlobs() - Method in class net.doo.snap.blob.BlobFactory
 
license(Application, String) - Method in class net.doo.snap.ScanbotSDKInitializer
Set Scanbot SDK license
lines - Variable in class net.doo.snap.process.OcrResult
The List of OcrResultBlock objects containing all blocks of type OcrResultBlock.OcrResultBlockType.LINE.
lockToLandscape() - Method in class net.doo.snap.camera.ScanbotCameraView
Locks camera in landscape mode
lockToPortrait() - Method in class net.doo.snap.camera.ScanbotCameraView
Locks camera in portrait mode
logException(Throwable) - Method in interface net.doo.snap.util.log.Logger
Shows log for exception
logger(Logger) - Method in class net.doo.snap.ScanbotSDKInitializer
Adjust this parameter to specify which Logger should be used.
Logger - Interface in net.doo.snap.util.log
Writes logs
Logger.Level - Enum in net.doo.snap.util.log
Logging level.
logMethod() - Method in interface net.doo.snap.util.log.Logger
Shows log for invoked method

M

MagnifierView - Class in net.doo.snap.ui
View that draws magnifier.
MagnifierView(Context, AttributeSet) - Constructor for class net.doo.snap.ui.MagnifierView
 
MimeUtils - Class in net.doo.snap.util.thread
Utils connected to mime detection
MimeUtils() - Constructor for class net.doo.snap.util.thread.MimeUtils
 
MultipleDocumentsDraftExtractor - Class in net.doo.snap.process.draft
Extracts separate document draft for each page of SnappingDraft
MultipleDocumentsDraftExtractor(SharedPreferences) - Constructor for class net.doo.snap.process.draft.MultipleDocumentsDraftExtractor
 

N

net.doo.snap - package net.doo.snap
 
net.doo.snap.blob - package net.doo.snap.blob
 
net.doo.snap.camera - package net.doo.snap.camera
 
net.doo.snap.entity - package net.doo.snap.entity
 
net.doo.snap.intelligence - package net.doo.snap.intelligence
 
net.doo.snap.payformscanner - package net.doo.snap.payformscanner
 
net.doo.snap.persistence - package net.doo.snap.persistence
 
net.doo.snap.persistence.cleanup - package net.doo.snap.persistence.cleanup
 
net.doo.snap.process - package net.doo.snap.process
 
net.doo.snap.process.draft - package net.doo.snap.process.draft
 
net.doo.snap.process.util - package net.doo.snap.process.util
 
net.doo.snap.ui - package net.doo.snap.ui
 
net.doo.snap.util - package net.doo.snap.util
 
net.doo.snap.util.bitmap - package net.doo.snap.util.bitmap
 
net.doo.snap.util.log - package net.doo.snap.util.log
 
net.doo.snap.util.thread - package net.doo.snap.util.thread
 
NoPageByIndexException() - Constructor for exception net.doo.snap.entity.SnappingDraft.NoPageByIndexException
 
NULL - Static variable in interface net.doo.snap.camera.AutoSnappingController.AutoSnappingCallback
Null-object pattern
NULL - Static variable in interface net.doo.snap.camera.CameraOpenCallback
Null-object pattern
NULL - Static variable in interface net.doo.snap.camera.PictureCallback
Null-object pattern

O

ocrBlobsPath(Application, String) - Method in class net.doo.snap.ScanbotSDKInitializer
Set Scanbot SDK OCR blobs path
ocrLanguageBlobs(Language) - Method in class net.doo.snap.blob.BlobFactory
 
OcrPdfRenderer - Class in net.doo.snap.intelligence
Saves Document with given Pages into PDF sandwiched with results of OCR.
OcrPdfRenderer(Context, DocumentStoreStrategy, PageStoreStrategy, BlobStoreStrategy) - Constructor for class net.doo.snap.intelligence.OcrPdfRenderer
 
OcrPdfRenderer.RenderIterator - Interface in net.doo.snap.intelligence
Controls render process.
OcrResult - Class in net.doo.snap.process
Represents result of OCR-performing.
OcrResult(String, Document, File, List<OcrResultBlock>, List<OcrResultBlock>, List<OcrResultBlock>) - Constructor for class net.doo.snap.process.OcrResult
 
OcrResultBlock - Class in net.doo.snap.process
Part of the optical character recognitions result.
OcrResultBlock(String, RectF, Rect, Float, OcrResultBlock.OcrResultBlockType) - Constructor for class net.doo.snap.process.OcrResultBlock
 
OcrResultBlock.OcrResultBlockType - Enum in net.doo.snap.process
Represents block types for a text paragraph, a text line or a word.
onAttachedToWindow() - Method in class net.doo.snap.ui.EditPolygonImageView
 
onAttachedToWindow() - Method in class net.doo.snap.ui.MagnifierView
 
onAutoSnapping() - Method in interface net.doo.snap.camera.AutoSnappingController.AutoSnappingCallback
Called right before auto-snapping routine takes picture.
onCameraOpened() - Method in interface net.doo.snap.camera.CameraOpenCallback
Called when camera is opened and ready for shooting
onDetachedFromWindow() - Method in class net.doo.snap.ui.EditPolygonImageView
 
onDetachedFromWindow() - Method in class net.doo.snap.ui.MagnifierView
 
onLayout(boolean, int, int, int, int) - Method in class net.doo.snap.camera.ScanbotCameraView
 
onLayout(boolean, int, int, int, int) - Method in class net.doo.snap.ui.EditPolygonImageView
 
onLayout(boolean, int, int, int, int) - Method in class net.doo.snap.ui.MagnifierView
 
onMeasure(int, int) - Method in class net.doo.snap.camera.ScanbotCameraView
 
onMeasure(int, int) - Method in class net.doo.snap.ui.EditPolygonImageView
 
onPause() - Method in class net.doo.snap.camera.ScanbotCameraView
Notifies view that enclosing Activity or Fragment was paused and therefore camera must be closed.
onPictureTaken(byte[], int) - Method in interface net.doo.snap.camera.PictureCallback
Invoked when picture is taken
onResume() - Method in class net.doo.snap.camera.ScanbotCameraView
Notifies view that enclosing Activity or Fragment was resumed and therefore camera can be started.
onSizeChanged(int, int, int, int) - Method in class net.doo.snap.ui.PolygonView
 
onTouchEvent(MotionEvent) - Method in class net.doo.snap.ui.EditPolygonImageView
 
optimizeImage(Bitmap, float, float, long) - Method in class net.doo.snap.util.bitmap.ImageQualityOptimizer
Scales image to desirable quality.
optimizeImage(Bitmap, long) - Method in class net.doo.snap.util.bitmap.ImageQualityOptimizer
Scales image to desirable quality.

P

Page - Class in net.doo.snap.entity
Model for representing snapped instance and associated meta info.
Page() - Constructor for class net.doo.snap.entity.Page
 
Page(String) - Constructor for class net.doo.snap.entity.Page
 
page - Variable in class net.doo.snap.persistence.PageFactory.Result
Newly created Page with unique id
Page.ImageType - Enum in net.doo.snap.entity
Types of images to be saved on disk
PageFactory - Class in net.doo.snap.persistence
Creates Pages and saves their content in file system
PageFactory(BitmapLruCache, PageStoreStrategy) - Constructor for class net.doo.snap.persistence.PageFactory
 
pageFactory() - Method in class net.doo.snap.ScanbotSDK
Provides PageFactory.
PageFactory.Result - Class in net.doo.snap.persistence
Result of Page creation.
paragraphs - Variable in class net.doo.snap.process.OcrResult
The List of OcrResultBlock objects containing all blocks of type OcrResultBlock.OcrResultBlockType.PARAGRAPH.
PayFormScanner - Interface in net.doo.snap.payformscanner
Performs detection and recognition of pay forms
payFormScanner() - Method in class net.doo.snap.ScanbotSDK
Provides PayFormScanner.
PayFormScannerFrameHandler - Class in net.doo.snap.payformscanner
Performs pay form detection on camera preview frames.
PayFormScannerFrameHandler(Context, PayFormScanner) - Constructor for class net.doo.snap.payformscanner.PayFormScannerFrameHandler
 
PayFormScannerFrameHandler.ResultHandler - Interface in net.doo.snap.payformscanner
Continuously notified about pay form detection results.
PictureCallback - Interface in net.doo.snap.camera
Invoked when picture is taken
polygon - Variable in class net.doo.snap.camera.ContourDetectorFrameHandler.DetectedFrame
Detected polygon.
PolygonView - Class in net.doo.snap.ui
Draws polygon
PolygonView(Context) - Constructor for class net.doo.snap.ui.PolygonView
 
PolygonView(Context, AttributeSet) - Constructor for class net.doo.snap.ui.PolygonView
 
preVerifyForm(byte[], int, int) - Method in interface net.doo.snap.payformscanner.PayFormScanner
Performs pay form preverifying on the NV21 format image
preVerifyFormBGR(byte[], int, int) - Method in interface net.doo.snap.payformscanner.PayFormScanner
Performs pay form preverifying on the BGR format image
preview - Variable in class net.doo.snap.persistence.PageFactory.Result
Preview-size Bitmap for Page
PreviewBuffer - Interface in net.doo.snap.camera
Manages access to preview buffer of the Camera
PreviewBuffer.FrameHandler - Interface in net.doo.snap.camera
Handles camera preview frames
processDocument(DocumentDraft) - Method in class net.doo.snap.process.DocumentProcessor
Creates files for given DocumentDraft.

R

recognize() - Method in class net.doo.snap.process.TextRecognizer
Performs text recognition using OcrPerformer
recognizedText - Variable in class net.doo.snap.process.OcrResult
Recognized text as a String
recognizeForm(byte[], int, int, int) - Method in interface net.doo.snap.payformscanner.PayFormScanner
Performs pay form recognition on the NV21 format image
recognizeFormBGR(byte[], int, int, int) - Method in interface net.doo.snap.payformscanner.PayFormScanner
Performs pay form recognition on the BGR format image
recycle() - Method in interface net.doo.snap.intelligence.OcrPdfRenderer.RenderIterator
Frees resources held by OcrPdfRenderer.RenderIterator
removeFrameHandler(PreviewBuffer.FrameHandler) - Method in interface net.doo.snap.camera.PreviewBuffer
removePictureCallback(PictureCallback) - Method in class net.doo.snap.camera.ScanbotCameraView
Removes callback, so it won't receive any further notifications.
removeResultHandler(BarcodeDetectorFrameHandler.ResultHandler) - Method in class net.doo.snap.camera.BarcodeDetectorFrameHandler
Unregisters handler.
removeResultHandler(ContourDetectorFrameHandler.ResultHandler) - Method in class net.doo.snap.camera.ContourDetectorFrameHandler
Unregisters handler.
removeResultHandler(PayFormScannerFrameHandler.ResultHandler) - Method in class net.doo.snap.payformscanner.PayFormScannerFrameHandler
Unregisters handler.
renderNextPage() - Method in interface net.doo.snap.intelligence.OcrPdfRenderer.RenderIterator
Performs OCR of next page if available.
replacePage(int, Page) - Method in class net.doo.snap.entity.SnappingDraft
Replaces page at given position with new page
Result(Page, Bitmap) - Constructor for class net.doo.snap.persistence.PageFactory.Result
 
rotateClockwise() - Method in class net.doo.snap.ui.EditPolygonImageView
Rotates view clockwise
rotateCounterClockwise() - Method in class net.doo.snap.ui.EditPolygonImageView
Rotates view counterclockwise

S

sandwichedPdfDocument - Variable in class net.doo.snap.process.OcrResult
Optional sandwiched pdf Document (can be null)
sandwichedPdfDocumentFile - Variable in class net.doo.snap.process.OcrResult
Optional sandwiched pdf Document file (can be null)
ScanbotCameraView - Class in net.doo.snap.camera
Provides interface to native Camera and displays camera stream.
ScanbotCameraView(Context) - Constructor for class net.doo.snap.camera.ScanbotCameraView
 
ScanbotCameraView(Context, AttributeSet) - Constructor for class net.doo.snap.camera.ScanbotCameraView
 
ScanbotSDK - Class in net.doo.snap
Provider for Scanbot SDK features.
ScanbotSDK(Activity) - Constructor for class net.doo.snap.ScanbotSDK
 
ScanbotSDK(Service) - Constructor for class net.doo.snap.ScanbotSDK
 
ScanbotSDK(Application) - Constructor for class net.doo.snap.ScanbotSDK
 
ScanbotSDKInitializer - Class in net.doo.snap
Initializes Scanbot SDK library.
ScanbotSDKInitializer() - Constructor for class net.doo.snap.ScanbotSDKInitializer
 
setAcceptedAngleScore(double) - Method in class net.doo.snap.camera.ContourDetectorFrameHandler
The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document.
setAcceptedSizeScore(double) - Method in class net.doo.snap.camera.ContourDetectorFrameHandler
The minimum size in percent (0 - 100) of the screen size to accept a detected document.
setAutoFocusOnTouch(boolean) - Method in class net.doo.snap.camera.ScanbotCameraView
 
setAutoFocusSound(boolean) - Method in class net.doo.snap.camera.ScanbotCameraView
Set camera auto focus sound state.
setAutoSnappingCallback(AutoSnappingController.AutoSnappingCallback) - Method in class net.doo.snap.camera.AutoSnappingController
 
setCameraOpenCallback(CameraOpenCallback) - Method in class net.doo.snap.camera.ScanbotCameraView
Callback which will be invoked when camera will be opened
setCombined(boolean) - Method in class net.doo.snap.entity.SnappingDraft
 
setDate(long) - Method in class net.doo.snap.entity.Document
 
setDetectionInterval(long) - Method in class net.doo.snap.camera.BarcodeDetectorFrameHandler
Set barcode detection interval in milliseconds
setDocumentName(String) - Method in class net.doo.snap.entity.SnappingDraft
 
setDocumentType(DocumentType) - Method in class net.doo.snap.entity.Document
 
setEdgeColor(int) - Method in class net.doo.snap.ui.EditPolygonImageView
Sets edge color
setEdgeWidth(float) - Method in class net.doo.snap.ui.EditPolygonImageView
Sets edge width in pixels
setEnabled(boolean) - Method in class net.doo.snap.camera.AutoSnappingController
 
setEnabled(boolean) - Method in class net.doo.snap.camera.BarcodeDetectorFrameHandler
 
setEnabled(boolean) - Method in class net.doo.snap.camera.ContourDetectorFrameHandler
 
setEnabled(boolean) - Method in class net.doo.snap.payformscanner.PayFormScannerFrameHandler
 
setFillColor(int) - Method in class net.doo.snap.ui.PolygonView
Changes fill color of the polygon
setId(String) - Method in class net.doo.snap.entity.Document
 
setImageSize(Page.ImageType, int, int) - Method in class net.doo.snap.entity.Page
Saves information about image size for particular Page.ImageType
setLanguage(Language) - Method in class net.doo.snap.entity.Document
 
setLines(List<Line2D>, List<Line2D>) - Method in class net.doo.snap.ui.EditPolygonImageView
Sets detected horizontal and vertical lines
setName(String) - Method in class net.doo.snap.entity.Document
 
setOcrStatus(OcrStatus) - Method in class net.doo.snap.entity.Document
 
setOcrText(String) - Method in class net.doo.snap.entity.Document
 
setOptimizationType(OptimizationType) - Method in class net.doo.snap.entity.Page
 
setPagesCount(int) - Method in class net.doo.snap.entity.Document
 
setPictureSize(Camera.Size) - Method in class net.doo.snap.camera.ScanbotCameraView
Set camera picture size
setPolygon(List<PointF>) - Method in class net.doo.snap.entity.Page
Sets polygon which crops page preview from original image.
setPolygon(List<PointF>) - Method in class net.doo.snap.ui.EditPolygonImageView
Sets polygon containing document coordinates
setPreviewMode(CameraPreviewMode) - Method in class net.doo.snap.camera.ScanbotCameraView
Set the camera preview mode.
setPreviewSize(Camera.Size) - Method in class net.doo.snap.camera.ScanbotCameraView
Set camera preview size
setProcessed(boolean) - Method in class net.doo.snap.entity.Page
 
setRotationType(RotationType) - Method in class net.doo.snap.entity.Page
 
setSensitivity(float) - Method in class net.doo.snap.camera.AutoSnappingController
Changes sensitivity of auto-snapping.
setShutterSound(boolean) - Method in class net.doo.snap.camera.ScanbotCameraView
Set camera shutter sound state.
setSize(long) - Method in class net.doo.snap.entity.Document
 
setStrokeColor(int) - Method in class net.doo.snap.ui.PolygonView
Changes stroke color of the polygon.
setStrokeWidth(float) - Method in class net.doo.snap.ui.PolygonView
Changes width of the stroke of the polygon.
setThumbnailUri(String) - Method in class net.doo.snap.entity.Document
 
setupMagnifier(EditPolygonImageView) - Method in class net.doo.snap.ui.MagnifierView
Setup magnifier using given EditPolygonImageView
size() - Method in class net.doo.snap.entity.SnappingDraft
 
SnappingDraft - Class in net.doo.snap.entity
Contains Pages and naming metadata necessary for document creation
SnappingDraft(Page...) - Constructor for class net.doo.snap.entity.SnappingDraft
 
SnappingDraft(Parcel) - Constructor for class net.doo.snap.entity.SnappingDraft
 
SnappingDraft.NoPageByIndexException - Exception in net.doo.snap.entity
Thrown if page by index does not exist
startPreview() - Method in class net.doo.snap.camera.ScanbotCameraView
Starts/resumes camera preview stream.
startRender(Document, Page[], Collection<Language>) - Method in class net.doo.snap.intelligence.OcrPdfRenderer
Starts render of document into PDF file.
stopPreview() - Method in class net.doo.snap.camera.ScanbotCameraView
Stops camera preview stream.

T

takePicture(boolean) - Method in class net.doo.snap.camera.ScanbotCameraView
Takes picture.
text - Variable in class net.doo.snap.process.OcrResultBlock
The recognized text within the receivers bounding box.
TextRecognition - Interface in net.doo.snap.process
Text recognition API.
textRecognition() - Method in class net.doo.snap.ScanbotSDK
Provides functionality for recognize text.
TextRecognizer - Class in net.doo.snap.process
Performs text recognition.
TextRecognizer(OcrPerformer) - Constructor for class net.doo.snap.process.TextRecognizer
 
toString() - Method in class net.doo.snap.entity.Blob
 
toString() - Method in class net.doo.snap.entity.Document
 
toString() - Method in enum net.doo.snap.util.log.Logger.Level
 

U

unlockOrientation() - Method in class net.doo.snap.camera.ScanbotCameraView
Unlocks camera orientation
UnreferencedSourcesProvider - Interface in net.doo.snap.persistence.cleanup
Provides Collection of sources ids, which are not referenced
unreferencedSourcesProvider(UnreferencedSourcesProvider) - Method in class net.doo.snap.ScanbotSDKInitializer
Adjust this parameter to specify which files Cleaner can safely delete during clean up
useFlash(boolean) - Method in class net.doo.snap.camera.ScanbotCameraView
Enables or disables camera flash.

V

valueOf(String) - Static method in enum net.doo.snap.entity.Language
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.doo.snap.entity.Page.ImageType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.doo.snap.process.OcrResultBlock.OcrResultBlockType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.doo.snap.util.bitmap.ImageQualityOptimizer.PaperFormat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum net.doo.snap.util.log.Logger.Level
Returns the enum constant of this type with the specified name.
values() - Static method in enum net.doo.snap.entity.Language
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.doo.snap.entity.Page.ImageType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.doo.snap.process.OcrResultBlock.OcrResultBlockType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.doo.snap.util.bitmap.ImageQualityOptimizer.PaperFormat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum net.doo.snap.util.log.Logger.Level
Returns an array containing the constants of this enum type, in the order they are declared.

W

w(String, String) - Method in interface net.doo.snap.util.log.Logger
Writes tag and message to the log on Logger.Level.Warning
widthInches - Variable in enum net.doo.snap.util.bitmap.ImageQualityOptimizer.PaperFormat
 
withLogging(boolean) - Method in class net.doo.snap.ScanbotSDKInitializer
Enables or disables logs in Scanbot SDK.
withoutPDF(Language, List<Page>) - Method in interface net.doo.snap.process.TextRecognition
Provides TextRecognizer which can be used to recognize text.
withoutPDF(List<Language>, List<Page>) - Method in interface net.doo.snap.process.TextRecognition
Provides TextRecognizer which can be used to recognize text.
withPDF(Language, Document, List<Page>) - Method in interface net.doo.snap.process.TextRecognition
Provides TextRecognizer which can be used for creating PDF with embedded text recognition result.
withPDF(List<Language>, Document, List<Page>) - Method in interface net.doo.snap.process.TextRecognition
Provides TextRecognizer which can be used for creating PDF with embedded text recognition result.
words - Variable in class net.doo.snap.process.OcrResult
The List of OcrResultBlock objects containing all blocks of type OcrResultBlock.OcrResultBlockType.WORD.
writeToParcel(Parcel, int) - Method in class net.doo.snap.entity.Document
 
writeToParcel(Parcel, int) - Method in class net.doo.snap.entity.Page
 
writeToParcel(Parcel, int) - Method in class net.doo.snap.entity.SnappingDraft
 
writeToParcel(Parcel, int) - Method in class net.doo.snap.process.util.DocumentDraft
 
A B C D E F G H I L M N O P R S T U V W 
Skip navigation links