1 of 1

Configure the SDK (UIKit)

To configure the SDK, we need to provide a key. Obtain your Passio key from the Passio developer portal
Create a new or open your existing project in Xcode and import the framework inside the View Controller

Define reference of SDK inside your View Controller

Configure the SDK using PassioConfiguration shown in below code. Call configurePassioSDK() when you need to configure SDK e.g. inside viewDidLoad() function.

The models required for the SDK to run local recognition can take some time for the first download. If the local recognition is not needed, setting the remoteOnly to true on the PassioConfiguration process will skip the download of the models. Remote recognition functions like recognizeImageRemote or searchForFood will still work.

Implement the PassioStatusDelegate protocol to receive configuration status updates. While the files are being downloaded, we can show in UI how many files are remanning for the download.

Update the UI based on the configuration status. The isReadyForDetection status indicated that the SDK is setup successfully and it is ready to use. The implementation of self.askForCapturePermission() method will be covered in the next section

Configure the SDK (UIKit)

To configure the SDK, we need to provide a key. Obtain your Passio key from the Passio developer portal
Create a new or open your existing project in Xcode and import the framework inside the View Controller

Define reference of SDK inside your View Controller

Configure the SDK using PassioConfiguration shown in below code. Call configurePassioSDK() when you need to configure SDK e.g. inside viewDidLoad() function.

Implement the PassioStatusDelegate protocol to receive configuration status updates. While the files are being downloaded, we can show in UI how many files are remanning for the download.

extension ImageSelectionVC: PassioStatusDelegate {
    
    func passioStatusChanged(status: PassioStatus) {
        print("Status changed: \(status)")
        configureUI(status: status)
    }
    
    func passioProcessing(filesLeft: Int) {
        print("Files to download: \(filesLeft)")
    }
    
    func completedDownloadingAllFiles(filesLocalURLs: [FileLocalURL]) {
        print("All files downloaded")
    }
    
    func completedDownloadingFile(fileLocalURL: FileLocalURL, filesLeft: Int) {
        print("File downloaded: \(fileLocalURL)")
    }
    
    func downloadingError(message: String) {
        print("Downloading error: \(message)")
    }
}

Update the UI based on the configuration status. The isReadyForDetection status indicated that the SDK is setup successfully and it is ready to use. The implementation of self.askForCapturePermission() method will be covered in the next section

func configureUI(status: PassioStatus) {
    
    DispatchQueue.main.async {
    
        switch status.mode {
        
        case .isReadyForDetection:
            // The SDK is ready for detection. Hide the status view.
            self.statusView.isHidden = true  
            // This will be covered in the next section
            self.askForCapturePermission()
            
        case .isBeingConfigured:
            self.statusLabel.text = "Configuraing SDK..."
            
        case .failedToConfigure:
            self.statusLabel.text = "SDK failed to configure!"
            
        case .isDownloadingModels:
            self.statusLabel.text = "SDK is downloading files..."
            
        case .notReady:
            self.statusLabel.text = "SDK is not ready!"
            
        @unknown default:
            self.statusLabel.text = "Unknown passio status!"
        }
    }
}

func configurePassioSDK() {
    
    passioSDK.statusDelegate = self
    
    let PASSIO_KEY = "YOUR_PASSIO_KEY"
    var passioConfig = PassioConfiguration(key: PASSIO_KEY)
    passioConfig.remoteOnly = true

    passioSDK.configure(passioConfiguration: passioConfig) { status in
        print("Mode = \(status.mode)")
        print("Missing files = \(String(describing: status.missingFiles))")
    }
}

extension ImageSelectionVC: PassioStatusDelegate {
    
    func passioStatusChanged(status: PassioStatus) {
        print("Status changed: \(status)")
        configureUI(status: status)
    }
    
    func passioProcessing(filesLeft: Int) {
        print("Files to download: \(filesLeft)")
    }
    
    func completedDownloadingAllFiles(filesLocalURLs: [FileLocalURL]) {
        print("All files downloaded")
    }
    
    func completedDownloadingFile(fileLocalURL: FileLocalURL, filesLeft: Int) {
        print("File downloaded: \(fileLocalURL)")
    }
    
    func downloadingError(message: String) {
        print("Downloading error: \(message)")
    }
}

func configureUI(status: PassioStatus) {
    
    DispatchQueue.main.async {
    
        switch status.mode {
        
        case .isReadyForDetection:
            // The SDK is ready for detection. Hide the status view.
            self.statusView.isHidden = true  
            // This will be covered in the next section
            self.askForCapturePermission()
            
        case .isBeingConfigured:
            self.statusLabel.text = "Configuraing SDK..."
            
        case .failedToConfigure:
            self.statusLabel.text = "SDK failed to configure!"
            
        case .isDownloadingModels:
            self.statusLabel.text = "SDK is downloading files..."
            
        case .notReady:
            self.statusLabel.text = "SDK is not ready!"
            
        @unknown default:
            self.statusLabel.text = "Unknown passio status!"
        }
    }
}