core/com.miteksystems.misnap.core/MiSnapCameraInfo

MiSnapCameraInfo

@Serializable

data class MiSnapCameraInfo(val supportsAutoAnalysis: Boolean, val supportsAutoFocus: Boolean, val supportsTorch: Boolean, val supportedPreviewSize: Size, val supportedImageAnalysisSize: Size, val supportedPictureSize: Size, val deviceHardwareLevel: String, val facingDirection: String, val supportedImageAnalysisHighResolutionSize: Size? = null, val supportedPictureHighResolutionSize: Size? = null)

Consolidates the interpreted results of what the camera supports according to specific business logic.

Constructors

MiSnapCameraInfo

constructor(supportsAutoAnalysis: Boolean, supportsAutoFocus: Boolean, supportsTorch: Boolean, supportedPreviewSize: Size, supportedImageAnalysisSize: Size, supportedPictureSize: Size, deviceHardwareLevel: String, facingDirection: String, supportedImageAnalysisHighResolutionSize: Size? = null, supportedPictureHighResolutionSize: Size? = null)

Properties

deviceHardwareLevel

val deviceHardwareLevel: String

The hardware level of the camera device, this is a general indication of the capabilities of the camera.

facingDirection

val facingDirection: String

The facing direction of the camera, useful to identify if the camera is facing front or back.

supportedImageAnalysisHighResolutionSize

@Serializable(with = MiSnapSettings.SizeSerializer::class)

val supportedImageAnalysisHighResolutionSize: Size? = null

The highest resolution available for image analysis in auto sessions.

supportedImageAnalysisSize

@Serializable(with = MiSnapSettings.SizeSerializer::class)

val supportedImageAnalysisSize: Size

The supported image analysis size, this size indicates the standard size of the image that the camera can produce in auto sessions.

supportedPictureHighResolutionSize

@Serializable(with = MiSnapSettings.SizeSerializer::class)

val supportedPictureHighResolutionSize: Size? = null

The highest resolution available for manual sessions.

supportedPictureSize

@Serializable(with = MiSnapSettings.SizeSerializer::class)

val supportedPictureSize: Size

The supported picture size, this size indicates the standard size of the image that the camera can produce in manual sessions.

supportedPreviewSize

@Serializable(with = MiSnapSettings.SizeSerializer::class)

val supportedPreviewSize: Size

The supported preview size that can be used to display the camera feed.

supportsAutoAnalysis

@get:JvmName(name = "supportsAutoAnalysis")

val supportsAutoAnalysis: Boolean

Whether the camera is suitable for auto analysis, if a device does not support auto analysis it should be configured to use manual mode when invoking a MiSnap session. WARNING: The use of AI-based RTS is not supported on devices that do not support auto analysis.

supportsAutoFocus

@get:JvmName(name = "supportsAutoFocus")

val supportsAutoFocus: Boolean

Whether the camera supports continuous auto focus, this is an indication that the camera can attempt to focus on the target.

supportsTorch

@get:JvmName(name = "supportsTorch")

val supportsTorch: Boolean

Whether the camera supports the torch feature for illuminating the target.