nolan/tts-rs
1
0
Fork 0
mirror of https://github.com/ndarilek/tts-rs.git synced 2024-11-21 06:59:38 +00:00
Code Issues Projects Releases Wiki Activity
453 Commits 1 Branch 88 Tags 1.1 MiB
Rust 100%
master
Go to file
Nolan Darilek b31efe752d Bump version and windows dependency.
2024-07-06 18:33:51 -05:00
.github/workflows Attempt to simplify CI. 2024-02-09 11:29:00 -06:00
examples Add support for inline pronounciation 2022-12-26 20:07:58 +00:00
src Switch Arc to Rc to appease Clippy. 2024-02-09 11:34:01 -06:00
.gitignore Ignore DLL files. 2021-03-11 13:41:26 -06:00
build.rs Upgrade windows-rs to 0.23. 2021-11-01 10:36:15 -05:00
Cargo.toml Bump version and windows dependency. 2024-07-06 18:33:51 -05:00
Makefile.toml Add command to build the web example. 2021-04-03 11:49:44 -05:00
README.md Bump version, and use automatically-provided feature provided by optional tolk dependency. 2021-01-21 10:49:11 -06:00

README.md

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!