Picovoice Platform
iOS Quick Start

Platforms

• iOS (13.0+)

Requirements

• Xcode
• Swift Package Manager or CocoaPods

Picovoice Account & AccessKey

Signup or Login to Picovoice Console to get your AccessKey. Make sure to keep your AccessKey secret.

Quick Start

Setup

1. Install Xcode.

2. Import the Picovoice-iOS package into your project.

To import the package using SPM, open up your project's Package Dependencies in XCode and add:

https://github.com/Picovoice/picovoice.git

To import it into your iOS project using CocoaPods, add the following line to your Podfile:

pod 'Picovoice-iOS'

Then run the following from the project directory:

pod install

3. Add the following to the app's Info.plist file to enable recording with an iOS device's microphone

<key>NSMicrophoneUsageDescription</key>
<string>[Permission explanation]</string>

Usage

Include a Porcupine keyword file (.ppn) and a Rhino context file (.rhn) in the app as a bundled resource (found by selecting in Build Phases > Copy Bundle Resources). Then, get its path from the app bundle:

let keywordPath = Bundle.main.path(forResource: "${KEYWORD_IOS}", ofType: "ppn")
let contextPath = Bundle.main.path(forResource: "${CONTEXT_IOS}", ofType: "rhn")

Alternatively, if the model files are deployed to the device with a different method, the absolute paths to the files on device can be used.

Create an instance of PicovoiceManager that detects the wake word and infers intents from spoken commands:

import Picovoice

do {
   let picovoiceManager = try PicovoiceManager(
      accessKey: "${ACCESS_KEY}",
      keywordPath: keywordPath,
      onWakeWordDetection: {
         // logic to execute upon deletection of wake word
      },
      contextPath: contextPath,
      onInference: { inference in
            if inference.isUnderstood {
               let intent:String = inference.intent
               let slots:Dictionary<String,String> = inference.slots
               // take action based on inferred intent and slot values
            } else {
               // handle unsupported commands
            }
      }
   )
catch { }

Start audio capture:

do {
    try picovoiceManager.start()
} catch { }

Stop audio capture and processing with:

do {
   try picovoiceManager.stop()
} catch { }

Release resources explicitly when done with Picovoice:

picovoiceManager.delete()

Custom Wake Words & Contexts

Create custom models using the Picovoice Console. Download the custom Porcupine keyword (.ppn) and Rhino context (.rhn) files and include them in the app as a bundled resource (found by selecting in Build Phases > Copy Bundle Resources).

Non-English Languages

Use the corresponding model file (.pv) to infer non-English wake words and contexts. The model files for all supported languages are available on the Porcupine GitHub repository and Porcupine GitHub repository.

Pass in the model file using the porcupineModelPath and rhinoModelPath input arguments to change the language:

let porcupineModelPath = Bundle.main.path(forResource: "${PORCUPINE_MODEL_FILE}", ofType: "pv")
let rhinoModelPath = Bundle.main.path(forResource: "${RHINO_MODEL_FILE}", ofType: "pv")

do {
   let manager = try PicovoiceManager(
      accessKey: "${ACCESS_KEY}",
      keywordPath: keywordPath,
      onWakeWordDetection: {
         // logic to execute upon deletection of wake word
      },
      porcupineModelPath: porcupineModelPath,
      contextPath: contextPath,
      onInference: { inference in
         // logic to execute upon completion of intent inference
      }
      rhinoModelPath: rhinoModelPath
   )
} catch { }

Alternatively, if the model files are deployed to the device with a different method, the absolute paths to the files on device can be used.

Demo

For the Picovoice iOS SDK, we offer demo applications that demonstrate how to use the end-to-end speech recognition platform on real-time audio streams (i.e. microphone input).

Setup

Clone the Repository

git clone --recurse-submodules https://github.com/Picovoice/picovoice.git

Usage

1. Install dependencies:

cd demo/ios/ForegroundApp
pod install

2. Open the PicovoiceForegroundAppDemo.xcworkspace.

3. Replace "${YOUR_ACCESS_KEY_HERE}" in the file ContentView.swift with a valid AccessKey.

4. Go to Product > Scheme and select the scheme for the language you would like to demo (e.g. arDemo -> Arabic Demo, deDemo -> German Demo).

5. Run the demo with a simulator or connected iOS device.

For more information on our Picovoice demos for iOS, head over to our GitHub repository.

Resources