Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spokestack/spokestack-ios
Spokestack: give your iOS app a voice interface!
https://github.com/spokestack/spokestack-ios
asr hacktoberfest ios natural-language-understanding speech-api speech-processing speech-recognition speech-synthesis speech-to-text swift tensorflow text-to-speech vad voice-activity-detection voice-assistant voice-recognition voice-synthesis wakeword wakeword-activation
Last synced: 15 days ago
JSON representation
Spokestack: give your iOS app a voice interface!
- Host: GitHub
- URL: https://github.com/spokestack/spokestack-ios
- Owner: spokestack
- License: apache-2.0
- Archived: true
- Created: 2018-09-10T14:50:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-25T22:09:23.000Z (over 3 years ago)
- Last Synced: 2025-01-01T10:41:44.819Z (about 1 month ago)
- Topics: asr, hacktoberfest, ios, natural-language-understanding, speech-api, speech-processing, speech-recognition, speech-synthesis, speech-to-text, swift, tensorflow, text-to-speech, vad, voice-activity-detection, voice-assistant, voice-recognition, voice-synthesis, wakeword, wakeword-activation
- Language: Swift
- Homepage: https://spokestack.io
- Size: 9.94 MB
- Stars: 42
- Watchers: 5
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Spokestack provides an extensible speech recognition pipeline for the iOS
platform. It includes a variety of built-in speech processors for Voice
Activity Detection (VAD), wakeword activation, and Automatic Speech Recognition (ASR).
## Table of Contents
* [Features](#features)
* [Installation](#installation)
* [Usage](#usage)
* [Documentation](#Documentation)
* [Reference](#Reference)
* [Deployment](#Deployment)
* [License](#license)
## Features
- Voice activity detection
- Wakeword activation with two different implementations
- Simplified Automated Speech Recognition interface
- Speech pipeline seamlessly integrates VAD-triggered wakeword detection using on-device machine learning models with transcribing utterances using platform Automated Speech Recognition
- On-device Natural Language Understanding utterance classifier
- Simple Text to Speech API
## Installation
[](https://cocoapods.org/pods/Spokestack-iOS)
[CocoaPods](https://cocoapods.org) is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate Spokestack into your Xcode project using CocoaPods, specify it in your Podfile:
`pod 'Spokestack-iOS'`
## Usage
[Spokestack.io hosts extensive usage documentation](https://www.spokestack.io/docs/ios) including tutorials, integrations, and recipe how-tos.
### Configure Wakeword-activated Automated Speech Recognition
```
import Spokestack
// assume that self implements the SpokestackDelegate protocol
let pipeline = SpeechPipelineBuilder()
.addListener(self)
.useProfile(.appleWakewordAppleSpeech)
.setProperty("tracing", Trace.Level.PERF)
pipeline.start()
```
This example creates a speech recognition pipeline using a configurable wakeword detector that is triggered by VAD, which in turn activates an the native iOS ASR, returning the resulting utterance to the `SpokestackDelegate` observer (`self` in this example).
See `SpeechPipeline` and `SpeechConfiguration` for further configuration documentation.
### Text to Speech
```
// assume that self implements the TextToSpeechDelegate protocol
let tts = TextToSpeech(self, configuration: SpeechConfiguration())
tts.speak(TextToSpeechInput("My god, it's full of stars!"))
```
### Natural Language Understanding
```
let config = SpeechConfiguration()
config.nluVocabularyPath = "vocab.txt"
config.nluModelPath = "nlu.tflite"
config.nluModelMetadataPath = "metadata.json"
// assume that self implements the NLUDelegate protocol
let nlu = try! NLUTensorflow(self, configuration: configuration)
nlu.classify(utterance: "I can't turn that light in the room on for you, Dave", context: [:])
```
#### Troubleshooting
A build error similar to `Code Sign error: No unexpired provisioning profiles found that contain any of the keychain's signing certificates` will occur if the bundle identifier is not changed from `io.Spokestack.SpokestackFrameworkExample`, which is tied to the Spokestack organization.
## Reference
The `SpokestackFrameworkExample` project is a reference implementations for how to use the Spokestack library, along with runnable examples of the VAD, wakeword, ASR, NLU, and TTS components. Each component has a button on the main screen, and can be started, stopped, predicted, or synthesized as appropriate. The component screens have full debug tracing enabled, so the system control logic and debug events will appear in the XCode console.
## Documentation
### Getting Started, Cookbooks, and Conceptual Guides
[Step-by-step introduction](https://spokestack.io/docs/iOS/getting-started), [common usage patterns](https://spokestack.io/docs/iOS/cookbook), and [discussion of concepts](https://spokestack.io/docs/Concepts/pipeline-configuration) used by the library, [design guides for voice interfaces](https://spokestack.io/docs/Design/getting-started), and [the Android library](https://spokestack.io/docs/Android/getting-started) may all be found [on our website](https://spokestack.io/docs).
### API Reference
API reference is [available on Github](https://spokestack.github.io/spokestack-ios/index.html).
## Deployment
### Preconditions
0. Ensure that `git lfs` has been installed: https://git-lfs.github.com/. This is used to manage the storage of the large model and metadata files in `SpokestackFrameworkExample`.
1. Ensure that CocoaPods has been installed: `gem install cocoapods` ([not via `brew`](https://github.com/CocoaPods/CocoaPods/issues/8955)).
2. Ensure that you are registered in CocoaPods: `pod trunk register YOUR_EMAIL --description='release YOUR_PODSPEC_VERSION'`
### Process
1. Increment the `podspec` version in `Spokestack-iOS.podspec`
2. `pod lib lint --use-libraries --allow-warnings`, which should pass all checks
3. `git commit -a -m 'YOUR_COMMIT_MESSAGE' && git tag YOUR_PODSPEC_VERSION && git push --origin`
4. `pod trunk push --use-libraries --allow-warnings`
## License
[](https://opensource.org/licenses/Apache-2.0)
Copyright 2020 Spokestack, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.