iOS Yoonit Camera

◻ Camera preview (Front & Back) ◻ Yoonit Facefy integration ◻ Face detection, capture and image crop ◻ Understanding of the human face ◻ Frame capture ◻ Capture timed images ◻ QR Code scanning

Sponsors

Platinum

Become a sponsor!

Table of Contents

• Installation
• Usage
  • Camera Preview
  • Start capturing face images
  • Start scanning QR Codes
• API
  • Variables
  • Methods
  • Events
    • Face Analysis
    • Head Movements
    • Image Quality
  • KeyError
  • Message
• To contribute and make it better

Installation

Add the following line to your Podfile file:

pod 'YoonitCamera'

And run in the root of your project:

pod install

Usage

All the functionalities that the ios-yoonit-camera provides is accessed through the CameraView, that includes the camera preview. See an example how we use in our Demo.

Below we have the basic usage code, for more details, see the API section.

Camera Preview

@IBOutlet var cameraView: CameraView!

Do not forget request camera permission. Start camera preview:

self.cameraView.startPreview()

Start capturing face images

With camera preview, we can start capture detected face and generate images:

self.cameraView.startCaptureType("face")

Set camera event listener to get the result:

class YourViewController: UIViewController, CameraEventListenerDelegate {
    ...
    self.cameraView.cameraEventListener = self
    ...
    func onImageCaptured(
        _ type: String, 
        _ count: Int, 
        _ total: Int, 
        _ imagePath: String,
        _ darkness: NSNumber?,
        _ lightness: NSNumber?,
        _ sharpness: NSNumber?
    ) {
        // YOUR CODE
    }
    
    func onFaceDetected(
        _ x: Int, 
        _ y: Int, 
        _ width: Int, 
        _ height: Int, 
        _ leftEyeOpenProbability: NSNumber?, 
        _ rightEyeOpenProbability: NSNumber?, 
        _ smilingProbability: NSNumber?, 
        _ headEulerAngleX: NSNumber?, 
        _ headEulerAngleY: NSNumber?, 
        _ headEulerAngleZ: NSNumber?
    ) {
        // YOUR CODE
    }
    ...
}

Start scanning QR Codes

With camera preview, we can start scanning QR codes:

self.cameraView.startCaptureType("qrcode")

Set camera event listener to get the result:

class YourViewController: UIViewController, CameraEventListenerDelegate {
    ...
    self.cameraView.cameraEventListener = self
    ...
    func onQRCodeScanned(content: String) {
        // YOUR CODE
    }
}

API

Variables

Methods

Events

Face Analysis

The face analysis is the response send by the onFaceDetected. Here we specify all the parameters.

Head Movements

Here we explaining the above gif and how reached the "results". Each "movement" (vertical, horizontal and tilt) is a state, based in the angle in degrees that indicate head direction;

Image Quality

The image quality is the classification of the three attributes: darkness, lightness and sharpness. Result available in the onImageCaptured event. Let's see each parameter specifications:

KeyError

Pre-define key error used by the onError event.

Message

Pre-define key messages used by the onMessage event.

To contribute and make it better

Clone the repo, change what you want and send PR. For commit messages we use Conventional Commits.

Contributions are always welcome!

Code with ❤ by the Yoonit Team