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

A

add(image) - Method in class io.scanbot.sdk.persistence.PageFileStorage
Adds image in the storage, and returns pageId. Creates previews, and detects contours.
add(image) - Method in class io.scanbot.sdk.persistence.PageFileStorage
Adds image in the storage, and returns pageId. Creates previews, and detects contours.
addFrameHandler() - Method in interface net.doo.snap.camera.PreviewBuffer
Registers net.doo.snap.camera.PreviewBuffer.FrameHandler which will receive preview frames from camera. Note, that handlers can intercept frame by returning true from PreviewBuffer.FrameHandler.handleFrame. In such case no other handler will receive callbacks for current frame. Therefore, order in which handlers are added matters. All callbacks are invoked from the worker thread, so it is safe to perform "heavy" operations.
addPage() - Method in class net.doo.snap.entity.SnappingDraft
Adds page in the end
addPage() - Method in class net.doo.snap.entity.SnappingDraft
Adds page to given position
addPictureCallback() - Method in class net.doo.snap.camera.ScanbotCameraView
Adds callback which will be notified when picture will be taken. Callbacks are invoked on a worker thread, so you can safely perform "heavy" operations here.
addResultHandler() - Method in class io.scanbot.sdk.barcode.BarcodeDetectorFrameHandler
Registers result handler which will be notified about barcode/QR code detection results. Results are coming on the worker thread. Don't forget to move execution to main thread before updating UI.
addResultHandler() - Method in class net.doo.snap.camera.BarcodeDetectorFrameHandler
Registers result handler which will be notified about barcode/QR code detection results. Results are coming on the worker thread. Don't forget to move execution to main thread before updating UI.
addResultHandler() - Method in class net.doo.snap.camera.ContourDetectorFrameHandler
Registers result handler which will be notified about contour detection results. Results are coming on the worker thread. Don't forget to move execution to main thread before updating UI.
addResultHandler() - Method in class net.doo.snap.dcscanner.DCScannerFrameHandler
Registers result handler which will be notified about DC data detection results. Results are coming on the worker thread. Don't forget to move execution to main thread before updating UI.
addResultHandler() - Method in class net.doo.snap.mrzscanner.MRZScannerFrameHandler
Registers result handler which will be notified about MRZ data detection results. Results are coming on the worker thread. Don't forget to move execution to main thread before updating UI.
addResultHandler() - Method in class net.doo.snap.payformscanner.PayFormScannerFrameHandler
Registers result handler which will be notified about pay form detection results. Results are coming on the worker thread. Don't forget to move execution to main thread before updating UI.
addResultPoints() - Method in class io.scanbot.sdk.barcode.entity.BarcodeScanningResult
 
allBlobsAvailable() - Method in class net.doo.snap.blob.BlobManager
 
attach() - Static method in class io.scanbot.sdk.barcode.BarcodeDetectorFrameHandler
Convenience method for creating new BarcodeDetectorFrameHandler and adding it as PreviewBuffer.FrameHandler to given camera view.
attach() - Static method in class net.doo.snap.camera.AutoSnappingController
Same as AutoSnappingController.attach, but creates new ContourDetectorFrameHandler which will be attached to camera. Use this method if you don't need to control contour detection routine. However, be careful to not accidentally attach several ContourDetectorFrameHandler to camera therefore causing contour detection to be executed more than once.
attach() - Static method in class net.doo.snap.camera.AutoSnappingController
Convenience method for attaching AutoSnappingController to camera view and ContourDetectorFrameHandler. Auto-snapping is enabled by default as soon as you create new instance of AutoSnappingController. You can manually enable or disable auto-snapping by calling AutoSnappingController.setEnabled.
attach() - 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() - Static method in class net.doo.snap.camera.ContourDetectorFrameHandler
Convenience method for creating new ContourDetectorFrameHandler and adding it as net.doo.snap.camera.PreviewBuffer.FrameHandler to given camera view.
attach() - Static method in class net.doo.snap.dcscanner.DCScannerFrameHandler
Convenience method for creating new DCScannerFrameHandler and adding it as PreviewBuffer.FrameHandler to given camera view.
attach() - Static method in class net.doo.snap.mrzscanner.MRZScannerFrameHandler
Convenience method for creating new MRZScannerFrameHandler and adding it as PreviewBuffer.FrameHandler to given camera view.
attach() - 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. If there is no auto-focus capabilities on this device, does nothing. If view is paused, this call is ignored.
AutoSnappingController - Class in net.doo.snap.camera
Controls auto-snapping process by observing contour detection results from ContourDetectorFrameHandler.
AutoSnappingController() - Constructor for class net.doo.snap.camera.AutoSnappingController
 
AutoSnappingController.AutoSnappingCallback - Interface in net.doo.snap.camera
Called right before auto-snapping routine takes picture. Might intercept and cancel the shooting.

B

bankDataBlob() - Method in class net.doo.snap.blob.BlobFactory
 
barcodeDetector() - Method in class io.scanbot.sdk.ScanbotSDK
Provides ScanbotBarcodeDetector.
barcodeDetector() - Method in class net.doo.snap.ScanbotSDK
Provides ScanbotBarcodeDetector.
BarcodeDetectorFrameHandler - Class in io.scanbot.sdk.barcode
Performs barcode/QR code detection on camera preview frames. Outputs results via BarcodeDetectorFrameHandler.ResultHandler (BarcodeDetectorFrameHandler.addResultHandler). Preview frame considered intercepted if at least one BarcodeDetectorFrameHandler.ResultHandler returns true from BarcodeDetectorFrameHandler.ResultHandler.handleResult
BarcodeDetectorFrameHandler() - Constructor for class io.scanbot.sdk.barcode.BarcodeDetectorFrameHandler
 
BarcodeDetectorFrameHandler - Class in net.doo.snap.camera
Performs barcode/QR code detection on camera preview frames. Outputs results via BarcodeDetectorFrameHandler.ResultHandler (BarcodeDetectorFrameHandler.addResultHandler). Preview frame considered intercepted if at least one BarcodeDetectorFrameHandler.ResultHandler returns true from BarcodeDetectorFrameHandler.ResultHandler.handleResult
BarcodeDetectorFrameHandler() - Constructor for class net.doo.snap.camera.BarcodeDetectorFrameHandler
 
BarcodeDetectorFrameHandler.ResultHandler - Interface in io.scanbot.sdk.barcode
Continiously notified about barcode/QR code detection results.
BarcodeDetectorFrameHandler.ResultHandler - Interface in net.doo.snap.camera
Continiously notified about barcode/QR code detection results.
BarcodeFormat - Enum in io.scanbot.sdk.barcode.entity
Enumerates supported barcode types
BarcodeScanningResult - Class in io.scanbot.sdk.barcode.entity
Encapsulates the result of decoding a barcode within an image.
BarcodeScanningResult() - Constructor for class io.scanbot.sdk.barcode.entity.BarcodeScanningResult
 
BarcodeScanningResult() - Constructor for class io.scanbot.sdk.barcode.entity.BarcodeScanningResult
 
BarcodeScanningResult() - Constructor for class io.scanbot.sdk.barcode.entity.BarcodeScanningResult
 
BarcodeScanningResult() - Constructor for class io.scanbot.sdk.barcode.entity.BarcodeScanningResult
 
BaseUnreferencedSourcesProvider - Class in net.doo.snap.persistence.cleanup
Provides Collection of sources ids, which are not referenced
BaseUnreferencedSourcesProvider() - Constructor for class net.doo.snap.persistence.cleanup.BaseUnreferencedSourcesProvider
 
Blob - Class in net.doo.snap.entity
Binary large object, which might be stored either on remote storage or downloaded into local storage
Blob() - Constructor for class net.doo.snap.entity.Blob
 
blobFactory() - Method in class io.scanbot.sdk.ScanbotSDK
Provides BlobFactory.
BlobFactory - Class in net.doo.snap.blob
Creates net.doo.snap.entity.Blobs depending on their purpose
BlobFactory() - Constructor for class net.doo.snap.blob.BlobFactory
 
blobFactory() - Method in class net.doo.snap.ScanbotSDK
Provides BlobFactory.
blobManager() - Method in class io.scanbot.sdk.ScanbotSDK
Provides BlobManager.
BlobManager - Class in net.doo.snap.blob
Manages binary files on local filesystem and provides access to binary files stored remotely
BlobManager() - Constructor for class net.doo.snap.blob.BlobManager
 
blobManager() - Method in class net.doo.snap.ScanbotSDK
Provides BlobManager.
blobsToDownload() - Method in class net.doo.snap.blob.BlobManager
 
blockType - Variable in class net.doo.snap.process.OcrResultBlock
The type of the block. OcrResultBlockType.
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). Use the OcrResultBlock#boundingBoxWithImageSize method to get the bounding box in absolute image coordinates.
boundingBoxWithImageSize - Variable in class net.doo.snap.process.OcrResultBlock
The bounding box of the receiver in absolute image coordinate system.
build() - Method in class io.scanbot.sdk.persistence.PageStorageSettings.Builder
 
Builder() - Constructor for class io.scanbot.sdk.persistence.PageStorageSettings.Builder
 
buildPage() - Method in class net.doo.snap.persistence.PageFactory
Builds new Page from provided data. Result represented as Result class. Might perform image compression, so if you're already have compressed image (in a file system, for instance) consider using PageFactory.buildPage instead
buildPage() - Method in class net.doo.snap.persistence.PageFactory
Builds new Page from provided data. Result represented as Result class.
buildPage() - Method in class net.doo.snap.persistence.PageFactory
Builds new Page from provided data.
buildPage() - Method in class net.doo.snap.persistence.PageFactory
Builds new Page from provided data.
buildPage() - Method in class net.doo.snap.persistence.PageFactory
Builds new Page from provided data. Result represented as Result class.
buildPage() - Method in class net.doo.snap.persistence.PageFactory
Builds new Page from provided data.

C

CameraImageFormat - Enum in io.scanbot.sdk.persistence
Format that will be used by storage to save image JPG to save in jpeg PNG to save in png
CameraImageFormat() - Constructor for enum io.scanbot.sdk.persistence.CameraImageFormat
Format that will be used by storage to save image JPG to save in jpeg PNG to save in png
CameraOpenCallback - Interface in net.doo.snap.camera
Called when camera is opened and ready for shooting
cleaner() - Method in class io.scanbot.sdk.ScanbotSDK
Provides Cleaner.
Cleaner - Class in net.doo.snap.persistence.cleanup
Deletes unreferenced pages and documents from filesystem.
Cleaner() - 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() - Method in class net.doo.snap.persistence.cleanup.Cleaner
Cleans up all temporary pages data
CombinedDocumentDraftExtractor - Class in net.doo.snap.process.draft
Combines all pages of SnappingDraft into single document draft
CombinedDocumentDraftExtractor() - Constructor for class net.doo.snap.process.draft.CombinedDocumentDraftExtractor
 
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. Ranges from 0.0 (not confident) to 100.0 (very confident).
continuousFocus() - Method in class net.doo.snap.camera.ScanbotCameraView
Cancels auto-focus and performs continuous-focus. Should be executed from the main thread and when camera is opened If there is no continuous-focus capabilities on this device, does auto-focus. If view is paused, this call is ignored.
ContourDetectorFrameHandler - Class in net.doo.snap.camera
Performs contour detection on camera preview frames. Outputs results via net.doo.snap.camera.ContourDetectorFrameHandler.ResultHandler (ContourDetectorFrameHandler.addResultHandler). Preview frame considered intercepted if at least one net.doo.snap.camera.ContourDetectorFrameHandler.ResultHandler returns true from ContourDetectorFrameHandler.ResultHandler.handleResult
ContourDetectorFrameHandler() - 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 io.scanbot.sdk.barcode.entity.BarcodeScanningResult
 
CREATOR - Static variable in class io.scanbot.sdk.barcode.entity.ResultPoint
 
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() - Method in interface net.doo.snap.util.log.Logger
Writes tag and message to the log on Level#Debug
d() - Method in class net.doo.snap.util.log.StubLogger
 
dcScanner() - Method in class io.scanbot.sdk.ScanbotSDK
Provides DCScanner.
DCScanner - Interface in net.doo.snap.dcscanner
Performs detection and recognition of disability certificate data
dcScanner() - Method in class net.doo.snap.ScanbotSDK
Provides DCScanner.
DCScannerFrameHandler - Class in net.doo.snap.dcscanner
Performs Disability Certificates data detection on camera preview frames. Outputs results via DCScannerFrameHandler.ResultHandler (DCScannerFrameHandler.addResultHandler). Preview frame considered intercepted if at least one DCScannerFrameHandler.ResultHandler returns true from DCScannerFrameHandler.ResultHandler.handleResult
DCScannerFrameHandler() - Constructor for class net.doo.snap.dcscanner.DCScannerFrameHandler
 
DCScannerFrameHandler.ResultHandler - Interface in net.doo.snap.dcscanner
Continuously notified about DC data detection results.
decodeWithState() - Method in class io.scanbot.sdk.barcode.GoogleVisionBarcodeDetector
 
decodeWithState() - Method in class io.scanbot.sdk.barcode.GoogleVisionBarcodeDetector
 
decodeWithState() - Method in interface io.scanbot.sdk.barcode.ScanbotBarcodeDetector
Decode the data within the viewfinder rectangle, and time how long it took. For efficiency, reuse the same reader objects from one decode to the next.
decodeWithState() - Method in interface io.scanbot.sdk.barcode.ScanbotBarcodeDetector
Decode the data within the viewfinder rectangle, and time how long it took. For efficiency, reuse the same reader objects from one decode to the next.
decodeWithState() - Method in class io.scanbot.sdk.barcode.ZXingBarcodeDetector
 
decodeWithState() - Method in class io.scanbot.sdk.barcode.ZXingBarcodeDetector
 
decodeWithState() - Method in class net.doo.snap.camera.barcode.GoogleVisionBarcodeDetector
 
decodeWithState() - Method in class net.doo.snap.camera.barcode.GoogleVisionBarcodeDetector
 
decodeWithState() - Method in interface net.doo.snap.camera.barcode.ScanbotBarcodeDetector
Decode the data within the viewfinder rectangle, and time how long it took. For efficiency, reuse the same reader objects from one decode to the next.
decodeWithState() - Method in interface net.doo.snap.camera.barcode.ScanbotBarcodeDetector
Decode the data within the viewfinder rectangle, and time how long it took. For efficiency, reuse the same reader objects from one decode to the next.
decodeWithState() - Method in class net.doo.snap.camera.barcode.ZXingBarcodeDetector
 
decodeWithState() - Method in class net.doo.snap.camera.barcode.ZXingBarcodeDetector
 
DEFAULT_POLYGON - Static variable in class net.doo.snap.ui.EditPolygonImageView
 
DefaultDCScanner - Class in net.doo.snap.dcscanner
Performs detection and recognition of DC data
DefaultDCScanner() - Constructor for class net.doo.snap.dcscanner.DefaultDCScanner
 
DefaultMRZScanner - Class in net.doo.snap.mrzscanner
Performs detection and recognition of MRZ data
DefaultMRZScanner() - Constructor for class net.doo.snap.mrzscanner.DefaultMRZScanner
 
DefaultPayFormScanner - Class in net.doo.snap.payformscanner
Performs detection and recognition of German pay forms
DefaultPayFormScanner() - Constructor for class net.doo.snap.payformscanner.DefaultPayFormScanner
 
deletePage() - Method in class net.doo.snap.entity.SnappingDraft
Deletes Page at given position
deletePage() - Method in class net.doo.snap.entity.SnappingDraft
Deletes Page if possible
describeContents() - Method in class io.scanbot.sdk.barcode.entity.BarcodeScanningResult
 
describeContents() - Method in class io.scanbot.sdk.barcode.entity.ResultPoint
 
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() - Constructor for class net.doo.snap.camera.ContourDetectorFrameHandler.DetectedFrame
Deprecated constructor, with missing detectionScore.
DetectedFrame() - Constructor for class net.doo.snap.camera.ContourDetectorFrameHandler.DetectedFrame
 
detectionResult - Variable in class net.doo.snap.camera.ContourDetectorFrameHandler.DetectedFrame
Contour detection result status. Typically used to decide whether contour detection was successful or not and what can be improved from user side.
detectionScore - Variable in class net.doo.snap.camera.ContourDetectorFrameHandler.DetectedFrame
Score of detected frame as double value in [0.0, 100.0].
dispatchDraw() - Method in class net.doo.snap.ui.EditPolygonImageView
 
dispatchDraw() - Method in class net.doo.snap.ui.MagnifierView
 
dispatchDraw() - Method in class net.doo.snap.ui.PolygonView
 
distance() - Static method in class io.scanbot.sdk.barcode.entity.ResultPoint
 
distance() - Static method in class io.scanbot.sdk.barcode.entity.ResultPoint
 
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() - Constructor for class net.doo.snap.entity.Document
 
documentClassifierBlobs() - Method in class net.doo.snap.blob.BlobFactory
 
DocumentDraft - Class in net.doo.snap.process.util
Contains meta information about document being saved
DocumentDraft() - Constructor for class net.doo.snap.process.util.DocumentDraft
 
DocumentDraft() - Constructor for class net.doo.snap.process.util.DocumentDraft
 
documentDraftExtractor() - Method in class io.scanbot.sdk.ScanbotSDK
Provides DocumentDraftExtractor.
documentDraftExtractor() - Method in class io.scanbot.sdk.ScanbotSDKInitializer
Adjust this parameter to specify snapped pages should be combined into documents and in which format
DocumentDraftExtractor - Interface in net.doo.snap.process.draft
Creates net.doo.snap.entity.Document and Page from SnappingDraft and wraps them in DocumentDraft
documentDraftExtractor() - Method in class net.doo.snap.ScanbotSDK
Provides 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() - Constructor for class net.doo.snap.process.DocumentProcessingResult
 
documentProcessor() - Method in class io.scanbot.sdk.ScanbotSDK
Provides DocumentProcessor.
DocumentProcessor - Class in net.doo.snap.process
Saves pdf documents using DocumentDraft source Call in a background thread only. Not thread safe
DocumentProcessor() - Constructor for class net.doo.snap.process.DocumentProcessor
 
documentProcessor() - Method in class net.doo.snap.ScanbotSDK
Provides DocumentProcessor.

E

e() - Method in interface net.doo.snap.util.log.Logger
Writes tag and message to the log on Level#Error
e() - Method in class net.doo.snap.util.log.StubLogger
 
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() - Constructor for class net.doo.snap.ui.EditPolygonImageView
Constructor to embed view in XML layout
EditPolygonImageView.EditPolygonAnimationEndListener - Interface in net.doo.snap.ui
 
enableBarcodeScan() - Method in class io.scanbot.sdk.barcode.GoogleVisionBarcodeDetector
 
enableBarcodeScan() - Method in interface io.scanbot.sdk.barcode.ScanbotBarcodeDetector
 
enableBarcodeScan() - Method in class io.scanbot.sdk.barcode.ZXingBarcodeDetector
 
enableBarcodeScan() - Method in class net.doo.snap.camera.barcode.GoogleVisionBarcodeDetector
 
enableBarcodeScan() - Method in interface net.doo.snap.camera.barcode.ScanbotBarcodeDetector
 
enableBarcodeScan() - Method in class net.doo.snap.camera.barcode.ZXingBarcodeDetector
 
equals() - Method in class io.scanbot.sdk.barcode.entity.ResultPoint
 
equals() - Method in class net.doo.snap.entity.Blob
 
equals() - Method in class net.doo.snap.entity.Document
 
equals() - Method in class net.doo.snap.entity.Page
 
extract() - Method in class net.doo.snap.process.draft.CombinedDocumentDraftExtractor
 
extract() - Method in interface net.doo.snap.process.draft.DocumentDraftExtractor
Extracts DocumentDraft from SnappingDraft
extract() - Method in class net.doo.snap.process.draft.MultipleDocumentsDraftExtractor
 

F

fetch() - Method in class net.doo.snap.blob.BlobManager
Launches asynchronous fetch of a given net.doo.snap.entity.Blob if it is not already available in local destination folder. Might perform blocking operations, so it should not be called from the main thread.
FileChooserUtils - Class in net.doo.snap.util
Provides methods for extracting image path from chooser
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. Frames might come in different orientation from the camera, that's why this value is needed. You might use it to compensate rotation of #polygon.
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
 
getApplication() - Method in class io.scanbot.sdk.persistence.InternalPageStorage
 
getBanksDataFile() - Method in class net.doo.snap.blob.BlobManager
 
getBarcodeFormat() - Method in class io.scanbot.sdk.barcode.entity.BarcodeScanningResult
 
getDataColumn() - Static method in class net.doo.snap.util.FileChooserUtils
Get the value of the data column for this Uri. This is useful for MediaStore Uris, and other file-based ContentProviders.
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
 
getDetectionStatus() - Method in class io.scanbot.sdk.persistence.Page
 
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
 
getDocumentImage(pageId) - Method in interface io.scanbot.sdk.persistence.PageStorage
Provides File containing document image
getDocumentImagePreview(pageId) - Method in interface io.scanbot.sdk.persistence.PageStorage
Provides File containing document image preview
getDocumentName() - Method in class net.doo.snap.entity.SnappingDraft
 
getDocumentType() - Method in class net.doo.snap.entity.Document
 
getFileName() - Method in enum io.scanbot.sdk.persistence.PageStorage.ImageType
 
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
 
getImageFormat() - Method in class io.scanbot.sdk.persistence.PageStorageSettings
 
getImageQuality() - Method in class io.scanbot.sdk.persistence.PageStorageSettings
 
getImageSize() - Method in class net.doo.snap.entity.Page
 
getImageURI(pageId, type) - Method in class io.scanbot.sdk.persistence.PageFileStorage
Provides imageUri URI for provided type
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() - Static method in class net.doo.snap.util.thread.MimeUtils
Detects MIME from document or file name. Returns PDF by default
getMRZTraineddataFile() - Method in class net.doo.snap.blob.BlobManager
 
getName() - Method in class net.doo.snap.entity.Document
 
getNumBits() - Method in class io.scanbot.sdk.barcode.entity.BarcodeScanningResult
 
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
 
getOriginalImage(pageId) - Method in interface io.scanbot.sdk.persistence.PageStorage
Provides File containing original image
getOriginalImagePreview(pageId) - Method in interface io.scanbot.sdk.persistence.PageStorage
Provides File containing original image preview
getPage() - Method in class net.doo.snap.entity.SnappingDraft
 
getPageDir(pageId) - Method in interface io.scanbot.sdk.persistence.PageStorage
Provides directory to save image files for current Page
getPageFileStorage() - Method in class io.scanbot.sdk.ScanbotSDK
Provides PageFileStorage.
getPageId() - Method in class io.scanbot.sdk.persistence.Page
 
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
 
getPagesDirectory() - Method in class io.scanbot.sdk.persistence.InternalPageStorage
Provides directory which store all pages
getPagesDirectory() - Method in interface io.scanbot.sdk.persistence.PageStorage
Provides directory which store all pages
getPagesDirectory$module(context) - Method in class io.scanbot.sdk.persistence.InternalPageStorage
 
getParameters() - Method in class net.doo.snap.entity.Page
 
getPath() - Static method in class net.doo.snap.util.FileChooserUtils
Get a file path from a Uri. This will get the the path for Storage Access Framework Documents, as well as the _data field for the MediaStore and other file-based ContentProviders.
getPolygon() - Method in class io.scanbot.sdk.persistence.Page
 
getPolygon() - Method in class net.doo.snap.entity.Page
 
getPolygon() - Method in class net.doo.snap.ui.EditPolygonImageView
 
getPosition() - Method in class net.doo.snap.entity.SnappingDraft
 
getPreviewBuffer() - Method in class net.doo.snap.camera.ScanbotCameraView
 
getPreviewImageURI(pageId, type) - Method in class io.scanbot.sdk.persistence.PageFileStorage
Provides preview imageUri URI for provided type
getPreviewTargetMax() - Method in class io.scanbot.sdk.persistence.PageStorageSettings
 
getRawBytes() - Method in class io.scanbot.sdk.barcode.entity.BarcodeScanningResult
 
getRemotePath() - Method in class net.doo.snap.entity.Blob
 
getResultPoints() - Method in class io.scanbot.sdk.barcode.entity.BarcodeScanningResult
 
getRotationType() - Method in class net.doo.snap.entity.Page
 
getSdkComponent() - Method in class io.scanbot.sdk.ScanbotSDK
 
getSdkComponent() - Method in class net.doo.snap.ScanbotSDK
 
getSize() - Method in class net.doo.snap.entity.Document
 
getStoredPages() - Method in class io.scanbot.sdk.persistence.PageFileStorage
Provides List with all pageIds
getStoredPages() - Method in interface io.scanbot.sdk.persistence.PageStorage
Provides List with all pageIds
getSupportedPictureSizes() - Method in class net.doo.snap.camera.ScanbotCameraView
 
getSupportedPreviewSizes() - Method in class net.doo.snap.camera.ScanbotCameraView
 
getText() - Method in class io.scanbot.sdk.barcode.entity.BarcodeScanningResult
 
getThumbnailUri() - Method in class net.doo.snap.entity.Document
 
getTimestamp() - Method in class io.scanbot.sdk.barcode.entity.BarcodeScanningResult
 
getUnreferencedDocuments() - Method in class net.doo.snap.persistence.cleanup.BaseUnreferencedSourcesProvider
 
getUnreferencedDocuments() - Method in interface net.doo.snap.persistence.cleanup.UnreferencedSourcesProvider
 
getUnreferencedPages() - Method in class net.doo.snap.persistence.cleanup.BaseUnreferencedSourcesProvider
 
getUnreferencedPages() - Method in interface net.doo.snap.persistence.cleanup.UnreferencedSourcesProvider
 
getX() - Method in class io.scanbot.sdk.barcode.entity.ResultPoint
 
getY() - Method in class io.scanbot.sdk.barcode.entity.ResultPoint
 
GoogleVisionBarcodeDetector - Class in io.scanbot.sdk.barcode
Manages barcode detection operations and detector initialization
GoogleVisionBarcodeDetector() - Constructor for class io.scanbot.sdk.barcode.GoogleVisionBarcodeDetector
 
GoogleVisionBarcodeDetector - Class in net.doo.snap.camera.barcode
Manages barcode detection operations and detector initialization
GoogleVisionBarcodeDetector() - Constructor for class net.doo.snap.camera.barcode.GoogleVisionBarcodeDetector
 

H

handleFrame() - Method in class io.scanbot.sdk.barcode.BarcodeDetectorFrameHandler
 
handleFrame() - Method in class net.doo.snap.camera.BarcodeDetectorFrameHandler
 
handleFrame() - Method in class net.doo.snap.camera.ContourDetectorFrameHandler
 
handleFrame() - Method in interface net.doo.snap.camera.PreviewBuffer.FrameHandler
Invoked for every new camera preview frame
handleFrame() - Method in class net.doo.snap.dcscanner.DCScannerFrameHandler
 
handleFrame() - Method in class net.doo.snap.mrzscanner.MRZScannerFrameHandler
 
handleFrame() - Method in class net.doo.snap.payformscanner.PayFormScannerFrameHandler
 
handleResult() - Method in interface io.scanbot.sdk.barcode.BarcodeDetectorFrameHandler.ResultHandler
Called every time barcode/QR code detection was performed on a frame.
handleResult() - Method in interface net.doo.snap.camera.BarcodeDetectorFrameHandler.ResultHandler
Called every time barcode/QR code detection was performed on a frame.
handleResult() - Method in interface net.doo.snap.camera.ContourDetectorFrameHandler.ResultHandler
Called every time contour detection was performed on a frame.
handleResult() - Method in interface net.doo.snap.dcscanner.DCScannerFrameHandler.ResultHandler
Called every time DC data detection was performed on a frame.
handleResult() - Method in interface net.doo.snap.mrzscanner.MRZScannerFrameHandler.ResultHandler
Called every time MRZ data detection was performed on a frame.
handleResult() - Method in interface net.doo.snap.payformscanner.PayFormScannerFrameHandler.ResultHandler
Called every time pay form detection was performed on a frame.
handleResult() - Method in class net.doo.snap.ui.PolygonView
 
hasActiveDownloads() - Method in class net.doo.snap.blob.BlobManager
 
hashCode() - Method in class io.scanbot.sdk.barcode.entity.ResultPoint
 
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() - Method in interface net.doo.snap.util.log.Logger
Writes tag and message to the log on Level#Information
i() - Method in class net.doo.snap.util.log.StubLogger
 
imageFormat(imageFormat) - Method in class io.scanbot.sdk.persistence.PageStorageSettings.Builder
Sets image format, which will be used by Scanbot framework enum CameraImageFormat
imageQuality(imageQuality) - Method in class io.scanbot.sdk.persistence.PageStorageSettings.Builder
Sets image quality in a imageScale of 0,100
ImageQualityOptimizer - Class in net.doo.snap.util.bitmap
Optimizes image quality {@see #optimizeImage}
ImageQualityOptimizer.PaperFormat - Enum in net.doo.snap.util.bitmap
Contains common paper formats (width and height in inches)
ImageType(fileName) - Constructor for enum io.scanbot.sdk.persistence.PageStorage.ImageType
Types of images to be saved on disk
initialize() - Method in class io.scanbot.sdk.ScanbotSDKInitializer
Initializes Scanbot SDK library
initialize() - Method in class net.doo.snap.ScanbotSDKInitializer
Initializes Scanbot SDK library
initialized - Static variable in class io.scanbot.sdk.ScanbotSDKInitializer
 
initialized - Static variable in class net.doo.snap.ScanbotSDKInitializer
 
InternalPageStorage - Class in io.scanbot.sdk.persistence
Implementation of PageStorageBase that is based on ExternalFilesDir
InternalPageStorage(application) - Constructor for class io.scanbot.sdk.persistence.InternalPageStorage
Implementation of PageStorageBase that is based on ExternalFilesDir
io.scanbot.sdk - package io.scanbot.sdk
 
io.scanbot.sdk.barcode - package io.scanbot.sdk.barcode
 
io.scanbot.sdk.barcode.entity - package io.scanbot.sdk.barcode.entity
 
io.scanbot.sdk.persistence - package io.scanbot.sdk.persistence
 
io.scanbot.sdk.ui.camera - package io.scanbot.sdk.ui.camera
 
isBlobAvailable() - Method in class net.doo.snap.blob.BlobManager
 
isCombined() - Method in class net.doo.snap.entity.SnappingDraft
 
isDownloadsDocument() - Static method in class net.doo.snap.util.FileChooserUtils
 
isEmpty() - Method in class net.doo.snap.entity.SnappingDraft
 
isEnabled() - Method in class io.scanbot.sdk.barcode.BarcodeDetectorFrameHandler
 
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.dcscanner.DCScannerFrameHandler
 
isEnabled() - Method in class net.doo.snap.mrzscanner.MRZScannerFrameHandler
 
isEnabled() - Method in class net.doo.snap.payformscanner.PayFormScannerFrameHandler
 
isExternalStorageDocument() - Static method in class net.doo.snap.util.FileChooserUtils
 
isInitialized() - Static method in class io.scanbot.sdk.ScanbotSDKInitializer
 
isInitialized() - Static method in class net.doo.snap.ScanbotSDKInitializer
 
isLicenseActive() - Method in class io.scanbot.sdk.ScanbotSDK
Provides the status of the license. Returned value is consistent during lifetime of the process, i.e. if license is active at application start-up it will remain that way until app will be killed.
isLicenseActive() - Method in class net.doo.snap.ScanbotSDK
Provides the status of the license. Returned value is consistent during lifetime of the process, i.e. if license is active at application start-up it will remain that way until app will be killed.
isLicenseValid() - Method in class io.scanbot.sdk.ScanbotSDK
Provides the status of the license. Returned value is consistent during lifetime of the process, i.e. if license is active at application start-up it will remain that way until app will be killed.
isLicenseValid() - Method in class net.doo.snap.ScanbotSDK
Provides the status of the license. Returned value is consistent during lifetime of the process, i.e. if license is active at application start-up it will remain that way until app will be killed.
isMediaDocument() - 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() - Static method in enum net.doo.snap.entity.Language
 
languageClassifierBlobPath() - Method in class io.scanbot.sdk.ScanbotSDKInitializer
Set Scanbot SDK language classifier blob path
languageClassifierBlobPath() - Method in class net.doo.snap.ScanbotSDKInitializer
Set Scanbot SDK language classifier blob path
languageCodes() - Static method in enum net.doo.snap.entity.Language
 
languageDetectorBlobs() - Method in class net.doo.snap.blob.BlobFactory
 
license() - Method in class io.scanbot.sdk.ScanbotSDKInitializer
Set Scanbot SDK license
license() - 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() - Method in interface net.doo.snap.util.log.Logger
Shows log for exception
logException() - Method in class net.doo.snap.util.log.StubLogger
 
logger - Variable in class io.scanbot.sdk.ScanbotSDKInitializer
 
logger() - Method in class io.scanbot.sdk.ScanbotSDKInitializer
Adjust this parameter to specify which Logger should be used. To set a custom logger ScanbotSDKInitializer.withLogging must be set to true
logger - Variable in class net.doo.snap.ScanbotSDKInitializer
 
logger() - Method in class net.doo.snap.ScanbotSDKInitializer
Adjust this parameter to specify which Logger should be used. To set a custom logger ScanbotSDKInitializer.withLogging must be set to true
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
logMethod() - Method in class net.doo.snap.util.log.StubLogger
 

M

MagnifierView - Class in net.doo.snap.ui
View that draws magnifier. Magnifier should be properly set up before draw
MagnifierView() - Constructor for class net.doo.snap.ui.MagnifierView
 
MimeUtils - Class in net.doo.snap.util.thread
Utils connected to mime detection
mrzScanner() - Method in class io.scanbot.sdk.ScanbotSDK
Provides MRZScanner.
MRZScanner - Interface in net.doo.snap.mrzscanner
Performs detection and recognition of MRZ data
mrzScanner() - Method in class net.doo.snap.ScanbotSDK
Provides MRZScanner.
MRZScannerFrameHandler - Class in net.doo.snap.mrzscanner
Performs MRZ data detection on camera preview frames. Outputs results via MRZScannerFrameHandler.ResultHandler (MRZScannerFrameHandler.addResultHandler). Preview frame considered intercepted if at least one MRZScannerFrameHandler.ResultHandler returns true from MRZScannerFrameHandler.ResultHandler.handleResult
MRZScannerFrameHandler() - Constructor for class net.doo.snap.mrzscanner.MRZScannerFrameHandler
 
MRZScannerFrameHandler.ResultHandler - Interface in net.doo.snap.mrzscanner
Continuously notified about MRZ data detection results.
mrzTraineddataBlob() - Method in class net.doo.snap.blob.BlobFactory
 
MultipleDocumentsDraftExtractor - Class in net.doo.snap.process.draft
Extracts separate document draft for each page of SnappingDraft
MultipleDocumentsDraftExtractor() - 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.camera.barcode - package net.doo.snap.camera.barcode
 
net.doo.snap.dcscanner - package net.doo.snap.dcscanner
 
net.doo.snap.entity - package net.doo.snap.entity
 
net.doo.snap.intelligence - package net.doo.snap.intelligence
 
net.doo.snap.mrzscanner - package net.doo.snap.mrzscanner
 
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
 
NULL - Variable in interface net.doo.snap.camera.AutoSnappingController.AutoSnappingCallback
Null-object pattern
NULL - Variable in interface net.doo.snap.camera.CameraOpenCallback
Null-object pattern
NULL - Variable in interface net.doo.snap.camera.PictureCallback
Null-object pattern

O

ocrBlobsPath() - Method in class io.scanbot.sdk.ScanbotSDKInitializer
Set Scanbot SDK OCR blobs path
ocrBlobsPath() - Method in class net.doo.snap.ScanbotSDKInitializer
Set Scanbot SDK OCR blobs path
ocrLanguageBlobs() - 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. Perform OCR during this process.
OcrPdfRenderer() - Constructor for class net.doo.snap.intelligence.OcrPdfRenderer
 
OcrPdfRenderer.RenderIterator - Interface in net.doo.snap.intelligence
Controls render process. OCR performed as iterator advances. RenderIterator must be recycled after usage:
OcrResult - Class in net.doo.snap.process
Represents result of OCR-performing. Contains recognized text as a String and optional sandwiched pdf file
OcrResult() - Constructor for class net.doo.snap.process.OcrResult
 
OcrResultBlock - Class in net.doo.snap.process
Part of the optical character recognitions result. Each block represents a text paragraph, a text line or a word and contains information about it, like the found text, the bounding box, where in the image the paragraph/line/word can be found, the confidence value and the type.
OcrResultBlock() - 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.
onAnimationEnded() - Method in interface net.doo.snap.ui.EditPolygonImageView.EditPolygonAnimationEndListener
 
onAttachedToWindow() - Method in class io.scanbot.sdk.ui.camera.ShutterButton
 
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. Might intercept and cancel the shooting.
onCameraOpened() - Method in interface net.doo.snap.camera.CameraOpenCallback
Called when camera is opened and ready for shooting
onDetachedFromWindow() - Method in class io.scanbot.sdk.ui.camera.ShutterButton
 
onDetachedFromWindow() - Method in class net.doo.snap.ui.EditPolygonImageView
 
onDetachedFromWindow() - Method in class net.doo.snap.ui.MagnifierView
 
onLayout() - Method in class net.doo.snap.camera.ScanbotCameraView
 
onLayout() - Method in class net.doo.snap.ui.EditPolygonImageView
 
onLayout() - Method in class net.doo.snap.ui.MagnifierView
 
onMeasure() - Method in class net.doo.snap.camera.ScanbotCameraView
 
onMeasure() - Method in class net.doo.snap.ui.EditPolygonImageView
 
onPause() - Method in class net.doo.snap.camera.ScanbotCameraView
Notifies view that enclosing android.app.Activity or android.app.Fragment was paused and therefore camera must be closed.
onPictureTaken() - 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 android.app.Activity or android.app.Fragment was resumed and therefore camera can be started.
onSizeChanged() - Method in class net.doo.snap.ui.PolygonView
 
onTouchEvent() - Method in class net.doo.snap.ui.EditPolygonImageView
 
optimizeImage() - Method in class net.doo.snap.util.bitmap.ImageQualityOptimizer
Scales image to desirable quality.
optimizeImage() - Method in class net.doo.snap.util.bitmap.ImageQualityOptimizer
Scales image to desirable quality.
orderBestPatterns() - Static method in class io.scanbot.sdk.barcode.entity.ResultPoint
Orders an array of three ResultPoints in an order [A,B,C] such that AB is less than AC and BC is less than AC, and the angle between BC and BA is less than 180 degrees.

P

Page - Class in io.scanbot.sdk.persistence
Object which represents snapped document
Page(pageId, polygon, detectionStatus) - Constructor for class io.scanbot.sdk.persistence.Page
Object which represents snapped document
Page() - Constructor for class io.scanbot.sdk.persistence.Page
Object which represents snapped document
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() - 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() - Method in class io.scanbot.sdk.ScanbotSDK
Provides PageFactory.
PageFactory - Class in net.doo.snap.persistence
Creates Pages and saves their content in file system
PageFactory() - 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.
PageFileStorage - Class in io.scanbot.sdk.persistence
Interactor class which could operate with Page files
PageFileStorage(pageProcessorInteractor, pageStorage) - Constructor for class io.scanbot.sdk.persistence.PageFileStorage
Interactor class which could operate with Page files
PageFileStorage.PageFileType - Enum in io.scanbot.sdk.persistence
Type of the page file ORIGINAL state for the original war picture DOCUMENT state for the picture after processing
PageFileType() - Constructor for enum io.scanbot.sdk.persistence.PageFileStorage.PageFileType
Type of the page file ORIGINAL state for the original war picture DOCUMENT state for the picture after processing
PageStorage - Interface in io.scanbot.sdk.persistence
Interface providing easy methods to work with Page image objects
PageStorage.ImageType - Enum in io.scanbot.sdk.persistence
Types of images to be saved on disk
PageStorageSettings - Class in io.scanbot.sdk.persistence
Class collecting all params needed to save images on device
PageStorageSettings.Builder - Class in io.scanbot.sdk.persistence
 
paragraphs - Variable in class net.doo.snap.process.OcrResult
The List of OcrResultBlock objects containing all blocks of type OcrResultBlock.OcrResultBlockType#PARAGRAPH.
payFormScanner() - Method in class io.scanbot.sdk.ScanbotSDK
Provides net.doo.snap.payformscanner.PayFormScanner.
PayFormScanner - Interface in net.doo.snap.payformscanner
Performs detection and recognition of pay forms
payFormScanner() - Method in class net.doo.snap.ScanbotSDK
Provides net.doo.snap.payformscanner.PayFormScanner.
PayFormScannerFrameHandler - Class in net.doo.snap.payformscanner
Performs pay form detection on camera preview frames. Outputs results via PayFormScannerFrameHandler.ResultHandler (PayFormScannerFrameHandler.addResultHandler). Preview frame considered intercepted if at least one PayFormScannerFrameHandler.ResultHandler returns true from PayFormScannerFrameHandler.ResultHandler.handleResult
PayFormScannerFrameHandler() - 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. If no polygon was detected - empty list. Points of polygon are normalized values between 0 and 1 relatively to the size of the frame. For instance, point.x = 0.5f means that point is centered horizontally in the frame. point.y = 1.0f means that point is at the bottom of the frame and so on. Note, that points are not rotated by #frameOrientation.
PolygonView - Class in net.doo.snap.ui
Draws polygon
PolygonView() - Constructor for class net.doo.snap.ui.PolygonView
 
PolygonView() - Constructor for class net.doo.snap.ui.PolygonView
 
preVerifyForm() - Method in class net.doo.snap.payformscanner.DefaultPayFormScanner
 
preVerifyForm() - Method in interface net.doo.snap.payformscanner.PayFormScanner
Performs pay form preverifying on the NV21 format image
preVerifyForm() - Method in class net.doo.snap.payformscanner.StubPayFormScanner
 
preVerifyFormBGR() - Method in class net.doo.snap.payformscanner.DefaultPayFormScanner
 
preVerifyFormBGR() - Method in interface net.doo.snap.payformscanner.PayFormScanner
Performs pay form preverifying on the BGR format image
preVerifyFormBGR() - Method in class net.doo.snap.payformscanner.StubPayFormScanner
 
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
previewTargetMax(previewTargetMax) - Method in class io.scanbot.sdk.persistence.PageStorageSettings.Builder
Sets preview image target max dimension. Image will be scaled down with the maximum dimension equals previewTargetMax
processDocument() - 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
recognizeDC() - Method in interface net.doo.snap.dcscanner.DCScanner
Performs DC data recognition on the NV21 format image
recognizeDC() - Method in class net.doo.snap.dcscanner.DefaultDCScanner
 
recognizeDC() - Method in class net.doo.snap.dcscanner.StubDCScanner
 
recognizeDCBGR() - Method in interface net.doo.snap.dcscanner.DCScanner
Performs DC data recognition on the BGR format image
recognizeDCBGR() - Method in class net.doo.snap.dcscanner.DefaultDCScanner
 
recognizeDCBGR() - Method in class net.doo.snap.dcscanner.StubDCScanner
 
recognizeDCBitmap() - Method in interface net.doo.snap.dcscanner.DCScanner
Performs DC data recognition on the Bitmap
recognizeDCBitmap() - Method in class net.doo.snap.dcscanner.DefaultDCScanner
 
recognizeDCBitmap() - Method in class net.doo.snap.dcscanner.StubDCScanner
 
recognizeDCJPEG() - Method in interface net.doo.snap.dcscanner.DCScanner
Performs DC data recognition on the JPEG image
recognizeDCJPEG() - Method in class net.doo.snap.dcscanner.DefaultDCScanner
 
recognizeDCJPEG() - Method in class net.doo.snap.dcscanner.StubDCScanner
 
recognizedText - Variable in class net.doo.snap.process.OcrResult
Recognized text as a String
recognizeForm() - Method in class net.doo.snap.payformscanner.DefaultPayFormScanner
 
recognizeForm() - Method in interface net.doo.snap.payformscanner.PayFormScanner
Performs pay form recognition on the NV21 format image
recognizeForm() - Method in class net.doo.snap.payformscanner.StubPayFormScanner
 
recognizeFormBGR() - Method in class net.doo.snap.payformscanner.DefaultPayFormScanner
 
recognizeFormBGR() - Method in interface net.doo.snap.payformscanner.PayFormScanner
Performs pay form recognition on the BGR format image
recognizeFormBGR() - Method in class net.doo.snap.payformscanner.StubPayFormScanner
 
recognizeMRZ() - Method in class net.doo.snap.mrzscanner.DefaultMRZScanner
 
recognizeMRZ() - Method in interface net.doo.snap.mrzscanner.MRZScanner
Performs MRZ data recognition on the NV21 format image
recognizeMRZ() - Method in class net.doo.snap.mrzscanner.StubMRZScanner
 
recognizeMRZBGR() - Method in class net.doo.snap.mrzscanner.DefaultMRZScanner
 
recognizeMRZBGR() - Method in interface net.doo.snap.mrzscanner.MRZScanner
Performs MRZ data recognition on the BGR format image
recognizeMRZBGR() - Method in class net.doo.snap.mrzscanner.StubMRZScanner
 
recognizeMRZBitmap() - Method in class net.doo.snap.mrzscanner.DefaultMRZScanner
 
recognizeMRZBitmap() - Method in interface net.doo.snap.mrzscanner.MRZScanner
Performs MRZ data recognition on the Bitmap
recognizeMRZBitmap() - Method in class net.doo.snap.mrzscanner.StubMRZScanner
 
recognizeMRZJPEG() - Method in class net.doo.snap.mrzscanner.DefaultMRZScanner
 
recognizeMRZJPEG() - Method in interface net.doo.snap.mrzscanner.MRZScanner
Performs MRZ data recognition on the JPEG image
recognizeMRZJPEG() - Method in class net.doo.snap.mrzscanner.StubMRZScanner
 
recognizeMRZWithFinderOverlay() - Method in class net.doo.snap.mrzscanner.DefaultMRZScanner
 
recognizeMRZWithFinderOverlay() - Method in interface net.doo.snap.mrzscanner.MRZScanner
Performs MRZ data recognition on the NV21 format image in specified finder overlay rect
recognizeMRZWithFinderOverlay() - Method in class net.doo.snap.mrzscanner.StubMRZScanner
 
recycle() - Method in interface net.doo.snap.intelligence.OcrPdfRenderer.RenderIterator
Frees resources held by RenderIterator
remove(pageId) - Method in class io.scanbot.sdk.persistence.PageFileStorage
Removes all files for pageId
removeAll() - Method in class io.scanbot.sdk.persistence.PageFileStorage
Removes all files
removeAllExcept(pageIds) - Method in class io.scanbot.sdk.persistence.PageFileStorage
Removes all files, except list of provided pages
removeFrameHandler() - Method in interface net.doo.snap.camera.PreviewBuffer
Unregisters net.doo.snap.camera.PreviewBuffer.FrameHandler.
removePictureCallback() - Method in class net.doo.snap.camera.ScanbotCameraView
Removes callback, so it won't receive any further notifications.
removeResultHandler() - Method in class io.scanbot.sdk.barcode.BarcodeDetectorFrameHandler
Unregisters handler.
removeResultHandler() - Method in class net.doo.snap.camera.BarcodeDetectorFrameHandler
Unregisters handler.
removeResultHandler() - Method in class net.doo.snap.camera.ContourDetectorFrameHandler
Unregisters handler.
removeResultHandler() - Method in class net.doo.snap.dcscanner.DCScannerFrameHandler
Unregisters handler.
removeResultHandler() - Method in class net.doo.snap.mrzscanner.MRZScannerFrameHandler
Unregisters handler.
removeResultHandler() - 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() - Method in class net.doo.snap.entity.SnappingDraft
Replaces page at given position with new page
Result() - Constructor for class net.doo.snap.persistence.PageFactory.Result
 
ResultPoint - Class in io.scanbot.sdk.barcode.entity
Encapsulates a point of interest in an image containing a barcode. Typically, this would be the location of a finder pattern or the corner of the barcode, for example.
ResultPoint() - Constructor for class io.scanbot.sdk.barcode.entity.ResultPoint
 
ResultPoint() - Constructor for class io.scanbot.sdk.barcode.entity.ResultPoint
 
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)
ScanbotBarcodeDetector - Interface in io.scanbot.sdk.barcode
Detects bar codes and QR codes
ScanbotBarcodeDetector - Interface in net.doo.snap.camera.barcode
Detects bar codes and QR codes
ScanbotBarcodeDetector.BarcodeDetectorType - Enum in io.scanbot.sdk.barcode
Supported barcode detector libraries
ScanbotBarcodeDetector.BarcodeDetectorType - Enum in net.doo.snap.camera.barcode
Supported barcode detector libraries
ScanbotCameraView - Class in net.doo.snap.camera
Provides interface to native Camera and displays camera stream. Use this class if you want to fine-tune camera behavior. It is required to pass android.app.Activity (or android.app.Fragment) lifecycle events to this view: ScanbotCameraView.onResume, ScanbotCameraView.onPause. They are used to automatically start and stop camera. It is possible to include other views inside of ScanbotCameraView. In such case they will be drawn on top of camera preview with size matching the camera frame. You can use this fact to draw overlays on top of camera. In particular, you can use net.doo.snap.ui.PolygonView. Preview frames are provided via PreviewBuffer: ScanbotCameraView.getPreviewBuffer.
ScanbotCameraView() - Constructor for class net.doo.snap.camera.ScanbotCameraView
 
ScanbotCameraView() - Constructor for class net.doo.snap.camera.ScanbotCameraView
 
ScanbotSDK - Class in io.scanbot.sdk
Provider for Scanbot SDK features. Typical use case is to create this object in Activity#onCreate(Bundle) or Service#onCreate(), but it's allowed to create it during any other point of lifecycle before onDestroy. Note that each instance stores reference to given context, so it should not be cached statically. All necessary caching is already done by ScanbotSDK itself - some methods might return same instance repeatedly. Some insight - Scanbot uses Dependency Injection internally, but we do not want to expose it to users of the library to ensure that changes in DI implementation won't affect users of the library.
ScanbotSDK() - Constructor for class io.scanbot.sdk.ScanbotSDK
 
ScanbotSDK() - Constructor for class io.scanbot.sdk.ScanbotSDK
 
ScanbotSDK() - Constructor for class io.scanbot.sdk.ScanbotSDK
 
ScanbotSDK() - Constructor for class io.scanbot.sdk.ScanbotSDK
 
ScanbotSDK - Class in net.doo.snap
 
ScanbotSDK() - Constructor for class net.doo.snap.ScanbotSDK
 
ScanbotSDK() - Constructor for class net.doo.snap.ScanbotSDK
 
ScanbotSDK() - Constructor for class net.doo.snap.ScanbotSDK
 
ScanbotSDK() - Constructor for class net.doo.snap.ScanbotSDK
 
ScanbotSDKInitializer - Class in io.scanbot.sdk
Initializes Scanbot SDK library. Use it to set up desired components and then call ScanbotSDKInitializer.initialize. Can be initialized only once.
ScanbotSDKInitializer - Class in net.doo.snap
 
sdkComponent - Static variable in class io.scanbot.sdk.ScanbotSDK
 
sdkComponent - Static variable in class net.doo.snap.ScanbotSDK
 
setAcceptedAngleScore() - Method in class net.doo.snap.camera.ContourDetectorFrameHandler
The minimum score in percent (0 - 100) of the perspective distortion to accept a detected document. Default is 75.0. Set lower values to accept more perspective distortion. Warning: Lower values result in more blurred document images.
setAcceptedSizeScore() - Method in class net.doo.snap.camera.ContourDetectorFrameHandler
The minimum size in percent (0 - 100) of the screen size to accept a detected document. It is sufficient that height or width match the score. Default is 80.0. Warning: Lower values result in low resolution document images.
setAutoFocusOnTouch() - Method in class net.doo.snap.camera.ScanbotCameraView
 
setAutoFocusSound() - Method in class net.doo.snap.camera.ScanbotCameraView
Set camera auto focus sound state. true if system sound should be played on successful auto focus event, false - otherwise. By default, the camera plays the system-defined camera auto focus sound when autoFocus() is called.
setAutoSnappingCallback() - Method in class net.doo.snap.camera.AutoSnappingController
 
setBarcodeFormatsFilter() - Method in class io.scanbot.sdk.barcode.BarcodeDetectorFrameHandler
Sets List BarcodeFormat to scan
setBarcodeFormatsFilter() - Method in class io.scanbot.sdk.barcode.GoogleVisionBarcodeDetector
 
setBarcodeFormatsFilter() - Method in interface io.scanbot.sdk.barcode.ScanbotBarcodeDetector
Sets list of BarcodeFormat to scan
setBarcodeFormatsFilter() - Method in class io.scanbot.sdk.barcode.ZXingBarcodeDetector
 
setCameraOpenCallback() - Method in class net.doo.snap.camera.ScanbotCameraView
Callback which will be invoked when camera will be opened
setCombined() - Method in class net.doo.snap.entity.SnappingDraft
 
setDate() - Method in class net.doo.snap.entity.Document
 
setDetectionInterval() - Method in class io.scanbot.sdk.barcode.BarcodeDetectorFrameHandler
Set barcode detection interval in milliseconds
setDetectionInterval() - Method in class net.doo.snap.camera.BarcodeDetectorFrameHandler
Set barcode detection interval in milliseconds
setDocumentName() - Method in class net.doo.snap.entity.SnappingDraft
 
setDocumentType() - Method in class net.doo.snap.entity.Document
 
setEdgeColor() - Method in class net.doo.snap.ui.EditPolygonImageView
Sets edge color
setEdgeColorOnLine() - Method in class net.doo.snap.ui.EditPolygonImageView
Sets edge color on line
setEdgeWidth() - Method in class net.doo.snap.ui.EditPolygonImageView
Sets edge width in pixels
setEditPolygonAnimationEndListener() - Method in class net.doo.snap.ui.EditPolygonImageView
sets listener which will be invoked when animation will be finished
setEnableBounding() - Method in class net.doo.snap.ui.MagnifierView
Enables Bounding of magnifier view
setEnabled() - Method in class io.scanbot.sdk.barcode.BarcodeDetectorFrameHandler
 
setEnabled() - Method in class net.doo.snap.camera.AutoSnappingController
 
setEnabled() - Method in class net.doo.snap.camera.BarcodeDetectorFrameHandler
 
setEnabled() - Method in class net.doo.snap.camera.ContourDetectorFrameHandler
 
setEnabled() - Method in class net.doo.snap.dcscanner.DCScannerFrameHandler
 
setEnabled() - Method in class net.doo.snap.mrzscanner.MRZScannerFrameHandler
 
setEnabled() - Method in class net.doo.snap.payformscanner.PayFormScannerFrameHandler
 
setFillColor() - Method in class net.doo.snap.ui.PolygonView
Changes fill color of the polygon
setFillColorOK() - Method in class net.doo.snap.ui.PolygonView
Changes fill color of the polygon when result is OK
setId() - Method in class net.doo.snap.entity.Document
 
setIgnoreBadAspectRatio() - Method in class net.doo.snap.camera.AutoSnappingController
Sets flag which enables/disables BadAspectRatio detection ignorance. By default - false
setImageForId(image, existingPageId, type) - Method in class io.scanbot.sdk.persistence.PageFileStorage
Replace images for type, for existingPageId
setImageForId(image, existingPageId, type) - Method in class io.scanbot.sdk.persistence.PageFileStorage
Replace images for type, for existingPageId
setImageFormat(p) - Method in class io.scanbot.sdk.persistence.PageStorageSettings
 
setImageQuality(p) - Method in class io.scanbot.sdk.persistence.PageStorageSettings
 
setImageRotation() - Method in class net.doo.snap.ui.MagnifierView
Sets rotation for the image preview when it is magnified
setImageSize() - Method in class net.doo.snap.entity.Page
Saves information about image size for particular ImageType
setLanguage() - Method in class net.doo.snap.entity.Document
 
setLines() - Method in class net.doo.snap.ui.EditPolygonImageView
Sets detected horizontal and vertical lines
setManualButtonDrawable(drawable) - Method in class io.scanbot.sdk.ui.camera.ShutterButton
Sets drawable for button in ManualMode
setName() - Method in class net.doo.snap.entity.Document
 
setOcrStatus() - Method in class net.doo.snap.entity.Document
 
setOcrText() - Method in class net.doo.snap.entity.Document
 
setOptimizationType() - Method in class net.doo.snap.entity.Page
 
setOrientationHardLock() - Method in class net.doo.snap.camera.ScanbotCameraView
Sets orientation hard lock mode.
setPagesCount() - Method in class net.doo.snap.entity.Document
 
setPictureSize() - Method in class net.doo.snap.camera.ScanbotCameraView
Set camera picture size
setPolygon() - Method in class net.doo.snap.entity.Page
Sets polygon which crops page preview from original image. null and polygons with the number of points different from 4 are also ignored
setPolygon() - Method in class net.doo.snap.ui.EditPolygonImageView
Sets polygon containing document coordinates
setPreviewMode() - Method in class net.doo.snap.camera.ScanbotCameraView
Set the camera preview mode. By default - CameraPreviewMode#FILL_IN.
setPreviewSize() - Method in class net.doo.snap.camera.ScanbotCameraView
Set camera preview size
setProcessed() - Method in class net.doo.snap.entity.Page
 
setRotationType() - Method in class net.doo.snap.entity.Page
 
setSensitivity() - Method in class net.doo.snap.camera.AutoSnappingController
Changes sensitivity of auto-snapping. That is: the more sensitive it is the faster it shoots. Sensitivity must be within [0..1] range. A value of 1.0 triggers automatic capturing immediately, a value of 0.0 delays the automatic by 3 seconds. The default value is 0.66 (1 sec)
setShutterButtonAutoInnerColor(color) - Method in class io.scanbot.sdk.ui.camera.ShutterButton
Sets color for button inner elements in AutoMode
setShutterButtonAutoOuterColor(color) - Method in class io.scanbot.sdk.ui.camera.ShutterButton
Sets color for button background in AutoMode
setShutterButtonManualInnerColor(color) - Method in class io.scanbot.sdk.ui.camera.ShutterButton
Sets color for button inner elements in ManualMode
setShutterButtonManualOuterColor(color) - Method in class io.scanbot.sdk.ui.camera.ShutterButton
Sets color for button background in ManualMode
setShutterSound() - Method in class net.doo.snap.camera.ScanbotCameraView
Set camera shutter sound state. true if system sound should be played on the take picture event, false - otherwise. By default, the camera plays the system-defined camera shutter sound when takePicture() is called. Note that devices may not always allow disabling the camera shutter sound. If the shutter sound state cannot be set to the desired value, this method will be ignored.
setSize() - Method in class net.doo.snap.entity.Document
 
setStrokeColor() - Method in class net.doo.snap.ui.PolygonView
Changes stroke color of the polygon.
setStrokeColorOK() - Method in class net.doo.snap.ui.PolygonView
Changes stroke color of the polygon when result is OK.
setStrokeWidth() - Method in class net.doo.snap.ui.PolygonView
Changes width of the stroke of the polygon.
setThumbnailUri() - Method in class net.doo.snap.entity.Document
 
setupMagnifier() - Method in class net.doo.snap.ui.MagnifierView
Setup magnifier using given EditPolygonImageView
showAutoButton() - Method in class io.scanbot.sdk.ui.camera.ShutterButton
Shows button in AutoMode. Starts Animation.
showManualButton() - Method in class io.scanbot.sdk.ui.camera.ShutterButton
Shows button in ManualMode. Stops Animation.
ShutterButton - Class in io.scanbot.sdk.ui.camera
Customizable Button which provides 2 states (Manual and Auto)
ShutterButton(context, attrs) - Constructor for class io.scanbot.sdk.ui.camera.ShutterButton
Customizable Button which provides 2 states (Manual and Auto)
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() - Constructor for class net.doo.snap.entity.SnappingDraft
 
SnappingDraft() - 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. Usually used after picture was taken. Note, that preview is started by default after ScanbotCameraView.onResume, so there is no need to call it at the start of the app. If view is paused, this call is ignored.
startRender() - Method in class net.doo.snap.intelligence.OcrPdfRenderer
Starts render of document into PDF file. Returns RenderIterator which performs OCR and generates document as it being advanced.
stopPreview() - Method in class net.doo.snap.camera.ScanbotCameraView
Stops camera preview stream.
StubDCScanner - Class in net.doo.snap.dcscanner
Stub for DC data detection and recognition
StubDCScanner() - Constructor for class net.doo.snap.dcscanner.StubDCScanner
 
StubLogger - Class in net.doo.snap.util.log
Dummy logger impl for log mode off
StubMRZScanner - Class in net.doo.snap.mrzscanner
Stub for MRZ data detection and recognition
StubMRZScanner() - Constructor for class net.doo.snap.mrzscanner.StubMRZScanner
 
StubPayFormScanner - Class in net.doo.snap.payformscanner
Stub for pey forms detection and recognition
StubPayFormScanner() - Constructor for class net.doo.snap.payformscanner.StubPayFormScanner
 
StubTextRecognition - Class in net.doo.snap.intelligence
Dummy realization of TextRecognition. Part of OCR-feature, which is available only in Scanbot SDK package 2.

T

takePicture() - Method in class net.doo.snap.camera.ScanbotCameraView
Takes picture. This is asynchronous process, so results are reported via PictureCallback added in ScanbotCameraView.addPictureCallback. If snapping process is still going all subsequent calls to ScanbotCameraView.takePicture are ignored. After picture is taken, camera preview is stopped. If you wish it continue, use ScanbotCameraView.startPreview If view is paused, this call is ignored.
text - Variable in class net.doo.snap.process.OcrResultBlock
The recognized text within the receivers bounding box.
textRecognition() - Method in class io.scanbot.sdk.ScanbotSDK
Provides functionality for recognize text. Should be called for each case of text recognition.
TextRecognition - Interface in net.doo.snap.process
Text recognition API.
textRecognition() - Method in class net.doo.snap.ScanbotSDK
Provides functionality for recognize text. Should be called for each case of text recognition.
TextRecognizer - Class in net.doo.snap.process
Performs text recognition.
TextRecognizer() - Constructor for class net.doo.snap.process.TextRecognizer
 
tiffWriter() - Method in class io.scanbot.sdk.ScanbotSDK
Provides io.scanbot.tiffwriter.TIFFWriter.
tiffWriter() - Method in class net.doo.snap.ScanbotSDK
Provides io.scanbot.tiffwriter.TIFFWriter.
toString() - Method in class io.scanbot.sdk.barcode.entity.BarcodeScanningResult
 
toString() - Method in class io.scanbot.sdk.barcode.entity.ResultPoint
 
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() - Method in class io.scanbot.sdk.ScanbotSDKInitializer
Adjust this parameter to specify which files net.doo.snap.persistence.cleanup.Cleaner can safely delete during clean up
UnreferencedSourcesProvider - Interface in net.doo.snap.persistence.cleanup
Provides Collection of sources ids, which are not referenced
unreferencedSourcesProvider() - Method in class net.doo.snap.ScanbotSDKInitializer
Adjust this parameter to specify which files net.doo.snap.persistence.cleanup.Cleaner can safely delete during clean up
useBarcodeDetector() - Method in class io.scanbot.sdk.ScanbotSDKInitializer
Adjust this parameter to specify which ScanbotBarcodeDetector should be used. By default - ScanbotBarcodeDetector.BarcodeDetectorType#ZXing
useBarcodeDetector() - Method in class net.doo.snap.ScanbotSDKInitializer
Adjust this parameter to specify which ScanbotBarcodeDetector should be used. By default - ScanbotBarcodeDetector.BarcodeDetectorType#ZXing
useFlash() - Method in class net.doo.snap.camera.ScanbotCameraView
Enables or disables camera flash. If there is no flash on this device, does nothing. If view is paused, this call is ignored.
useLog - Variable in class io.scanbot.sdk.ScanbotSDKInitializer
 
useLog - Variable in class net.doo.snap.ScanbotSDKInitializer
 
usePageStorageSettings() - Method in class io.scanbot.sdk.ScanbotSDKInitializer
Adjust this parameter to specify which io.scanbot.sdk.persistence.PageStorageSettings should be used.

W

w() - Method in interface net.doo.snap.util.log.Logger
Writes tag and message to the log on Level#Warning
w() - Method in class net.doo.snap.util.log.StubLogger
 
widthInches - Variable in enum net.doo.snap.util.bitmap.ImageQualityOptimizer.PaperFormat
 
withLogging() - Method in class io.scanbot.sdk.ScanbotSDKInitializer
Enables or disables logs in Scanbot SDK. Logs are printed into LogCat as well as saved on the device. You can find them in Environment#getExternalStorageDirectory()/debug_logs/[package_name]. Usually it is /sdcard/debug_logs/[package_name] By default all logs are disabled. If you're using logging, consider switching it off for production builds for security and performance reasons. This method must be called before ScanbotSDKInitializer.initialize, so it is possible to change logging settings before initializing the SDK.
withLogging() - Method in class net.doo.snap.ScanbotSDKInitializer
Enables or disables logs in Scanbot SDK. Logs are printed into LogCat as well as saved on the device. You can find them in Environment#getExternalStorageDirectory()/debug_logs/[package_name]. Usually it is /sdcard/debug_logs/[package_name] By default all logs are disabled. If you're using logging, consider switching it off for production builds for security and performance reasons. This method must be called before ScanbotSDKInitializer.initialize, so it is possible to change logging settings before initializing the SDK.
withoutPDF() - Method in class net.doo.snap.intelligence.StubTextRecognition
 
withoutPDF() - Method in class net.doo.snap.intelligence.StubTextRecognition
 
withoutPDF() - Method in interface net.doo.snap.process.TextRecognition
Provides TextRecognizer which can be used to recognize text.
withoutPDF() - Method in interface net.doo.snap.process.TextRecognition
Provides TextRecognizer which can be used to recognize text.
withPDF() - Method in class net.doo.snap.intelligence.StubTextRecognition
 
withPDF() - Method in class net.doo.snap.intelligence.StubTextRecognition
 
withPDF() - Method in interface net.doo.snap.process.TextRecognition
Provides TextRecognizer which can be used for creating PDF with embedded text recognition result.
withPDF() - 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() - Method in class io.scanbot.sdk.barcode.entity.BarcodeScanningResult
 
writeToParcel() - Method in class io.scanbot.sdk.barcode.entity.ResultPoint
 
writeToParcel() - Method in class net.doo.snap.entity.Document
 
writeToParcel() - Method in class net.doo.snap.entity.Page
 
writeToParcel() - Method in class net.doo.snap.entity.SnappingDraft
 
writeToParcel() - Method in class net.doo.snap.process.util.DocumentDraft
 

Z

ZXingBarcodeDetector - Class in io.scanbot.sdk.barcode
Manages barcode detection operations and detector initialization
ZXingBarcodeDetector() - Constructor for class io.scanbot.sdk.barcode.ZXingBarcodeDetector
 
ZXingBarcodeDetector - Class in net.doo.snap.camera.barcode
Manages barcode detection operations and detector initialization
ZXingBarcodeDetector() - Constructor for class net.doo.snap.camera.barcode.ZXingBarcodeDetector
 
A B C D E F G H I L M N O P R S T U W Z 
Skip navigation links