MBCaptureSessionOptions

class MBCaptureSessionOptions

Describes the capture session options, they are initially set by a default value.

Parameters

numberOfFrameToCollect

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

frameInterval

after collected the first frame, is the number of frames to skip before collecting a frame.

numberOfFramesBeforeCapture

describes the number of frames to skip before it start collecting.

automaticCapture

tells whether the capture is automatic or manual

targetResolution

are the resolution values from caller device.

timeBeforeAutomaticCapture

is the set time in second the capture should wait to start collecting frames.

cameraSelector

describes whether we want to use front or rear camera.

scaleType

fits the video content to the view either by cropping or letterboxing maintaining the original aspect ratio

Types

Builder
Link copied to clipboard
data class Builder(numberOfFrameToCollect: Int, frameInterval: Int, numberOfFramesBeforeCapture: Int, referenceImage: ByteArray, automaticCapture: Boolean, targetResolution: Size, timeBeforeAutomaticCapture: Int, cameraSelector: MBCaptureSessionOptions.MBCameraSelector, scaleType: MBPreviewScaleType)
CaptureMode
Link copied to clipboard
enum CaptureMode : Enum<MBCaptureSessionOptions.CaptureMode>
MBCameraSelector
Link copied to clipboard

Properties

automaticCapture
Link copied to clipboard
val automaticCapture: Boolean
tells whether the capture is automatic or manual
cameraSelector
Link copied to clipboard
describes whether we want to use front or rear camera.
frameInterval
Link copied to clipboard
val frameInterval: Int
after collected the first frame, is the number of frames to skip before collecting a frame.
numberOfFramesBeforeCapture
Link copied to clipboard
val numberOfFramesBeforeCapture: Int
describes the number of frames to skip before it start collecting.
numberOfFrameToCollect
Link copied to clipboard
val numberOfFrameToCollect: Int
describes the number of frames to collect during the capture session.
scaleType
Link copied to clipboard
val scaleType: MBPreviewScaleType
fits the video content to the view either by cropping or letterboxing maintaining the original aspect ratio
targetResolution
Link copied to clipboard
val targetResolution: Size
are the resolution values from caller device.
timeBeforeAutomaticCapture
Link copied to clipboard
val timeBeforeAutomaticCapture: Int
is the set time in second the capture should wait to start collecting frames.