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

Builder

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.

Constructors

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

Properties

automaticCapture

var automaticCapture: Boolean

var cameraQuality: MBCameraOptions

captureConstrains

var captureConstrains: MBCaptureConstrains

var features: MBFeatures

imageQualityLevel

var imageQualityLevel: MBImageQualityLevel

var isDebugging: Boolean

numberOfFrameToCollect

var numberOfFrameToCollect: Int

payloadOptimization

var payloadOptimization: Boolean

var showOval: Boolean

timeBeforeAutomaticCapture

var timeBeforeAutomaticCapture: Int

videoCaptureDuration

var videoCaptureDuration: Int

Functions

automaticCapture

fun automaticCapture(enabled: Boolean): <Error class: unknown class>

Enable or disable automatic capture during the session.

fun build(): MBCaptureSessionOptions

Build an instance of MBCaptureSessionOptions with the configured parameters.

fun cameraQuality(cameraQuality: MBCameraOptions): <Error class: unknown class>

Set the camera quality options.

captureConstrains

fun captureConstrains(captureConstrains: MBCaptureConstrains): <Error class: unknown class>

Decide the type of face validation is gonna be executed.

fun debugging(isDebugging: Boolean): <Error class: unknown class>

Enable or disable debugging mode.

framesToCollect

fun framesToCollect(num: Int): <Error class: unknown class>

Set the number of frames to collect during the capture session.

imageQualityLevel

fun imageQualityLevel(imageQualityLevel: MBImageQualityLevel): <Error class: unknown class>

Set how strict the V3 image-quality lighting gate is. This option has no effect for V1 or V2 capture.

payloadOptimization

fun payloadOptimization(payloadOptimization: Boolean): <Error class: unknown class>

Enable or disable payload optimization.

timeBeforeCapture

fun timeBeforeCapture(seconds: Int): <Error class: unknown class>

Set the time delay before automatic capture starts.

videoCaptureDuration

fun videoCaptureDuration(milliseconds: Int): <Error class: unknown class>

Set the total duration (in milliseconds) of the video segment to be captured during the session.