The Porcupine SDK requires a valid AccessKey at initialization. AccessKeys act as your credentials when using Porcupine SDKs. You can create your AccessKey for free. Make sure to keep your AccessKey secret.

To obtain your AccessKey:

Login or Signup for a free account on the Picovoice Console.
Once logged in, go to the AccessKey tab to create one or use an existing AccessKey.

BackgroundService Demo

This demo runs microphone recording in the background and detects the wake word while the application is not in focus. The wake word will be detected as long as the application remains running in the background.

The minimum iOS version required is 10.0.

To run the background service demo, go to BackgroundService directory. Then run:

pod install

Replace let accessKey = "${YOUR_ACCESS_KEY_HERE}" in the file ViewController.swift with your AccessKey.

Open PorcupineBackgroundServiceDemo.xcworkspace and run the demo.

Open up the demo and press start. The demo listens for the wake word "Porcupine". You may leave the application but the application must be running in the background to be able to continuously be detecting for the wake word.

ForegroundApp Demo

This demo runs wake word detection while the application is in focus.

To run the foreground application demo, go to ForegroundApp directory. Then run:

pod install

Replace let accessKey = "${YOUR_ACCESS_KEY_HERE}" in the file ViewController.swift with your AccessKey.

Open the PorcupineForegroundAppDemo.xcworkspace and run the demo.

The demo allows you to select any of our built-in keywords for detection. Press start and say the selected keyword.

Running the On-Device Unit Tests

Open PorcupineForegroundAppDemo.xcworkspace with XCode and run the tests with Product > Test.