MobaiBiometric/bio.mobai.library.biometrics.capturesession.options/MBCaptureSessionOptions

MBCaptureSessionOptions

class MBCaptureSessionOptions : Serializable

Configuration options for the capture session.

Use the Builder class to construct instances of MBCaptureSessionOptions with customizable parameters.

Types

data class Builder(var numberOfFrameToCollect: Int = 3, var automaticCapture: Boolean = true, var timeBeforeAutomaticCapture: Int = 1, var cameraQuality: MBCameraOptions = MBCameraOptions(), var isDebugging: Boolean = false, var payloadOptimization: Boolean = false, var showOval: Boolean = true, var features: MBFeatures = MBFeatures(), var captureConstrains: MBCaptureConstrains = MBCaptureConstrains.V1, var videoCaptureDuration: Int = 1000, var imageQualityLevel: MBImageQualityLevel = MBImageQualityLevel.LEVEL_3)

Builder class for constructing instances of MBCaptureSessionOptions with customizable parameters.

Properties

autoCaptureEnabled

val autoCaptureEnabled: Boolean

Indicates whether automatic capture is enabled during the session.

val cameraQuality: MBCameraOptions

The camera quality options represented by MBCameraOptions.

captureConstrains

val captureConstrains: MBCaptureConstrains

Indicates whether executing landmark or bounding box validation capturing.

imageQualityLevel

val imageQualityLevel: MBImageQualityLevel

Selects how strict the image-quality lighting gate is.

var isDebugging: Boolean

Indicates whether debugging mode is enabled.

numberOfFrameToCollect

val numberOfFrameToCollect: Int

The number of frames to collect during the capture session. Must be between 1 and 10 (inclusive).

payloadOptimization

val payloadOptimization: Boolean

Indicates whether payload optimization is enabled.

timeBeforeAutomaticCapture

val timeBeforeAutomaticCapture: Int

The time delay (in seconds) before automatic capture starts. Must be between 0 and 45 (inclusive).

videoCaptureDuration

val videoCaptureDuration: Int

The total duration (in milliseconds) of the video segment to be captured during the session. Minimum value is 1000ms and maximum value is 3000ms.