Octopus Speech-to-Index
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 Octopus-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/octopus.git

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

pod 'Octopus-iOS'

Then, run the following from the project directory:

pod install

Usage

Create an instance of Octopus Speech-to-Index:

import Octopus

do {
    let octopus = try Octopus(accessKey: "${ACCESS_KEY}")
} catch { }

Index an audio file by passing in the absolute path to the file:

do {
    let metadata = try octopus.indexAudioFile(path: "${AUDIO_FILE_PATH}")
} catch { }

Search audio using the generated metadata object:

let phrases: Set<String> = ["gorilla", "terminator"]
let matches = try octopus.search(metadata: metadata, phrases: phrases)

Free resources used by Octopus Speech-to-Index:

metadata.delete();
octopus.delete();

Demo

For the Octopus Speech-to-Index iOS SDK, we offer a demo application that demonstrates how to use the Speech-to-Index engine on audio recordings.

Setup

Clone the Octopus Speech-to-Index repository from GitHub using HTTPS:

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

Usage

1. Replace "${YOUR_ACCESS_KEY_HERE}" inside the ViewModel.swift file with your AccessKey obtained from Picovoice Console.

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

For more information on our Octopus Speech-to-Index demo for iOS, head over to our GitHub repository.

Resources