84 releases

0.26.0 Feb 9, 2024
0.25.6 Sep 9, 2023
0.25.5 Apr 6, 2023
0.25.2 Mar 28, 2023
0.1.0 Dec 30, 2018

#2 in #dispatcher

Download history 146/week @ 2023-12-22 169/week @ 2023-12-29 179/week @ 2024-01-05 167/week @ 2024-01-12 204/week @ 2024-01-19 192/week @ 2024-01-26 153/week @ 2024-02-02 167/week @ 2024-02-09 288/week @ 2024-02-16 267/week @ 2024-02-23 339/week @ 2024-03-01 355/week @ 2024-03-08 318/week @ 2024-03-15 323/week @ 2024-03-22 268/week @ 2024-03-29 194/week @ 2024-04-05

1,150 downloads per month
Used in 11 crates

MIT license

89KB
2.5K SLoC

Contains (JAR file, 55KB) gradle-wrapper.jar

TTS-RS

This library provides a high-level Text-To-Speech (TTS) interface supporting various backends. Currently supported backends are:

  • Windows
    • Screen readers/SAPI via Tolk (requires tolk Cargo feature)
    • WinRT
  • Linux via Speech Dispatcher
  • MacOS/iOS
    • AppKit on MacOS 10.13 and below
    • AVFoundation on MacOS 10.14 and above, and iOS
  • Android
  • WebAssembly

Android Setup

On most platforms, this library is plug-and-play. Because of JNI's complexity, Android setup is a bit more involved. In general, look to the Android example for guidance. Here are some rough steps to get going:

  • Set up Cargo.toml as the example does. Be sure to depend on ndk-glue.
  • Place Bridge.java appropriately in your app. This is needed to support various Android TTS callbacks.
  • Create a main activity similar to MainActivity.kt. In particular, you need to derive android.app.NativeActivity, and you need a System.loadLibrary(...) call appropriate for your app. System.loadLibrary(...) is needed to trigger JNI_OnLoad.
    • Even though you've loaded the library in your main activity, add a metadata tag to your activity in AndroidManifest.xml referencing it. Yes, this is redundant but necessary.
  • Set if your various build.gradle scripts to reference the plugins, dependencies, etc. from the example. In particular, you'll want to set up cargo-ndk-android-gradle and either depend on androidx.annotation or otherwise configure your app to keep the class rs.tts.Bridge.

And I think that should about do it. Good luck!

Dependencies

~0.4–48MB
~685K SLoC