Cheetah Speech-to-Text
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 Cheetah-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/cheetah.git

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

pod 'Cheetah-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>

Model File

Add the Cheetah Streaming Speech-to-Text model file in Xcode:

1. Create a model in Picovoice Console or use the default model.
2. Add the model as a bundled resource by selecting Build Phases and adding it to Copy Bundle Resources step.

Usage

Create an instance of Cheetah Streaming Speech-to-Text:

import Cheetah

let accessKey = "${ACCESS_KEY}"
let modelPath = Bundle(for: type(of: self)).path(
        forResource: "${CHEETAH_MODEL_FILE}",
        ofType: "pv")!

do {
    let cheetah = Cheetah(accessKey: accessKey, modelPath: modelPath, endpointDuration: 1.0)
} catch { }

Alternatively, you can provide modelPath as an absolute path to the model file on device.

Transcribe audio:

func getNextAudioFrame() -> [Int16] {
  // ...
  return audioFrame;
}

while true {
  do {
    let partialTranscript, isEndpoint = try cheetah.process(getNextAudioFrame())
    if isEndpoint {
      let finalTranscript = try cheetah.flush()
    }
  } catch let error as CheetahError {
      // handle error
  } catch { }
}

Release resources explicitly when done with Cheetah Streaming Speech-to-Text:

cheetah.delete()

Non-English Languages

In order to use Cheetah with other languages, you need to use the corresponding model file (.pv) for the desired language. The model files for all supported languages are available on the Cheetah GitHub repository.

Demo

For the Cheetah Streaming Speech-to-Text iOS SDK, we offer demo applications that demonstrate how to use the Speech-to-Text engine on real-time audio streams (i.e. microphone input).

Setup

Clone the Repository:

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

Usage

1. Replace "${YOUR_ACCESS_KEY_HERE}" in the file ViewController.swift with a valid AccessKey.

2. Open the CheetahDemo.xcodeproj in XCode and run the demo.

For more information on our Cheetah Streaming Speech-to-Text demo for iOS, head over to our GitHub repository.

Resources