SDKState

class SDKState

Represents the state of the SDK.

  • The capture mode to determine which view (ActiveFaceCapture / PassiveFaceCapture) and which camera (back / front) to show.

    Declaration

    Swift

    var captureMode: faceCaptureMode

  • The current SensePrintInfo usually obtained from a scanned SensePrint QR code.

    Declaration

    Swift

    var currentSPInfo: SensePrintInfo?

  • A flag to determine if the camera is currently scanning for QR codes.

    Declaration

    Swift

    var isCameraQRScanning: Bool

  • The holder for the session. It can be either a passive capture session or an active capture session.

    Declaration

    Swift

    var sessionHolder: SessionHolder?

  • Initializes the SDK state with the specified capture mode.

    Declaration

    Swift

    init(captureMode: faceCaptureMode)

    Parameters

    captureMode

    The capture mode to set.

  • Sets the SDK state to be in QR scanning mode.

    Declaration

    Swift

    func setQRScanningMode()

  • Sets the SDK state to be in face scanning mode.

    Declaration

    Swift

    func setFaceScanningMode()

  • Sets the passive capture session.

    Declaration

    Swift

    func setPassiveCaptureSession(passiveCaptureSession: PassiveFaceCaptureSession)

    Parameters

    passiveCaptureSession

    The passive capture session to set.

  • Sets the active capture session.

    Declaration

    Swift

    func setAcitveCaptureSession(activeCaptureSession: ActiveFaceCaptureSession)

    Parameters

    activeCaptureSession

    The active capture session to set.

  • Resets the SDK state by clearing the session holder. The SensePrintInfo and the capture mode are not reset.

    Declaration

    Swift

    func reset()