Repository navigation
docs: add earshot section to the README - #59
Merged
Merged
Conversation
The earshot backend landed in the feature and backend tables but never got the usage section every other backend has, so the README went from FireRedVAD straight to the trait docs with no example for it. - Adds an Earshot section in the same shape as the others, noting the infallible construction, the fixed 256-sample frame, and the ~8 KiB of per-stream state. - Documents `FrameAdapter::process_each`, which was added alongside the backend and is the core the other methods are built on, along with which methods allocate. - Credits the earshot crate in the acknowledgements. Both code examples were compiled and run; the README is not doctested, so this was checked separately. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012PF9YKsA6GfchGTPDAWYzL
Merged
wavekat-eason
added a commit
that referenced
this pull request
Aug 30, 2026
## 🤖 New release * `wavekat-vad`: 0.1.16 -> 0.1.17 (✓ API compatible changes) <details><summary><i><b>Changelog</b></i></summary><p> <blockquote> ## [0.1.17](v0.1.16...v0.1.17) - 2026-08-30 ### Added - add pure-Rust earshot VAD backend ([#55](#55)) ### Other - add earshot section to the README ([#59](#59)) - add conformance suite and semver check ([#60](#60)) - cover earshot backend and frame adapter ([#57](#57)) </blockquote> </p></details> --- This PR was generated with [release-plz](https://github.com/release-plz/release-plz/). --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Eason WaveKat <eason@wavekat.com> Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #55 / #57 / #58.
What was missing
#55 added Earshot to the backends table, the dependency snippet, and the feature-flag table — but not to the part of the README where each backend is actually explained. WebRTC, Silero, TEN-VAD and FireRedVAD each have a
###section with a description and a runnable example; Earshot went straight from the FireRedVAD example to the trait docs. Someone who enabled the feature had nowhere to look for how to construct it.The new section follows the same shape as the other four and calls out the three things that differ from them:
.unwrap()onnew()FrameAdapterfor 20 ms / 320-sample transportsreset()between streamsFrameAdapter::process_eachThe adapter rework in #55 added
process_eachand made the allocation behaviour of each method meaningful, but the README still listed only the three older methods. Added it to the example, with a note on which methods allocate and whatbuffered_samples()reports — this is the method to reach for on a real-time path, and it was invisible.Acknowledgements
Added the earshot crate (MIT OR Apache-2.0, by pyke — the same authors as
ort, already credited).Notes
update-benchmarksjob and chore: release v0.1.17 #56 already has the regenerated five-row version, so hand-editing it here would only conflict.🤖 Generated with Claude Code
https://claude.ai/code/session_012PF9YKsA6GfchGTPDAWYzL