- addCameraStateCallback(cameraStateCallback) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Adds callback which will be notified about camera state changes. Callbacks are invoked
on a main thread.
- addCameraStateCallback(cameraStateCallback) - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
Adds callback which will be notified about camera state changes. Callbacks are invoked
on a main thread.
- addCameraStateCallback(cameraStateCallback) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Adds callback which will be notified about camera state changes. Callbacks are invoked
on a main thread.
- addCameraZoomDelegate(delegate) - Method in class io.scanbot.sdk.ui.camera.ZoomFinderOverlayView
-
- addFrameHandler(frameHandler) - Method in interface io.scanbot.sdk.camera.PreviewBuffer
-
- addFrameHandler(frameHandler) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Used to add frame handler that will be called on each next frame
- addFrameHandler(frameHandler) - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
Used to add frame handler that will be called on each next frame
- addFrameHandler(frameHandler) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Used to add frame handler that will be called on each next frame
- addPictureCallback(pictureCallback) - Method in class io.scanbot.sdk.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.
- addPictureCallback(pictureCallback) - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
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.
- addPictureCallback(pictureCallback) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
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.
- addTakePictureCallback(cameraTakePictureCallback) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Adds callback which will be notified about take picture operation process. Callbacks are invoked
on a main thread.
- addTakePictureCallback(cameraTakePictureCallback) - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
Adds callback which will be notified about take picture operation process. Callbacks are invoked
on a main thread.
- addTakePictureCallback(cameraTakePictureCallback) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Adds callback which will be notified about take picture operation process. Callbacks are invoked
on a main thread.
- adjustDescriptionPosition(paddingTopBottom) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- allBlobsAvailable(blobs) - Method in class io.scanbot.sdk.blob.BlobManager
-
- ANIMATION_DURATION - Static variable in class io.scanbot.sdk.ui.FadeAnimationView
-
- ANIMATION_LINEAR_DURATION - Static variable in class io.scanbot.sdk.ui.FadeAnimationView
-
- ANIMATION_MAX_VALUE - Static variable in class io.scanbot.sdk.ui.FadeAnimationView
-
- ANIMATION_UNFADE_DURATION - Static variable in class io.scanbot.sdk.ui.FadeAnimationView
-
- approximatePolygonAspectRatio(polygon, frameWidth, frameHeight, frameOrientation) - Static method in class io.scanbot.sdk.util.PolygonHelper
-
Approximate polygon aspect ratio
- approximatePolygonAspectRatio(polygon, frameWidth, frameHeight, frameOrientation) - Method in class io.scanbot.sdk.util.PolygonHelper.Companion
-
Approximate polygon aspect ratio
- autoFocus() - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Performs auto-focus.
- autoFocus() - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
Performs auto-focus.
- autoFocus() - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Performs auto-focus.
- AutoSnappingStateListener.Companion - Class in io.scanbot.sdk.camera.autosnapping
-
- BackgroundThreadFactory - Class in io.scanbot.sdk.util.thread
-
Implementation of ThreadFactory that allows to specify priority of
threads.
- BackgroundThreadFactory(threadPriority, threadNamePrefix) - Constructor for class io.scanbot.sdk.util.thread.BackgroundThreadFactory
-
Implementation of ThreadFactory that allows to specify priority of
threads.
- BackgroundThreadFactory(threadPriority) - Constructor for class io.scanbot.sdk.util.thread.BackgroundThreadFactory
-
Implementation of ThreadFactory that allows to specify priority of
threads.
- BackgroundThreadFactory() - Constructor for class io.scanbot.sdk.util.thread.BackgroundThreadFactory
-
Implementation of ThreadFactory that allows to specify priority of
threads.
- BackgroundThreadFactory.Companion - Class in io.scanbot.sdk.util.thread
-
- BarcodeGradleDependencyException - Exception in io.scanbot.sdk.exceptions.barcode
-
Thrown when there is no Barcode Scanner assets gradle dependency found which is required to run the Barcode scanner
- BarcodeGradleDependencyException() - Constructor for exception io.scanbot.sdk.exceptions.barcode.BarcodeGradleDependencyException
-
Thrown when there is no Barcode Scanner assets gradle dependency found which is required to run the Barcode scanner
- BaseAutoSnappingController<T> - Class in io.scanbot.sdk.camera.autosnapping
-
- BaseAutoSnappingController(cameraView) - Constructor for class io.scanbot.sdk.camera.autosnapping.BaseAutoSnappingController
-
- BaseFileIOProcessor - Interface in io.scanbot.sdk.persistence.fileio
-
Represents base file IO operations
- BasePictureCallback - Interface in io.scanbot.sdk.camera
-
Basic internal Camera picture callback interface
- BasePolygonView - Interface in io.scanbot.sdk.ui
-
Defines component for drawing Polygon on the screen
- BaseResultHandler<D,E> - Interface in io.scanbot.sdk.camera
-
- BatchBarcodesConfigurationException - Exception in io.scanbot.sdk.exceptions.barcode
-
Thrown when batch barcode scanner has invalid configuration
- BatchBarcodesConfigurationException(message) - Constructor for exception io.scanbot.sdk.exceptions.barcode.BatchBarcodesConfigurationException
-
Thrown when batch barcode scanner has invalid configuration
- BINARIES_DIR_NAME - Static variable in class io.scanbot.sdk.persistence.BlobStoreStrategy
-
- bitmapToNv21(src, width, height) - Static method in class io.scanbot.sdk.ui.camera.util.CameraImageUtils
-
Converts Android Bitmap image to NV21 format
- Blob - Class in io.scanbot.sdk.entity
-
Binary large object, which might be stored either on remote storage
or downloaded into local storage
- Blob(localPath, remotePath) - Constructor for class io.scanbot.sdk.entity.Blob
-
Binary large object, which might be stored either on remote storage
or downloaded into local storage
- BlobFactory - Class in io.scanbot.sdk.blob
-
- BlobFactory(blobStoreStrategy, blobsStorage, assetManager) - Constructor for class io.scanbot.sdk.blob.BlobFactory
-
- BlobManager - Class in io.scanbot.sdk.blob
-
Manages binary files on local filesystem and provides access to binary files stored
remotely
- BlobManager(blobStoreStrategy, assetManager, blobFactory) - Constructor for class io.scanbot.sdk.blob.BlobManager
-
Manages binary files on local filesystem and provides access to binary files stored
remotely
- BlobRuntimeException - Exception in io.scanbot.sdk.exceptions.files.blobManager
-
Thrown when there is a problems of accessing blobs files on runtime
- BlobRuntimeException(message) - Constructor for exception io.scanbot.sdk.exceptions.files.blobManager.BlobRuntimeException
-
Thrown when there is a problems of accessing blobs files on runtime
- BlobsConstants - Class in io.scanbot.sdk
-
Contains upload constants
- BlobsDirectoryException - Exception in io.scanbot.sdk.exceptions.files.blobManager
-
Thrown when there is a problems of accessing blobs directory
- BlobsDirectoryException(message) - Constructor for exception io.scanbot.sdk.exceptions.files.blobManager.BlobsDirectoryException
-
Thrown when there is a problems of accessing blobs directory
- BlobsException - Exception in io.scanbot.sdk.exceptions.files.blobManager
-
Thrown when there is a problems of accessing blobs
- BlobsException(message) - Constructor for exception io.scanbot.sdk.exceptions.files.blobManager.BlobsException
-
Thrown when there is a problems of accessing blobs
- BlobsStorage - Class in io.scanbot.sdk.connectivity
-
Provides path to remote storage files
- BlobsStorage(preferences) - Constructor for class io.scanbot.sdk.connectivity.BlobsStorage
-
Provides path to remote storage files
- BlobStoreStrategy - Class in io.scanbot.sdk.persistence
-
Interface to locally saved binary files used by
data intelligence and OCR module
- BlobStoreStrategy(application, preferences) - Constructor for class io.scanbot.sdk.persistence.BlobStoreStrategy
-
Interface to locally saved binary files used by
data intelligence and OCR module
- BlobType - Enum in io.scanbot.sdk.blob
-
Enumeration of blob types
- build() - Method in class io.scanbot.sdk.persistence.FileStorageSettings.Builder
-
- Builder() - Constructor for class io.scanbot.sdk.persistence.FileStorageSettings.Builder
-
- Callback.Companion - Class in io.scanbot.sdk.camera.autosnapping
-
- CameraConfigurationException - Exception in io.scanbot.sdk.exceptions.camera
-
Thrown when Camera configured with incorrect property values
- CameraConfigurationException(message) - Constructor for exception io.scanbot.sdk.exceptions.camera.CameraConfigurationException
-
Thrown when Camera configured with incorrect property values
- CameraImageUtils - Class in io.scanbot.sdk.ui.camera.util
-
Util methods to process Camera images
- CameraModule - Enum in io.scanbot.sdk.camera
-
Represents all supported cameras
- CameraOpenCallback - Interface in io.scanbot.sdk.camera
-
- CameraOpenCallback.Companion - Class in io.scanbot.sdk.camera
-
- CameraOpenCallbackKt - Class in io.scanbot.sdk.camera
-
- CameraParametersException - Exception in io.scanbot.sdk.exceptions.camera
-
Thrown when Camera parameters are invalid
- CameraParametersException(message) - Constructor for exception io.scanbot.sdk.exceptions.camera.CameraParametersException
-
Thrown when Camera parameters are invalid
- CameraPreviewMode - Enum in io.scanbot.sdk.camera
-
- CameraStateCallback - Interface in io.scanbot.sdk.camera
-
Notified about state of the camera
- CameraTakePictureCallback - Interface in io.scanbot.sdk.camera
-
Notified about state of the take picture operation
- CameraTransformationException - Exception in io.scanbot.sdk.exceptions.camera
-
Thrown when Camera unable to process transformations of preview, caused by incorrect init values
- CameraTransformationException(message) - Constructor for exception io.scanbot.sdk.exceptions.camera.CameraTransformationException
-
Thrown when Camera unable to process transformations of preview, caused by incorrect init values
- cancel() - Method in class io.scanbot.sdk.camera.SnapFlashView
-
- CaptureIntervalAutoSnappingPredicate - Class in io.scanbot.sdk.camera.autosnapping
-
Determines how often consecutive snaps can be made.
- CaptureIntervalAutoSnappingPredicate() - Constructor for class io.scanbot.sdk.camera.autosnapping.CaptureIntervalAutoSnappingPredicate
-
Determines how often consecutive snaps can be made.
- CaptureIntervalAutoSnappingPredicate.Companion - Class in io.scanbot.sdk.camera.autosnapping
-
- checkState(param) - Method in class io.scanbot.sdk.camera.autosnapping.CaptureIntervalAutoSnappingPredicate
-
Run this check.
- checkState(param) - Method in interface io.scanbot.sdk.camera.autosnapping.IAutoSnappingPredicate
-
Run this check.
- checkState(param) - Method in class io.scanbot.sdk.camera.autosnapping.ShakeAutoSnappingPredicate
-
Run this check.
- closeQuietly(cursor) - Static method in class io.scanbot.sdk.util.CursorUtil
-
Closes cursor if it is not null or is not closed already
- CodecFailedException - Exception in io.scanbot.sdk.exceptions.camera
-
Exception for error during transcoding image.
- CodecFailedException(message) - Constructor for exception io.scanbot.sdk.exceptions.camera.CodecFailedException
-
- CodecFailedException(message, failureType) - Constructor for exception io.scanbot.sdk.exceptions.camera.CodecFailedException
-
- CodecFailedException.FailureType - Enum in io.scanbot.sdk.exceptions.camera
-
- Companion - Static variable in class io.scanbot.sdk.camera.autosnapping.BaseAutoSnappingController
-
Deprecated.
- Companion - Static variable in class io.scanbot.sdk.camera.autosnapping.CaptureIntervalAutoSnappingPredicate
-
- Companion - Static variable in interface io.scanbot.sdk.camera.autosnapping.IAutoSnappingController.AutoSnappingStateListener
-
- Companion - Static variable in interface io.scanbot.sdk.camera.autosnapping.IAutoSnappingController.Callback
-
- Companion - Static variable in class io.scanbot.sdk.camera.autosnapping.ShakeAutoSnappingPredicate
-
Deprecated.
- Companion - Static variable in interface io.scanbot.sdk.camera.autosnapping.SignificantMoveListener
-
- Companion - Static variable in interface io.scanbot.sdk.camera.CameraOpenCallback
-
- Companion - Static variable in class io.scanbot.sdk.camera.PictureCallback
-
- Companion - Static variable in enum io.scanbot.sdk.entity.Language
-
- Companion - Static variable in class io.scanbot.sdk.persistence.BlobStoreStrategy
-
Deprecated.
- Companion - Static variable in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
- Companion - Static variable in class io.scanbot.sdk.ui.camera.ZoomFinderOverlayView
-
Deprecated.
- Companion - Static variable in class io.scanbot.sdk.ui.FadeAnimationView
-
- Companion - Static variable in class io.scanbot.sdk.util.log.DebugLog
-
- Companion - Static variable in class io.scanbot.sdk.util.PolygonHelper
-
- Companion - Static variable in class io.scanbot.sdk.util.thread.BackgroundThreadFactory
-
- component1() - Method in class io.scanbot.sdk.camera.FrameHandler.Frame
-
- component1() - Method in class io.scanbot.sdk.camera.ZoomRange
-
Minimal zoom factor in the range from 0f to 1f.
- component1() - Method in class io.scanbot.sdk.ui.camera.FinderAspectRatio
-
- component2() - Method in class io.scanbot.sdk.camera.FrameHandler.Frame
-
- component2() - Method in class io.scanbot.sdk.camera.ZoomRange
-
Maximal zoom factor in the range from 0f to 1f.
- component2() - Method in class io.scanbot.sdk.ui.camera.FinderAspectRatio
-
- component3() - Method in class io.scanbot.sdk.camera.FrameHandler.Frame
-
- component4() - Method in class io.scanbot.sdk.camera.FrameHandler.Frame
-
- component5() - Method in class io.scanbot.sdk.camera.FrameHandler.Frame
-
- component6() - Method in class io.scanbot.sdk.camera.FrameHandler.Frame
-
- component7() - Method in class io.scanbot.sdk.camera.FrameHandler.Frame
-
- component8() - Method in class io.scanbot.sdk.camera.FrameHandler.Frame
-
- computeCropRectFromAspectRatio(sourceSize, aspectRatio) - Static method in class io.scanbot.sdk.ui.camera.util.CameraImageUtils
-
Calculates crop rect with the specified aspect ratio on the given size. Assuming the rect is
at the center of the source.
- Constants - Class in io.scanbot.sdk
-
- continuousFocus() - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Cancels auto-focus and performs continuous-focus.
Should be executed from the main thread and when camera is opened
- continuousFocus() - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
Cancels auto-focus and performs continuous-focus.
Should be executed from the main thread and when camera is opened
- continuousFocus() - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Cancels auto-focus and performs continuous-focus.
Should be executed from the main thread and when camera is opened
- convertNV21ToBitmap(nv21Image, imageWidth, imageHeight, imageOrientation) - Static method in class io.scanbot.sdk.ui.camera.util.PreviewImageUtil
-
Converts the image byte array in NV21 format to Bitmap
- convertPoint(x, y) - Method in class io.scanbot.sdk.ui.camera.PreviewViewMeteringPointFactory
-
- convertYUV420toNV21(image) - Static method in class io.scanbot.sdk.ui.camera.util.PreviewImageUtil
-
Converts the image in YUV_420_888 to NV21 format
- copy(frame, width, height, frameOrientation, finderRect, visibleRect, finderInnerThresholdPx, finderOuterThresholdPx) - Method in class io.scanbot.sdk.camera.FrameHandler.Frame
-
Represents captured frame data and bounds
- copy(minZoomFactor, maxZoomFactor) - Method in class io.scanbot.sdk.camera.ZoomRange
-
- copy(width, height) - Method in class io.scanbot.sdk.ui.camera.FinderAspectRatio
-
Represents camera view aspect ratio
- copyRaw(source, destination) - Method in interface io.scanbot.sdk.persistence.fileio.BaseFileIOProcessor
-
- copyRaw(source, destination) - Method in class io.scanbot.sdk.persistence.fileio.DefaultFileIOProcessor
-
- cropByteArray(data, cropRect) - Static method in class io.scanbot.sdk.ui.camera.util.CameraImageUtils
-
Crops byte array with given android.graphics.Rect.
- CursorUtil - Class in io.scanbot.sdk.util
-
Helper class to work with Cursors
- CUSTOM_SDK_FILES_PATH - Static variable in class io.scanbot.sdk.PreferencesConstants
-
Contains the custom documents and pages root directory path
- e(tag, message) - Method in class io.scanbot.sdk.util.log.DebugLog
-
Writes tag and message to the log file and also calls Log.e with given params.
- e(tag, where, e) - Method in class io.scanbot.sdk.util.log.DebugLog
-
Writes a message about exception to system log and to the file.
- e(message) - Method in class io.scanbot.sdk.util.log.DebugLog
-
- e(tag, message) - Method in interface io.scanbot.sdk.util.log.Logger
-
Writes tag and message to the log on Level.Error
- e(tag, message) - Method in class io.scanbot.sdk.util.log.StubLogger
-
Writes tag and message to the log on Level.Error
- emptyCursor() - Static method in class io.scanbot.sdk.util.CursorUtil
-
- enableAutoFocus(parameters) - Static method in class io.scanbot.sdk.util.snap.Utils
-
Sets focus mode to Camera.Parameters.FOCUS_MODE_AUTO if supported
- enableContinuousFocus(parameters) - Static method in class io.scanbot.sdk.util.snap.Utils
-
Sets focus mode to Camera.Parameters.FOCUS_MODE_CONTINUOUS_PICTURE
or Camera.Parameters.FOCUS_MODE_AUTO if supported
- EncryptionArgumentsException - Exception in io.scanbot.sdk.exceptions.crypto
-
Thrown when Encryption mechanics initialized with incorrect params
- EncryptionArgumentsException(message) - Constructor for exception io.scanbot.sdk.exceptions.crypto.EncryptionArgumentsException
-
Thrown when Encryption mechanics initialized with incorrect params
- EncryptionInitException - Exception in io.scanbot.sdk.exceptions.crypto
-
Thrown when DI cant init encryption classes due to not supported android version or other problems
- EncryptionInitException(message) - Constructor for exception io.scanbot.sdk.exceptions.crypto.EncryptionInitException
-
Thrown when DI cant init encryption classes due to not supported android version or other problems
- ensureDirExists(directoryPath) - Static method in class io.scanbot.sdk.util.FileUtils
-
- ensureMainThread() - Static method in class io.scanbot.sdk.util.thread.ExecutionUtils
-
Ensures that method invocation happened on main thread
- equals(p) - Method in class io.scanbot.sdk.camera.FrameHandler.Frame
-
- equals(p) - Method in class io.scanbot.sdk.camera.ZoomRange
-
- equals(o) - Method in class io.scanbot.sdk.entity.Blob
-
- equals(p) - Method in class io.scanbot.sdk.ui.camera.FinderAspectRatio
-
- ExecutionUtils - Class in io.scanbot.sdk.util.thread
-
Utils for predefined Thread execution
- EXTENSION_JPEG - Static variable in class io.scanbot.sdk.Constants
-
- EXTENSION_JPG - Static variable in class io.scanbot.sdk.Constants
-
- EXTENSION_PDF - Static variable in class io.scanbot.sdk.Constants
-
- EXTERNAL_DIR - Static variable in class io.scanbot.sdk.PreferencesConstants
-
Contains path to sd card directory for pdf files saving
- getAllLanguagesWithAvailableOcrBlobs() - Method in class io.scanbot.sdk.blob.BlobManager
-
- getAppFilesDirOrShowError(context, directoryName) - Static method in class io.scanbot.sdk.util.FileUtils
-
Returns the application (internal or external) directory with provided name (creates if needed). On failure shows toast message.
- getAttachedFrameHandler(clazz) - Method in interface io.scanbot.sdk.camera.PreviewBuffer
-
Check whether there is same class of
interface FrameHandler attached to the view
return object of the same class if exists otherwise
null
- getAttachedFrameHandler(clazz) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Check whether there is same class of
interface FrameHandler attached to the view
return object of the same class if exists otherwise
null
- getAttachedFrameHandler(clazz) - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
Check whether there is same class of
interface FrameHandler attached to the view
return object of the same class if exists otherwise
null
- getAttachedFrameHandler(clazz) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Check whether there is same class of
interface FrameHandler attached to the view
return object of the same class if exists otherwise
null
- getBanksDataFile() - Method in class io.scanbot.sdk.blob.BlobManager
-
- getBarcodeBinarizationModelFile() - Method in class io.scanbot.sdk.blob.BlobManager
-
Deprecated.
- getBarcodeDetectionModelFile() - Method in class io.scanbot.sdk.blob.BlobManager
-
Deprecated.
- getBestAspectPictureSize(displayOrientation, width, height, parameters, closeEnough) - Static method in class io.scanbot.sdk.util.snap.Utils
-
- getBinariesDirectory() - Method in class io.scanbot.sdk.persistence.BlobStoreStrategy
-
- getBlobsForType(blobType) - Method in class io.scanbot.sdk.blob.BlobFactory
-
- getBlurEstimatorModelFile() - Method in class io.scanbot.sdk.blob.BlobManager
-
- getChequeDigitPredictionModelFile() - Method in class io.scanbot.sdk.blob.BlobManager
-
- getContext() - Method in class io.scanbot.sdk.persistence.fileio.DefaultFileIOProcessor
-
- getCustomFileIOProcessor() - Method in class io.scanbot.sdk.persistence.FileStorageSettings.Builder
-
- getCustomFileIOProcessor() - Method in class io.scanbot.sdk.persistence.FileStorageSettings
-
custom
- getDataColumn(context, uri, selection, selectionArgs) - Static method in class io.scanbot.sdk.util.FileChooserUtils
-
Get the value of the data column for this Uri. This is useful for
MediaStore Uris, and other file-based ContentProviders.
- getDcModelsFolderFile() - Method in class io.scanbot.sdk.blob.BlobManager
-
Deprecated.
- getDelayAfterFocusCompleteMs() - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Delay that camera will took before snap on auto focus complete called from camera core in ms.
For some devices this callback could call even before real auto focus completed, so we need to take some delay before snapping.
Usually you can set 500ms. By default it is set to 20ms.
- getDelayAfterFocusCompleteMs() - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
Delay that camera will took before snap on auto focus complete called from camera core in ms.
For some devices this callback could call even before real auto focus completed, so we need to take some delay before snapping.
Usually you can set 500ms. By default it is set to 20ms.
- getDelayAfterFocusCompleteMs() - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Delay that camera will took before snap on auto focus complete called from camera core in ms.
For some devices this callback could call even before real auto focus completed, so we need to take some delay before snapping.
Usually you can set 500ms. By default it is set to 20ms.
- getDocumentDetectorModelFile() - Method in class io.scanbot.sdk.blob.BlobManager
-
Deprecated.
- getEncryptionEnabled() - Method in class io.scanbot.sdk.persistence.FileStorageSettings.Builder
-
- getEncryptionEnabled() - Method in class io.scanbot.sdk.persistence.FileStorageSettings
-
the flag which enables/disables a usage of encrypted file IO processor.
- getError() - Method in class io.scanbot.sdk.camera.FrameHandlerResult.Failure
-
- getExternalCacheDirOrShowError(context, directoryName) - Static method in class io.scanbot.sdk.util.FileUtils
-
Returns external cache directory with provided name (creates if needed). On failure shows toast message.
- getExternalFilesDirOrShowError(context, directoryName) - Static method in class io.scanbot.sdk.util.FileUtils
-
Returns external directory with provided name (creates if needed). On failure shows toast message.
- getExternalStorageDirOrShowError(directoryName) - Static method in class io.scanbot.sdk.util.FileUtils
-
Returns external directory with provided name (creates if needed). On failure shows toast message.
- getFailureType() - Method in exception io.scanbot.sdk.exceptions.camera.CodecFailedException
-
- getFilename() - Method in enum io.scanbot.sdk.blob.BlobType
-
name of the file or of the folder in local storage
- getFilesDirOrShowError(parentDirPath, directoryName) - Static method in class io.scanbot.sdk.util.FileUtils
-
Returns directory with provided path (creates if needed). On failure shows toast message.
- getFillScaleWithBufferAspectRatio(container, view, bufferSize) - Static method in class io.scanbot.sdk.ui.camera.util.ScaleTypeTransform
-
Computes the scale by which a view has to scale in x and y in order to fill its parent
while maintaining the buffer's aspect ratio.
- getFilterPredictionModelFile() - Method in class io.scanbot.sdk.blob.BlobManager
-
- getFinderInnerThresholdPx() - Method in class io.scanbot.sdk.camera.FrameHandler.Frame
-
- getFinderOuterThresholdPx() - Method in class io.scanbot.sdk.camera.FrameHandler.Frame
-
- getFinderRect() - Method in class io.scanbot.sdk.camera.FrameHandler.Frame
-
- getFinderViewId() - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Default is R.id.finder_overlay
- getFinderViewId() - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Default is R.id.finder_overlay
- getFinderViewId() - Method in interface io.scanbot.sdk.ui.camera.util.FinderViewAttributeHandler
-
- getFinderViewId() - Method in class io.scanbot.sdk.ui.camera.util.FinderViewAttributeHandlerImpl
-
Default is R.id.finder_overlay
- getFitScaleWithBufferAspectRatio(container, view, bufferSize) - Static method in class io.scanbot.sdk.ui.camera.util.ScaleTypeTransform
-
Computes the scale by which a view has to scale in x and y in order to fit its parent
while maintaining the buffer's aspect ratio.
- getFixedFinderHeightInPx() - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- getFixedFinderWidthInPx() - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- getFrame() - Method in class io.scanbot.sdk.camera.FrameHandler.Frame
-
- getFrameOrientation() - Method in class io.scanbot.sdk.camera.FrameHandler.Frame
-
- getFullPolygon() - Method in class io.scanbot.sdk.util.PolygonHelper.Companion
-
Provide Polygon, covering whole image {(0,0), (0,1), (1,1), (1,0)}
- getFullPolygon() - Static method in class io.scanbot.sdk.util.PolygonHelper
-
Provide Polygon, covering whole image {(0,0), (0,1), (1,1), (1,0)}
- getGenericTextRecognizerModelsFolderFile() - Method in class io.scanbot.sdk.blob.BlobManager
-
Deprecated.
- getHeight() - Method in class io.scanbot.sdk.camera.FrameHandler.Frame
-
- getHeight() - Method in class io.scanbot.sdk.ui.camera.FinderAspectRatio
-
- getIdCardScannerModelsFolderFile() - Method in class io.scanbot.sdk.blob.BlobManager
-
Deprecated.
- getImageProcessorModelsFolderFile() - Method in class io.scanbot.sdk.blob.BlobManager
-
Doesn't check that file is exists
- getInitialPreviewHeight() - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- getInitialPreviewMode() - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- getInitialPreviewWidth() - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- getInstance() - Static method in class io.scanbot.sdk.security.SapSingleton
-
- getLanguageTags() - Method in enum io.scanbot.sdk.entity.Language
-
different standarts representation of language
- getLargestPictureSize(parameters) - Static method in class io.scanbot.sdk.util.snap.Utils
-
Returns the biggest size for resulting image
- getLargestSizeWithAspectRatioMatch(sizes, targetAspect) - Static method in class io.scanbot.sdk.util.snap.Utils
-
- getLifecycleOwner() - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
- getLocalFileFor(blobType) - Method in class io.scanbot.sdk.persistence.BlobStoreStrategy
-
Returns a file where a blob of the given type should be stored in local storage
- getLocalPath() - Method in class io.scanbot.sdk.entity.Blob
-
Local path of binary file
- getLogger() - Static method in class io.scanbot.sdk.util.log.LoggerProvider
-
- getMaxZoomFactor() - Method in class io.scanbot.sdk.camera.ZoomRange
-
Maximal zoom factor in the range from 0f to 1f.
- getMessage() - Method in exception io.scanbot.sdk.exceptions.camera.CameraConfigurationException
-
- getMessage() - Method in exception io.scanbot.sdk.exceptions.camera.CameraParametersException
-
- getMessage() - Method in exception io.scanbot.sdk.exceptions.camera.CameraTransformationException
-
- getMessage() - Method in exception io.scanbot.sdk.exceptions.crypto.EncryptionArgumentsException
-
- getMessage() - Method in exception io.scanbot.sdk.exceptions.crypto.EncryptionInitException
-
- getMessage() - Method in exception io.scanbot.sdk.exceptions.files.blobManager.BlobsDirectoryException
-
- getMessage() - Method in exception io.scanbot.sdk.exceptions.files.blobManager.BlobsException
-
- getMessage() - Method in exception io.scanbot.sdk.exceptions.files.FileAccessException
-
- getMinFinderPadding() - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- getMinZoomFactor() - Method in class io.scanbot.sdk.camera.ZoomRange
-
Minimal zoom factor in the range from 0f to 1f.
- getMoveThreshold() - Method in interface io.scanbot.sdk.camera.autosnapping.SignificantMoveListener
-
- getMrzCascadeFile() - Method in class io.scanbot.sdk.blob.BlobManager
-
- getNULL() - Method in class io.scanbot.sdk.camera.autosnapping.AutoSnappingStateListener.Companion
-
- getNULL() - Method in class io.scanbot.sdk.camera.autosnapping.Callback.Companion
-
NULL-object pattern.
- getOcrBlobLanguageTag() - Method in enum io.scanbot.sdk.entity.Language
-
tesseract representation of language
- getOcrBlobsDirectory() - Method in class io.scanbot.sdk.blob.BlobManager
-
- getOcrDataDirectory() - Method in class io.scanbot.sdk.persistence.BlobStoreStrategy
-
- getOriginOfCenteredView(container, view) - Static method in class io.scanbot.sdk.ui.camera.util.ScaleTypeTransform
-
Computes the top left coordinates for the view to be centered inside its parent.
- getPath(context, uri) - Static method in class io.scanbot.sdk.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.
- getPreviewBuffer() - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
- getRemotePath() - Method in class io.scanbot.sdk.entity.Blob
-
Path of binary file on remote storage
- getRequiredAspectRatios() - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- getRequiredAspectRatiosInternal() - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- getRotationDegrees(view) - Static method in class io.scanbot.sdk.ui.camera.util.ScaleTypeTransform
-
Computes the rotation of a android.view.View in degrees from its natural
orientation.
- getStateListener() - Method in class io.scanbot.sdk.camera.autosnapping.BaseAutoSnappingController
-
- getStateListener() - Method in class io.scanbot.sdk.camera.autosnapping.CaptureIntervalAutoSnappingPredicate
-
- getSupportedPictureSizes() - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
- getSupportedPictureSizes() - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
- getSupportedPreviewSizes() - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
- getSupportedPreviewSizes() - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
- getUseBounceInterpolator() - Method in class io.scanbot.sdk.ui.FadeAnimationView
-
Sets if should fade animation play with bounce or with linear interpolator
- getUseEncryption() - Method in interface io.scanbot.sdk.persistence.fileio.BaseFileIOProcessor
-
- getUseEncryption() - Method in class io.scanbot.sdk.persistence.fileio.DefaultFileIOProcessor
-
- getValue() - Method in class io.scanbot.sdk.camera.FrameHandlerResult.Success
-
- getVisibleRect() - Method in class io.scanbot.sdk.camera.FrameHandler.Frame
-
- getWidth() - Method in class io.scanbot.sdk.camera.FrameHandler.Frame
-
- getWidth() - Method in class io.scanbot.sdk.ui.camera.FinderAspectRatio
-
- getZoomLevel() - Method in class io.scanbot.sdk.ui.camera.ZoomFinderOverlayView
-
Allows the user to set the needed zoom level for the finder and for dependent views.
If the new value is too big it will be clamped to fill the screen according to given padding
- GradleDependencyException - Exception in io.scanbot.sdk.exceptions.base
-
Thrown when there is no gradle dependency found which is required to run the corresponding component of the SDK
- GradleDependencyException(dependencyName, moduleName) - Constructor for exception io.scanbot.sdk.exceptions.base.GradleDependencyException
-
Thrown when there is no gradle dependency found which is required to run the corresponding component of the SDK
- i(tag, message) - Method in class io.scanbot.sdk.util.log.DebugLog
-
Writes tag and message to the log file and also calls Log.i with given params.
- i(message) - Method in class io.scanbot.sdk.util.log.DebugLog
-
- i(tag, message) - Method in interface io.scanbot.sdk.util.log.Logger
-
Writes tag and message to the log on Level.Information
- i(tag, message) - Method in class io.scanbot.sdk.util.log.StubLogger
-
Writes tag and message to the log on Level.Information
- IAutoSnappingController<T> - Interface in io.scanbot.sdk.camera.autosnapping
-
Defines interface for component that performs current conditions evaluation
and decides the best moment to take snap automatically.
- IAutoSnappingController.AutoSnappingStateListener - Interface in io.scanbot.sdk.camera.autosnapping
-
Allow to listen when autoSnapping will start to process
- IAutoSnappingController.Callback - Interface in io.scanbot.sdk.camera.autosnapping
-
Autosnapping callback
- IAutoSnappingPredicate<T> - Interface in io.scanbot.sdk.camera.autosnapping
-
A single check to be evaluated during autosnapping
- IFinderView - Interface in io.scanbot.sdk.camera
-
Interface for configurable Camera finder view
- ImageFileIOProcessor - Interface in io.scanbot.sdk.persistence.fileio
-
Represents image file IO operations
- imageToJpegByteArray(image) - Static method in class io.scanbot.sdk.ui.camera.util.CameraImageUtils
-
android.media.Image to JPEG byte array.
- initializeSapManager(context) - Static method in class io.scanbot.sdk.security.SapSingleton
-
- INSTANCE - Static variable in class io.scanbot.sdk.BlobsConstants
-
Contains upload constants
- INSTANCE - Static variable in class io.scanbot.sdk.Constants
-
- INSTANCE - Static variable in class io.scanbot.sdk.PreferencesConstants
-
Provides all preferences constants, extras keys
- INSTANCE - Static variable in class io.scanbot.sdk.security.SapSingleton
-
Provides instance of SapManager across the application
- INSTANCE - Static variable in class io.scanbot.sdk.ui.camera.util.CameraImageUtils
-
Util methods to process Camera images
- INSTANCE - Static variable in class io.scanbot.sdk.ui.camera.util.PreviewImageUtil
-
Util methods to process camera preview images
- INSTANCE - Static variable in class io.scanbot.sdk.ui.camera.util.ScaleTypeTransform
-
Util methods for view size calculations
- INSTANCE - Static variable in class io.scanbot.sdk.util.CursorUtil
-
Helper class to work with Cursors
- INSTANCE - Static variable in class io.scanbot.sdk.util.FileChooserUtils
-
Provides methods for extracting image path from chooser
- INSTANCE - Static variable in class io.scanbot.sdk.util.FileUtils
-
Contains helper methods for working with files and directories
- INSTANCE - Static variable in class io.scanbot.sdk.util.log.LoggerProvider
-
- INSTANCE - Static variable in class io.scanbot.sdk.util.snap.Utils
-
Helper methods to work with Camera
- INSTANCE - Static variable in class io.scanbot.sdk.util.thread.ExecutionUtils
-
Utils for predefined Thread execution
- io.scanbot.sdk - package io.scanbot.sdk
-
- io.scanbot.sdk.blob - package io.scanbot.sdk.blob
-
- io.scanbot.sdk.camera - package io.scanbot.sdk.camera
-
- io.scanbot.sdk.camera.autosnapping - package io.scanbot.sdk.camera.autosnapping
-
- io.scanbot.sdk.connectivity - package io.scanbot.sdk.connectivity
-
- io.scanbot.sdk.entity - package io.scanbot.sdk.entity
-
- io.scanbot.sdk.exceptions.barcode - package io.scanbot.sdk.exceptions.barcode
-
- io.scanbot.sdk.exceptions.base - package io.scanbot.sdk.exceptions.base
-
- io.scanbot.sdk.exceptions.camera - package io.scanbot.sdk.exceptions.camera
-
- io.scanbot.sdk.exceptions.crypto - package io.scanbot.sdk.exceptions.crypto
-
- io.scanbot.sdk.exceptions.files - package io.scanbot.sdk.exceptions.files
-
- io.scanbot.sdk.exceptions.files.blobManager - package io.scanbot.sdk.exceptions.files.blobManager
-
- io.scanbot.sdk.persistence - package io.scanbot.sdk.persistence
-
- io.scanbot.sdk.persistence.fileio - package io.scanbot.sdk.persistence.fileio
-
- io.scanbot.sdk.security - package io.scanbot.sdk.security
-
- io.scanbot.sdk.ui - package io.scanbot.sdk.ui
-
- io.scanbot.sdk.ui.camera - package io.scanbot.sdk.ui.camera
-
- io.scanbot.sdk.ui.camera.util - package io.scanbot.sdk.ui.camera.util
-
- io.scanbot.sdk.util - package io.scanbot.sdk.util
-
- io.scanbot.sdk.util.log - package io.scanbot.sdk.util.log
-
- io.scanbot.sdk.util.snap - package io.scanbot.sdk.util.snap
-
- io.scanbot.sdk.util.thread - package io.scanbot.sdk.util.thread
-
- isAspectRatioValid(aspectRatio) - Method in class io.scanbot.sdk.ui.camera.util.CameraImageUtils
-
True if the given aspect ratio is meaningful.
- isAspectRatioValid(sourceSize, aspectRatio) - Method in class io.scanbot.sdk.ui.camera.util.CameraImageUtils
-
True if the given aspect ratio is meaningful and has effect on the given size.
- isAvailableInAssets(blobType) - Method in class io.scanbot.sdk.blob.BlobFactory
-
- isBlobAvailable(blob) - Method in class io.scanbot.sdk.blob.BlobManager
-
- IScanbotCameraView - Interface in io.scanbot.sdk.ui.camera
-
- isDownloadsDocument(uri) - Static method in class io.scanbot.sdk.util.FileChooserUtils
-
- isEnabled() - Method in class io.scanbot.sdk.camera.autosnapping.BaseAutoSnappingController
-
Flag to disable autosnapping processing. In case of false frames will be skipped.
- isEnabled() - Method in class io.scanbot.sdk.camera.autosnapping.ShakeAutoSnappingPredicate
-
- isExternalStorageDocument(uri) - Static method in class io.scanbot.sdk.util.FileChooserUtils
-
- isFileNameSafe(name) - Static method in class io.scanbot.sdk.util.FileUtils
-
- isFlashSupported(parameters) - Static method in class io.scanbot.sdk.util.snap.Utils
-
- isFolder() - Method in enum io.scanbot.sdk.blob.BlobType
-
if it is a folder
- isMediaDocument(uri) - Static method in class io.scanbot.sdk.util.FileChooserUtils
-
- isNaturalPortrait(context, rotationDegrees) - Static method in class io.scanbot.sdk.ui.camera.util.ScaleTypeTransform
-
Determines whether the current device is a natural portrait-oriented device
- isOcrBlob() - Method in enum io.scanbot.sdk.blob.BlobType
-
if it should be stored in OCR directory after copying
- isResumed() - Method in class io.scanbot.sdk.camera.autosnapping.BaseAutoSnappingController
-
- OCR_BLOBS_PATH - Static variable in class io.scanbot.sdk.BlobsConstants
-
- ocrBlobsPath() - Method in class io.scanbot.sdk.connectivity.BlobsStorage
-
- onAccuracyChanged(sensor, accuracy) - Method in class io.scanbot.sdk.camera.autosnapping.SignificantMoveCatcher
-
- onAttachedToWindow() - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
- onAttachedToWindow() - Method in class io.scanbot.sdk.ui.camera.ZoomFinderOverlayView
-
- onAutoSnapping() - Method in interface io.scanbot.sdk.camera.autosnapping.IAutoSnappingController.Callback
-
To be called before autosnap.
- onAutoSnappingCanceled() - Method in interface io.scanbot.sdk.camera.autosnapping.IAutoSnappingController.AutoSnappingStateListener
-
Triggers when autosnapping won't start within this delay
- onAutoSnappingIn(ms) - Method in interface io.scanbot.sdk.camera.autosnapping.IAutoSnappingController.AutoSnappingStateListener
-
Triggers when autosnapping will start in within delay
- onCameraOpened() - Method in interface io.scanbot.sdk.camera.CameraOpenCallback
-
Called when camera is opened and ready for shooting
- onDetachedFromWindow() - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
- onDetachedFromWindow() - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
- onDetachedFromWindow() - Method in class io.scanbot.sdk.ui.camera.ZoomFinderOverlayView
-
- onDetachedFromWindow() - Method in class io.scanbot.sdk.ui.FadeAnimationView
-
- onDraw(canvas) - Method in class io.scanbot.sdk.ui.FadeAnimationView
-
- onLayout(changed, left, top, right, bottom) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
- onLayout(changed, left, top, right, bottom) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- onLayout(changed, left, top, right, bottom) - Method in class io.scanbot.sdk.ui.FadeAnimationView
-
- onMeasure(widthMeasureSpec, heightMeasureSpec) - Method in class io.scanbot.sdk.ui.FadeAnimationView
-
- onPause() - Method in class io.scanbot.sdk.camera.autosnapping.ShakeAutoSnappingPredicate
-
Call to detach when component no longer needed.
- onPause() - Method in interface io.scanbot.sdk.camera.CameraStateCallback
-
Called when camera switches to paused state. Listeners should not expect new callbacks from
the camera until
.onResume is called again.
- onPause() - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Notifies view that enclosing android.app.Activity or android.app.Fragment
was paused and therefore camera must be closed.
- onPictureTaken(image, imageOrientation) - Method in class io.scanbot.sdk.camera.PictureCallback
-
Invoked when picture is taken
- onPictureTakenInternal(image, imageOrientation, finderRect) - Method in interface io.scanbot.sdk.camera.BasePictureCallback
-
Invoked when picture is taken
- onPictureTakenInternal(image, imageOrientation, finderRect) - Method in class io.scanbot.sdk.camera.PictureCallback
-
Invoked when picture is taken
- onResume() - Method in class io.scanbot.sdk.camera.autosnapping.ShakeAutoSnappingPredicate
-
Call to attach to hardware listener.
- onResume() - Method in interface io.scanbot.sdk.camera.CameraStateCallback
-
Called when camera switches to resumed state and is about to start streaming preview stream.
- onResume() - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Notifies view that enclosing android.app.Activity or android.app.Fragment
was resumed and therefore camera can be started.
- onSensorChanged(event) - Method in class io.scanbot.sdk.camera.autosnapping.SignificantMoveCatcher
-
- onSignificantMove() - Method in interface io.scanbot.sdk.camera.autosnapping.SignificantMoveListener
-
Gets called every time when significant move detected
- onTakePictureCancelled() - Method in interface io.scanbot.sdk.camera.CameraTakePictureCallback
-
Called when the take picture operation could not be performed.
- onTakePictureRequested() - Method in interface io.scanbot.sdk.camera.CameraTakePictureCallback
-
Called when the take picture operation was successfully requested.
- openFileInputStream(sourceFile) - Method in interface io.scanbot.sdk.persistence.fileio.BaseFileIOProcessor
-
Returns OutputStream for the source file
- openFileInputStream(sourceFile) - Method in class io.scanbot.sdk.persistence.fileio.DefaultFileIOProcessor
-
Returns OutputStream for the source file
- openFileOutputStream(destinationFile) - Method in interface io.scanbot.sdk.persistence.fileio.BaseFileIOProcessor
-
Returns OutputStream for the destination file
- openFileOutputStream(destinationFile) - Method in class io.scanbot.sdk.persistence.fileio.DefaultFileIOProcessor
-
Returns OutputStream for the destination file
- read(source) - Method in interface io.scanbot.sdk.persistence.fileio.BaseFileIOProcessor
-
Read ByteArray data from the source File
- read(source) - Method in class io.scanbot.sdk.persistence.fileio.DefaultFileIOProcessor
-
Read ByteArray data from the source File
- readImage(source, options) - Method in class io.scanbot.sdk.persistence.fileio.DefaultFileIOProcessor
-
Read Bitmap image from the source File
- readImage(sourceUri, options) - Method in class io.scanbot.sdk.persistence.fileio.DefaultFileIOProcessor
-
Read Bitmap image from the source file Uri
- readImage(source, options) - Method in interface io.scanbot.sdk.persistence.fileio.ImageFileIOProcessor
-
Read Bitmap image from the source File
- readImage(sourceUri, options) - Method in interface io.scanbot.sdk.persistence.fileio.ImageFileIOProcessor
-
Read Bitmap image from the source file Uri
- registerSignificantMoveListener(listener) - Method in class io.scanbot.sdk.camera.autosnapping.SignificantMoveCatcher
-
Registers SignificantMoveListener to notify about significant moves
- removeCameraStateCallback(cameraStateCallback) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Removes callback, so it won't receive any further notifications.
- removeCameraStateCallback(cameraStateCallback) - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
Removes callback, so it won't receive any further notifications.
- removeCameraStateCallback(cameraStateCallback) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Removes callback, so it won't receive any further notifications.
- removeCameraZoomDelegate(delegate) - Method in class io.scanbot.sdk.ui.camera.ZoomFinderOverlayView
-
- removeFrameHandler(frameHandler) - Method in interface io.scanbot.sdk.camera.PreviewBuffer
-
- removeFrameHandler(frameHandler) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
- removeFrameHandler(frameHandler) - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
- removeFrameHandler(frameHandler) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
- removePictureCallback(pictureCallback) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Removes callback, so it won't receive any further notifications.
- removePictureCallback(pictureCallback) - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
Removes callback, so it won't receive any further notifications.
- removePictureCallback(pictureCallback) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Removes callback, so it won't receive any further notifications.
- removeTakePictureCallback(cameraTakePictureCallback) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Removes callback, so it won't receive any further notifications.
- removeTakePictureCallback(cameraTakePictureCallback) - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
Removes callback, so it won't receive any further notifications.
- removeTakePictureCallback(cameraTakePictureCallback) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Removes callback, so it won't receive any further notifications.
- reset() - Method in class io.scanbot.sdk.camera.autosnapping.CaptureIntervalAutoSnappingPredicate
-
Reset possible internal counter, e.g. when snap was made.
- reset() - Method in interface io.scanbot.sdk.camera.autosnapping.ResettablePredicate
-
Reset possible internal counter, e.g. when snap was made.
- resetPredicates() - Method in class io.scanbot.sdk.camera.autosnapping.BaseAutoSnappingController
-
Resets all predicates that store state.
- ResettablePredicate - Interface in io.scanbot.sdk.camera.autosnapping
-
- rotate(rational, rotation) - Static method in class io.scanbot.sdk.ui.camera.util.CameraImageUtils
-
Rotate rational by rotation value, which inverse it if the degree is 90 or 270.
- rotatePolygon(polygon, rotation) - Method in class io.scanbot.sdk.util.PolygonHelper.Companion
-
Rotate polygon
- rotatePolygon(polygon, rotation) - Static method in class io.scanbot.sdk.util.PolygonHelper
-
Rotate polygon
- rotationDegreesFromSurfaceRotation(rotationConstant) - Static method in class io.scanbot.sdk.ui.camera.util.ScaleTypeTransform
-
Get the int value degree of a rotation from the Surface constants.
- runOnUIThread(runnable) - Static method in class io.scanbot.sdk.util.thread.ExecutionUtils
-
Executes runnable on the UI thread
- runPredicates(param) - Method in class io.scanbot.sdk.camera.autosnapping.BaseAutoSnappingController
-
Run particular implementation's autosnapping conditions checks.
- SapSingleton - Class in io.scanbot.sdk.security
-
Provides instance of SapManager across the application
- SAVE_SINGLE_AS_JPEG - Static variable in class io.scanbot.sdk.PreferencesConstants
-
true if single page documents should be saved as JPEG, false otherwise
- SAVED_ON_SD_CARD - Static variable in class io.scanbot.sdk.PreferencesConstants
-
Contains true if pdf files have to be saved on sd card, false - otherwise
- ScaleTypeTransform - Class in io.scanbot.sdk.ui.camera.util
-
Util methods for view size calculations
- SCANBOT_SDK_FILES_DIR - Static variable in class io.scanbot.sdk.util.FileUtils
-
- ScanbotCameraView - Class in io.scanbot.sdk.camera
-
Provides interface to native Camera and displays camera stream.
Use this class if you want to fine-tune camera behavior.
- ScanbotCameraView(context, attrs) - Constructor for class io.scanbot.sdk.camera.ScanbotCameraView
-
Provides interface to native Camera and displays camera stream.
Use this class if you want to fine-tune camera behavior.
- ScanbotCameraView(context) - Constructor for class io.scanbot.sdk.camera.ScanbotCameraView
-
- ScanbotCameraXView - Class in io.scanbot.sdk.ui.camera
-
Wrapper view for CameraX
- ScanbotCameraXView(context, attrs) - Constructor for class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Wrapper view for CameraX
- ScanbotCameraXView.Companion - Class in io.scanbot.sdk.ui.camera
-
- SdkInjectionException - Exception in io.scanbot.sdk.exceptions.base
-
Throws when there is a problem of configuring DI mechanics
- SdkInjectionException(message) - Constructor for exception io.scanbot.sdk.exceptions.base.SdkInjectionException
-
Throws when there is a problem of configuring DI mechanics
- SdkLicenseError - Exception in io.scanbot.sdk
-
Class to return as error inside UI components if license check is failed
- SdkLicenseError() - Constructor for exception io.scanbot.sdk.SdkLicenseError
-
Class to return as error inside UI components if license check is failed
- setAutoFocusOnTouch(autoFocusOnTouch) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
- setAutoFocusOnTouch(autoFocusOnTouch) - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
- setAutoFocusOnTouch(autoFocusOnTouch) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
- setAutoFocusSound(enabled) - Method in class io.scanbot.sdk.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(callback) - Method in class io.scanbot.sdk.camera.autosnapping.BaseAutoSnappingController
-
- setCameraModule(cameraModule) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Defines a camera module.
By default is CameraModule.BACK.
- setCameraModule(cameraModule) - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
Defines a camera module.
By default is CameraModule.BACK.
- setCameraModule(cameraModule) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Defines a camera module.
By default is CameraModule.BACK.
- setCameraOpenCallback(cameraOpenCallback) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Callback which will be invoked when camera will be opened
- setCameraOpenCallback(cameraOpenCallback) - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
Callback which will be invoked when camera will be opened
- setCameraOpenCallback(cameraOpenCallback) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Callback which will be invoked when camera will be opened
- setCameraParameters(previewWidth, previewHeight, cameraPreviewMode) - Method in interface io.scanbot.sdk.camera.IFinderView
-
Set camera parameters
- setCameraParameters(previewWidth, previewHeight, cameraPreviewMode) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
Set camera parameters
- setDelayAfterFocusCompleteMs(p) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Delay that camera will took before snap on auto focus complete called from camera core in ms.
For some devices this callback could call even before real auto focus completed, so we need to take some delay before snapping.
Usually you can set 500ms. By default it is set to 20ms.
- setDelayAfterFocusCompleteMs(p) - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
Delay that camera will took before snap on auto focus complete called from camera core in ms.
For some devices this callback could call even before real auto focus completed, so we need to take some delay before snapping.
Usually you can set 500ms. By default it is set to 20ms.
- setDelayAfterFocusCompleteMs(p) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Delay that camera will took before snap on auto focus complete called from camera core in ms.
For some devices this callback could call even before real auto focus completed, so we need to take some delay before snapping.
Usually you can set 500ms. By default it is set to 20ms.
- setEnabled(p) - Method in class io.scanbot.sdk.camera.autosnapping.BaseAutoSnappingController
-
Flag to disable autosnapping processing. In case of false frames will be skipped.
- setEnabled(p) - Method in class io.scanbot.sdk.camera.autosnapping.ShakeAutoSnappingPredicate
-
- setFixedFinderHeight(fixedFinderHeight) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
Set fixed Finder view window height.
- setFixedFinderHeightInPx(p) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- setFixedFinderWidth(fixedFinderWidth) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
Set fixed Finder view window width.
- setFixedFinderWidthInPx(p) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- setForceAutofocusBeforeSnap(forceAutofocusBeforeSnap) - Method in class io.scanbot.sdk.camera.autosnapping.BaseAutoSnappingController
-
- setInitialFinderViewSize() - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- setInitialFinderViewSize() - Method in class io.scanbot.sdk.ui.camera.ZoomFinderOverlayView
-
- setInitialPreviewHeight(p) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- setInitialPreviewMode(p) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- setInitialPreviewWidth(p) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- setLifecycleOwner(p) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
- setLogger(p) - Static method in class io.scanbot.sdk.util.log.LoggerProvider
-
- setMinFinderPadding(p) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- setMoveThreshold(p) - Method in interface io.scanbot.sdk.camera.autosnapping.SignificantMoveListener
-
- setOpticalZoomLevel(zoomLevel) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Sets current zoom by a linear zoom value ranging from 0f to 1.0f. Zoom Level 0f represents the minimum zoom while Zoom Level 1.0f represents the maximum zoom.
Default value is 0f.
- setOpticalZoomLevel(zoomLevel) - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
Sets current zoom by a linear zoom value ranging from 0f to 1.0f. Zoom Level 0f represents the minimum zoom while Zoom Level 1.0f represents the maximum zoom.
Default value is 0f.
- setOpticalZoomLevel(zoomLevel) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Sets current zoom by a linear zoom value ranging from 0f to 1.0f. Zoom Level 0f represents the minimum zoom while Zoom Level 1.0f represents the maximum zoom.
Default value is 0f.
- setOpticalZoomRange(zoomRange) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
- setOpticalZoomRange(zoomRange) - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
- setOpticalZoomRange(zoomRange) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
- setOverlayColor(overlayColor) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
Changes fill color of the Finder view
- setPictureSize(pictureSize) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Set camera picture size
- setPictureSize(pictureSize) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Set camera picture size
- setPreviewMode(mode) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Set the camera preview mode.
By default - CameraPreviewMode.FILL_IN.
- setPreviewMode(mode) - Method in interface io.scanbot.sdk.ui.camera.IScanbotCameraView
-
Set the camera preview mode.
By default - CameraPreviewMode.FILL_IN.
- setPreviewMode(previewMode) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Set the camera preview mode.
By default - CameraPreviewMode.FILL_IN.
- setPreviewSize(previewSize) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Set camera preview size
- setPreviewSize(previewSize) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Set camera preview size
- setRequiredAspectRatios(requiredAspectRatios) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
Set required {@link PageAspectRatio}s.
- setRequiredAspectRatiosInternal(p) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- setScaleX(scaleX) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- setScaleY(scaleY) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
- setSensitivity(sensitivity) - Method in class io.scanbot.sdk.camera.autosnapping.BaseAutoSnappingController
-
Changes sensitivity of auto-snapping. That is: the more sensitive it is the faster it shoots.
- setSensitivity(sensitivity) - Method in class io.scanbot.sdk.camera.autosnapping.CaptureIntervalAutoSnappingPredicate
-
- setShakeDetectionEnabled(enabled) - Method in class io.scanbot.sdk.camera.autosnapping.BaseAutoSnappingController
-
Allows to enable or disable shake detection before autosnapping.
It will wait for 2 seconds of stable values from accelerometer before taking a picture. Default is true
- setShutterSound(enabled) - Method in class io.scanbot.sdk.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.
- setStateListener(value) - Method in class io.scanbot.sdk.camera.autosnapping.BaseAutoSnappingController
-
- setStateListener(p) - Method in class io.scanbot.sdk.camera.autosnapping.CaptureIntervalAutoSnappingPredicate
-
- setStrokeColor(strokeColor) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
Changes stroke color of the Finder view.
- setStrokeWidth(strokeWidth) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
Changes stroke width of the Finder view.
- setSupportedPictureSizes(p) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
- setSupportedPreviewSizes(p) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
- setUiZoomLevel(zoomLevel) - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Passes the zoom value to the dependent view
- setUiZoomLevel(zoomLevel) - Method in class io.scanbot.sdk.ui.camera.ScanbotCameraXView
-
Passes the zoom value to the dependent view
- setUiZoomLevel(zoomLevel) - Method in interface io.scanbot.sdk.ui.camera.UiZoomDelegate
-
Passes the zoom value to the dependent view
- setUseBounceInterpolator(p) - Method in class io.scanbot.sdk.ui.FadeAnimationView
-
Sets if should fade animation play with bounce or with linear interpolator
- setVerticalOffset(offset) - Method in class io.scanbot.sdk.ui.camera.FinderOverlayView
-
Set vertical padding for the Finder window from the center of screen
- setZoomLevel(value) - Method in class io.scanbot.sdk.ui.camera.ZoomFinderOverlayView
-
Allows the user to set the needed zoom level for the finder and for dependent views.
If the new value is too big it will be clamped to fill the screen according to given padding
- ShakeAutoSnappingPredicate - Class in io.scanbot.sdk.camera.autosnapping
-
Validation that tracks significant movements and allows snap
only after some time passed since last significant move.
- ShakeAutoSnappingPredicate(context, moveCallback) - Constructor for class io.scanbot.sdk.camera.autosnapping.ShakeAutoSnappingPredicate
-
Validation that tracks significant movements and allows snap
only after some time passed since last significant move.
- showToast(context, messageRes) - Static method in class io.scanbot.sdk.util.thread.ExecutionUtils
-
Shows toast. Can be executed from background thread.
- SignificantMoveCatcher - Class in io.scanbot.sdk.camera.autosnapping
-
Determines device movements
- SignificantMoveCatcher(context) - Constructor for class io.scanbot.sdk.camera.autosnapping.SignificantMoveCatcher
-
Determines device movements
- SignificantMoveListener - Interface in io.scanbot.sdk.camera.autosnapping
-
Get notified about move that passed threshold
- SignificantMoveListener.Companion - Class in io.scanbot.sdk.camera.autosnapping
-
- SnapFlashView - Class in io.scanbot.sdk.camera
-
- SnapFlashView(context, attrs) - Constructor for class io.scanbot.sdk.camera.SnapFlashView
-
- SourceFileDoesNotExistException - Exception in io.scanbot.sdk.exceptions.crypto
-
Thrown when Encriptor/Decriptor can't access to files
- SourceFileDoesNotExistException() - Constructor for exception io.scanbot.sdk.exceptions.crypto.SourceFileDoesNotExistException
-
Thrown when Encriptor/Decriptor can't access to files
- startPreview() - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Starts/resumes camera preview stream. Usually used after picture was taken.
Note, that preview is started by default after
.onResume, so there is no need
to call it at the start of the app.
- startProgressAnimation() - Method in class io.scanbot.sdk.ui.FadeAnimationView
-
- stopPreview() - Method in class io.scanbot.sdk.camera.ScanbotCameraView
-
Stops camera preview stream.
- stopProgressAnimation() - Method in class io.scanbot.sdk.ui.FadeAnimationView
-
- StubLogger - Class in io.scanbot.sdk.util.log
-
Dummy logger impl for log mode off
- StubLogger() - Constructor for class io.scanbot.sdk.util.log.StubLogger
-
Dummy logger impl for log mode off
- Success(value) - Constructor for class io.scanbot.sdk.camera.FrameHandlerResult.Success
-