External/buzz
1
0
Fork 0
mirror of https://github.com/block/buzz.git synced 2026-08-18 06:50:31 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs(voice): define mobile linker inputs

Browse Source 
Signed-off-by: John Tennant <jtennant@squareup.com>
This commit is contained in:
John Tennant
2026-07-31 10:22:03 -04:00
parent a9ccbd24ad
commit 2881eba34f
1 changed files with 20 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/sherpa-onnx-sys/README.md
+20 -1
View File
@@ -5,9 +5,28 @@
</div>
Buzz carries the crates.io 1.13.4 FFI sources and locally patches the build
script to link caller-supplied official iOS and Android libraries through
script to link caller-prepared official iOS and Android libraries through
`SHERPA_ONNX_LIB_DIR`. Desktop archive selection remains unchanged.
The application that produces the final native library owns archive download,
checksum verification, slice selection, and packaging. It must select the
`static` feature for iOS and the `shared` feature for Android. Because Cargo
does not propagate `[patch.crates-io]` from dependencies, that application's
workspace root must also patch `sherpa-onnx-sys` to this package.
`SHERPA_ONNX_LIB_DIR` points to the selected target's normalized link
directory, not the root of the downloaded archive:
- iOS contains `libsherpa-onnx.a` and `libonnxruntime.a`. A consumer can
extract the matching binaries from the official sherpa and ONNX Runtime
XCFramework slices.
- Android contains `libsherpa-onnx-c-api.so` and `libonnxruntime.so` from
the matching official ABI directory.
The consumer remains responsible for embedding those libraries and the
platform C++ runtime in its Xcode or Gradle product. Buzz Desktop's independent
Tauri workspace is a desktop consumer and does not select these mobile modes.
### Supported functions
|Speech recognition| [Speech synthesis][tts-url] | [Source separation][ss-url] |