core/com.miteksystems.misnap.core/MiSnapSettings

MiSnapSettings

@Serializable
class MiSnapSettings(val useCase: MiSnapSettings.UseCase, val license: String) : Cloneable

The main configuration object across all the MiSnap SDK capabilities.

Parameters

useCase

Use cases describe at a high level the purpose of the session.

license

The license to use the various features of the SDK.

NOTE: Ensure that the license has the relevant features enabled for the target UseCase and desired capabilities.

Constructors

Link copied to clipboard
constructor(useCase: MiSnapSettings.UseCase, license: String)

Types

Link copied to clipboard
@Serializable
class Analysis : Cloneable

Defines options and settings for the analysis of frames with different SDK sciences.

Link copied to clipboard
@Serializable
class Camera : Cloneable

Describes options and settings for the camera.

Link copied to clipboard
@Serializable
class Nfc : Cloneable

Defines options and settings for NFC chip reading.

Link copied to clipboard
enum UseCase : Enum<MiSnapSettings.UseCase>

Describes at a high level the purpose of a MiSnap session.

Link copied to clipboard
@Serializable
class Voice : Cloneable

Defines options and settings for voice processing.

Link copied to clipboard
@Serializable
class Workflow : Cloneable

Defines options and settings to affect the session workflow UI and behavior.

Properties

Link copied to clipboard
@JvmField
val analysis: MiSnapSettings.Analysis

Settings for the various sciences that analyze images.

Link copied to clipboard
@JvmField
val camera: MiSnapSettings.Camera

Settings for the camera.

Link copied to clipboard
Link copied to clipboard
@JvmField
val nfc: MiSnapSettings.Nfc

Settings for the NFC reader component.

Link copied to clipboard
Link copied to clipboard
@JvmField
val voice: MiSnapSettings.Voice

Settings for voice processor component.

Link copied to clipboard
@JvmField
val workflow: MiSnapSettings.Workflow

Setting for the workflow.