Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mapbox/mapbox-speech-swift
Natural-sounding text-to-speech in Swift or Objective-C on iOS, macOS, tvOS, and watchOS
https://github.com/mapbox/mapbox-speech-swift
amazon-polly ios macos speech-synthesis speech-synthesizer swift text-to-speech tts tvos watchos
Last synced: about 2 months ago
JSON representation
Natural-sounding text-to-speech in Swift or Objective-C on iOS, macOS, tvOS, and watchOS
- Host: GitHub
- URL: https://github.com/mapbox/mapbox-speech-swift
- Owner: mapbox
- License: isc
- Created: 2017-09-15T17:47:40.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2022-12-08T12:22:53.000Z (about 2 years ago)
- Last Synced: 2024-10-02T22:30:51.694Z (3 months ago)
- Topics: amazon-polly, ios, macos, speech-synthesis, speech-synthesizer, swift, text-to-speech, tts, tvos, watchos
- Language: Swift
- Homepage:
- Size: 459 KB
- Stars: 42
- Watchers: 95
- Forks: 17
- Open Issues: 7
-
Metadata Files:
- Readme: readme.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Mapbox Speech
[](https://circleci.com/gh/mapbox/mapbox-speech-swift)
[](https://codecov.io/gh/mapbox/mapbox-speech-swift)
[](https://github.com/Carthage/Carthage)
[](https://cocoapods.org/pods/MapboxSpeech/)
[](https://swift.org/package-manager/)
Mapbox Speech connects your iOS, macOS, tvOS, or watchOS application to the Mapbox Voice API. Take turn instructions from the [Mapbox Directions API](https://www.mapbox.com/api-documentation/#directions) and read them aloud naturally in multiple languages. This library is specifically designed to work with [mapbox-directions-swift](https://github.com/mapbox/mapbox-directions-swift/) as part of the [Mapbox Navigation SDK for iOS](https://github.com/mapbox/mapbox-navigation-ios/).
This library is compatible with applications written in Swift. Version 2.0 was the last version of this library to support applications written in Objective-C or AppleScript.
## Getting started
Specify the following dependency in your [Carthage](https://github.com/Carthage/Carthage) Cartfile:
```cartfile
github "mapbox/mapbox-speech-swift" ~> 2.1
```
Or in your [CocoaPods](http://cocoapods.org/) Podfile:
```podspec
pod 'MapboxSpeech', '~> 2.1'
```
Or in your [Swift Package Manager](https://swift.org/package-manager/) Package.swift:
```swift
.package(url: "https://github.com/mapbox/mapbox-speech-swift.git", from: "2.1.1")
```
Then `import MapboxSpeech` or `@import MapboxSpeech;`.
## Usage
You’ll need a [Mapbox access token](https://www.mapbox.com/developers/api/#access-tokens) in order to use the API. If you’re already using the [Mapbox Maps SDK for iOS](https://www.mapbox.com/ios-sdk/) or [macOS SDK](https://mapbox.github.io/mapbox-gl-native/macos/), Mapbox Speech automatically recognizes your access token, as long as you’ve placed it in the `MBXAccessToken` key of your application’s Info.plist file.
### Basics
The main speech synthesis class is `SpeechSynthesizer`. Create a speech synthesizer object using your access token:
```swift
import MapboxSpeech
let speechSynthesizer = SpeechSynthesizer(accessToken: "<#your access token#>")
```
Alternatively, you can place your access token in the `MBXAccessToken` key of your application’s Info.plist file, then use the shared speech synthesizer object:
```swift
// main.swift
let speechSynthesizer = SpeechSynthesizer.shared
```
With the directions object in hand, construct a SpeechOptions or MBSpeechOptions object and pass it into the `SpeechSynthesizer.audioData(with:completionHandler:)` method.
```swift
// main.swift
let options = SpeechOptions(text: "hello, my name is Bobby")
speechSynthesizer.audioData(with: options) { (data: Data?, error: NSError?) in
guard error == nil else {
print("Error calculating directions: \(error!)")
return
}
// Do something with the audio!
}
```