Simple and elegant way of performing Text To Speech across Xamarin.iOS, Xamarin.Android, Windows, and Xamarin.Forms projects.
Preview: http://screencast.com/t/voW1P48Ka
- Available on NuGet: https://www.nuget.org/packages/Xam.Plugins.TextToSpeech/
- Install into your PCL project and Client projects.
Build status:
Platform Support
| Platform | Supported | Version |
|---|---|---|
| Xamarin.iOS | Yes | iOS 7+ |
| Xamarin.iOS Unified | Yes | iOS 7+ |
| Xamarin.Android | Yes | API 10+ |
| Windows Phone Silverlight | Yes | 8.0+ |
| Windows Phone RT | Yes | 8.1+ |
| Windows Store RT | Yes | 8.1+ |
| Windows 10 UWP | Yes | 10+ |
| Xamarin.Mac | No |
- Speak back text
- Pitch
- Volume
- Speak Rate
- Locale/Language of Speech
- Decide to queue speech block
- Gather all available languages to speak in
Simple Text
CrossTextToSpeech.Current.Speak("Text to speak");Advanced speech API
/// <summary>
/// Speack back text
/// </summary>
/// <param name="text">Text to speak</param>
/// <param name="queue">If you want to chain together speak command or cancel current</param>
/// <param name="crossLocale">Locale of voice</param>
/// <param name="pitch">Pitch of voice (All 0.0 - 2.0f)</param>
/// <param name="speakRate">Speak Rate of voice (All) (0.0 - 2.0f)</param>
/// <param name="volume">Volume of voice (iOS/WP) (0.0-1.0)</param>
public async void Speak(string text, bool queue = false, CrossLocale crossLocale = null, float? pitch = null, float? speakRate = null, float? volume = null)CrossLocale I developed the CrossLocale struct mostly to support Android, but is nice because I added a Display Name.
You can query a list of current support CrossLocales on the device:
/// <summary>
/// Get all installed and valide lanaguages
/// </summary>
/// <returns>List of CrossLocales</returns>
public IEnumerable<CrossLocale> GetInstalledLanguages()Each local has the Language and Display Name. The Country code is only used in Android. If you pass in null to Speak it will use the default.
- iOS: AVSpeechSynthesizer
- Android: Android.Speech.Tts.TextToSpeech
- Windows Phone: SpeechSynthesizer + Ssml support for advanced playback
Windows Phone You must add ID_CAP_SPEECH_RECOGNITION permission
Contributions are welcome! If you find a bug please report it and if you want a feature please report it.
If you want to contribute code please file an issue and create a branch off of the current dev branch and file a pull request.
Under MIT, see LICENSE file.