Android Scanbot SDK API reference/io.scanbot.sdk.ui.view.camera.configuration.json

Package-level declarations

Types

Link copied to clipboard
enum CapturePhotoQualityPrioritization : Enum<CapturePhotoQualityPrioritization>

The prioritization of still image quality and capturing speed. Has no effect on devices prior to iOS 13.0. iOS only.

Link copied to clipboard
data class DocumentScannerJsonConfiguration(var version: String? = null, var screen: String? = null, var acceptedAngleScore: Double? = null, var acceptedSizeScore: Double? = null, var acceptedBrightnessThreshold: Double? = null, var autoSnappingButtonHidden: Boolean? = null, var autoSnappingButtonTitle: String? = null, var autoSnappingEnabled: Boolean? = null, var autoSnappingSensitivity: Double? = null, var bottomBarBackgroundColor: JsonColor? = null, var bottomBarButtonsColor: JsonColor? = null, var cameraModule: JsonCameraModule? = null, var cameraBackgroundColor: JsonColor? = null, var cameraPreviewMode: JsonCameraPreviewMode? = null, var touchToFocusEnabled: Boolean? = null, var cancelButtonTitle: String? = null, var defaultPageFilter: JsonImageFilterType? = null, var enableCameraButtonTitle: String? = null, var enableCameraExplanationText: String? = null, var flashButtonHidden: Boolean? = null, var flashButtonTitle: String? = null, var flashEnabled: Boolean? = null, var forceUserGuidance: Boolean? = null, var ignoreOrientationMismatch: Boolean? = null, var imageScale: Double? = null, var multiPageButtonHidden: Boolean? = null, var multiPageButtonTitle: String? = null, var multiPageEnabled: Boolean? = null, var orientationLockMode: JsonOrientationLockMode? = null, var pageCounterButtonTitle: String? = null, var photoQualityPrioritization: JsonCapturePhotoQualityPrioritization? = null, var polygonBackgroundColor: JsonColor? = null, var polygonBackgroundColorOK: JsonColor? = null, var polygonColor: JsonColor? = null, var polygonColorOK: JsonColor? = null, var polygonLineWidth: Double? = null, var polygonCornerRadius: Double? = null, var polygonAutoSnapProgressColor: JsonColor? = null, var polygonAutoSnapProgressLineWidth: Double? = null, var polygonAutoSnapProgressEnabled: Boolean? = null, var requiredAspectRatios: List<JsonAspectRatio>? = null, var shutterButtonAutoInnerColor: JsonColor? = null, var shutterButtonAutoOuterColor: JsonColor? = null, var shutterButtonManualInnerColor: JsonColor? = null, var shutterButtonManualOuterColor: JsonColor? = null, var textHintBadAngles: String? = null, var textHintBadAspectRatio: String? = null, var textHintNothingDetected: String? = null, var textHintOffCenter: String? = null, var textHintOK: String? = null, var textHintTooDark: String? = null, var textHintTooNoisy: String? = null, var textHintTooSmall: String? = null, var topBarBackgroundColor: JsonColor? = null, var topBarButtonsActiveColor: JsonColor? = null, var topBarButtonsInactiveColor: JsonColor? = null, var userGuidanceBackgroundColor: JsonColor? = null, var userGuidanceTextColor: JsonColor? = null, var userGuidanceFontSize: Double? = null, var documentImageSizeLimit: JsonSize? = null, var shutterButtonHidden: Boolean? = null, var maxNumberOfPages: Int? = null, var useButtonsAllCaps: Boolean? = null, var accessibilityConfiguration: JsonDocumentScannerAccessibilityConfiguration? = null) : Parcelable
Link copied to clipboard
class DocumentScannerNativeConfiguration(var delayAfterFocusCompleteMs: Long? = null, var drawPolygonShadows: Boolean? = null, var shutterSoundEnabled: Boolean? = null, var forceMaxSnappingSize: Boolean? = null, var hardwareSnapButton: Int? = null, var defaultPageParametricFilter: ParametricFilter? = null) : Parcelable
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class FinderDocumentScannerJsonConfiguration(var version: String? = null, var screen: String? = null, var acceptedAngleScore: Double? = null, var acceptedSizeScore: Double? = null, var acceptedBrightnessThreshold: Double? = null, var autoSnappingEnabled: Boolean? = null, var autoSnappingSensitivity: Double? = null, var cameraModule: JsonCameraModule? = null, var cameraBackgroundColor: JsonColor? = null, var cameraPreviewMode: JsonCameraPreviewMode? = null, var touchToFocusEnabled: Boolean? = null, var cancelButtonTitle: String? = null, var defaultPageFilter: JsonImageFilterType? = null, var enableCameraButtonTitle: String? = null, var enableCameraExplanationText: String? = null, var flashButtonHidden: Boolean? = null, var flashEnabled: Boolean? = null, var forceUserGuidance: Boolean? = null, var finderEnabled: Boolean? = null, var finderLineColor: JsonColor? = null, var finderLineWidth: Double? = null, var cameraOverlayColor: JsonColor? = null, var finderAspectRatio: JsonAspectRatio? = null, var ignoreOrientationMismatch: Boolean? = null, var imageScale: Double? = null, var orientationLockMode: JsonOrientationLockMode? = null, var photoQualityPrioritization: JsonCapturePhotoQualityPrioritization? = null, var polygonEnabled: Boolean? = null, var polygonBackgroundColor: JsonColor? = null, var polygonBackgroundColorOK: JsonColor? = null, var polygonColor: JsonColor? = null, var polygonColorOK: JsonColor? = null, var polygonLineWidth: Double? = null, var polygonCornerRadius: Double? = null, var autoSnapProgressColor: JsonColor? = null, var autoSnapProgressLineWidth: Double? = null, var autoSnapProgressEnabled: Boolean? = null, var lockDocumentAspectRatioToFinder: Boolean? = null, var shutterButtonAutoInnerColor: JsonColor? = null, var shutterButtonAutoOuterColor: JsonColor? = null, var shutterButtonManualInnerColor: JsonColor? = null, var shutterButtonManualOuterColor: JsonColor? = null, var textHintBadAngles: String? = null, var textHintBadAspectRatio: String? = null, var textHintNothingDetected: String? = null, var textHintOffCenter: String? = null, var textHintOK: String? = null, var textHintTooDark: String? = null, var textHintTooNoisy: String? = null, var textHintTooSmall: String? = null, var topBarBackgroundColor: JsonColor? = null, var topBarButtonsActiveColor: JsonColor? = null, var topBarButtonsInactiveColor: JsonColor? = null, var userGuidanceBackgroundColor: JsonColor? = null, var userGuidanceTextColor: JsonColor? = null, var userGuidanceFontSize: Double? = null, var documentImageSizeLimit: JsonSize? = null, var shutterButtonHidden: Boolean? = null, var useButtonsAllCaps: Boolean? = null, var accessibilityConfiguration: JsonFinderDocumentScannerAccessibilityConfiguration? = null) : Parcelable
Link copied to clipboard
class FinderDocumentScannerNativeConfiguration(var delayAfterFocusCompleteMs: Long? = null, var drawPolygonShadows: Boolean? = null, var shutterSoundEnabled: Boolean? = null, var forceMaxSnappingSize: Boolean? = null, var hardwareSnapButton: Int? = null) : Parcelable
Link copied to clipboard
Link copied to clipboard
data class JsonDocumentScannerAccessibilityConfiguration(var flashButtonAccessibilityLabel: String, var flashButtonAccessibilityHint: String, var multiPageButtonAccessibilityLabel: String, var multiPageButtonAccessibilityHint: String, var autoSnappingButtonAccessibilityLabel: String, var autoSnappingButtonAccessibilityHint: String, var cancelButtonAccessibilityLabel: String, var cancelButtonAccessibilityHint: String, var pageCounterButtonAccessibilityLabel: String, var pageCounterAccessibilityHint: String, var shutterButtonAccessibilityLabel: String, var shutterButtonAccessibilityHint: String) : Parcelable

Document scanner accessibility configuration

data class JsonFinderDocumentScannerAccessibilityConfiguration(var flashButtonAccessibilityLabel: String, var flashButtonAccessibilityHint: String, var cancelButtonAccessibilityLabel: String, var cancelButtonAccessibilityHint: String, var shutterButtonAccessibilityLabel: String, var shutterButtonAccessibilityHint: String) : Parcelable

Finder Document scanner accessibility configuration

Functions

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard