Android Scanbot SDK API reference/io.scanbot.sdk.ui_v2.common/BaseViewFinderConfiguration

BaseViewFinderConfiguration

sealed class BaseViewFinderConfiguration : Parcelable

Base configuration of the scanning interface’s viewfinder, serving as guidance to the user.

Inheritors

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract val _type: String
Link copied to clipboard
abstract var aspectRatio: AspectRatio

The viewfinder's aspect ratio.

Link copied to clipboard
abstract var minimumInsets: EdgeInsets

The minimum insets of the viewfinder.

Link copied to clipboard
abstract var overlayColor: ScanbotColor

The color of the viewfinder overlay.

Link copied to clipboard
abstract var preferredHeight: Double

The preferred height of the viewfinder.

Link copied to clipboard
abstract var style: FinderStyle

The visual appearance of the viewfinder.

Functions

Link copied to clipboard
Link copied to clipboard
fun BaseViewFinderConfiguration.toFinder(bottomSafeArea: <Error class: unknown class>, hintHeight: <Error class: unknown class>? = null, topSafeArea: <Error class: unknown class>, aspectRatio: AspectRatio? = null, insets: <Error class: unknown class> = PaddingValues( bottom = (hintHeight ?: 0.dp) + this.minimumInsets.bottom.dp, top = this.minimumInsets.top.dp, start = this.minimumInsets.left.dp, end = this.minimumInsets.right.dp ), topLayer: (<Error class: unknown class>) -> Unit = {}, bottomLayer: (<Error class: unknown class>) -> Unit = {}, topContent: () -> Unit = {}, bottomContent: () -> Unit = {}, finderContent: () -> Unit = {}): FinderConfiguration?
Link copied to clipboard
abstract fun toJson(config: ToJsonConfiguration = ToJsonConfiguration.default()): JSONObject