View on GitHub

sensibill-android-documentation

com.getsensibill.capturestandalone.models / CaptureConfig

CaptureConfig

data class CaptureConfig : Serializable

Configuration class to be sent to CaptureStandaloneActivity. This class defines the configurable behaviour for CaptureStandaloneActivity

Constructors

Name Summary
<init> CaptureConfig(allowFlashToggling: Boolean = true, defaultFlashMode: FlashMode = FlashMode.FLASH_MODE_AUTO, enableAutoCapture: Boolean = true, initialAutoCaptureState: Boolean = true, enableBlurDetection: Boolean = true, enableFeedbackToast: Boolean = true, enableGalleryImport: Boolean = true, enableMultiPageCapture: Boolean = true, maxPages: Int = 3, enableLongCapture: Boolean = true, enableCrop: Boolean = true, enableSecureWindow: Boolean = false, attachLocationData: Boolean = false)
Configuration class to be sent to CaptureStandaloneActivity. This class defines the configurable behaviour for CaptureStandaloneActivity

Properties

Name Summary
allowFlashToggling val allowFlashToggling: Boolean
Allows the user to toggle the flash mode.
attachLocationData val attachLocationData: Boolean
Enables attaching GPS location data via EXIF to captured images.
defaultFlashMode val defaultFlashMode: FlashMode
Sets the default flash mode that will be used by the camera
enableAutoCapture val enableAutoCapture: Boolean
Enables the auto-capture feature.
enableBlurDetection val enableBlurDetection: Boolean
Enables the blur detection feature.
enableCrop val enableCrop: Boolean
Enables the user to manually crop, or adjust the existing cropping on a captured image.
enableFeedbackToast val enableFeedbackToast: Boolean
Enables a feedback toast message on the capture screen.
enableGalleryImport val enableGalleryImport: Boolean
Enables the ability for a user to select an image from their device’s image gallery.
enableLongCapture val enableLongCapture: Boolean
Enables the long receipt feature.
enableMultiPageCapture val enableMultiPageCapture: Boolean
Allows the user to capture multiple distinct images in a single capture flow.
enableSecureWindow val enableSecureWindow: Boolean
Enables Android’s secure window feature for the capture flow. When enabled, the user will be unable to take screenshots or record the screen.
initialAutoCaptureState val initialAutoCaptureState: Boolean
Sets the initial state of the auto-capture functionality (true represents ON).
maxPages val maxPages: Int
Determines the maximum number of distinct images that can be captured in a single capture flow.