diff --git a/docs/user-guide/algorithm.md b/docs/user-guide/algorithm.md index 07dac54..d90bef7 100644 --- a/docs/user-guide/algorithm.md +++ b/docs/user-guide/algorithm.md @@ -16,6 +16,6 @@ All of the main APIs accept certain common configuration parameters that modify * `positiveSpeechThreshold: number` - determines the threshold over which a probability is considered to indicate the presence of speech. * `negativeSpeechThreshold: number` - determines the threshold under which a probability is considered to indicate the absence of speech. * `redemptionFrames: number` - number of speech-negative frames to wait before ending a speech segment. -* `frameSamples: number` - the size of a frame in samples - 1536 by default and probably should not be changed. +* `frameSamples: number` - the size of a frame in samples. For the older (default) Silero model, this should probably be 1536. For the new, Silero version 5 model, it should be 512. * `preSpeechPadFrames: number` - number of audio frames to prepend to a speech segment. * `minSpeechFrames: number` - minimum number of speech-positive frames for a speech segment. diff --git a/docs/user-guide/api.md b/docs/user-guide/api.md index 0641538..cf2b802 100644 --- a/docs/user-guide/api.md +++ b/docs/user-guide/api.md @@ -9,7 +9,6 @@ The `MicVAD` API is for recording user audio in the browser and running callback | Package | Supported | | ---------------------- | ---------------------------------------------- | | `@ricky0123/vad-web` | Yes | -| `@ricky0123/vad-node` | No | | `@ricky0123/vad-react` | No, use the [useMicVAD](api.md#usemicvad) hook | ### Example @@ -39,6 +38,9 @@ New instances of `MicVAD` are created by calling the async static method `MicVAD | `frameSamples` | `number` | [see algorithm configuration](algorithm.md#configuration) | | `preSpeechPadFrames` | `number` | [see algorithm configuration](algorithm.md#configuration) | | `minSpeechFrames` | `number` | [see algorithm configuration](algorithm.md#configuration) | +| `model` | `"v5" or "legacy"` (default `"legacy"`) | whether to use the new Silero model or not | +| `baseAssetPath` | `string`) | URL or path relative to webroot where `vad.worklet.bundle.min.js`, `silero_vad_legacy.onnx`, and `silero_vad_v5.onnx` will be loaded from | +| `onnxWASMBasePath` | `string`) | URL or path relative to webroot where wasm files for onnxruntime-web will be loaded from | ### Attributes | Attributes | Type | Description | @@ -55,7 +57,6 @@ The `NonRealTimeVAD` API is for identifying segments of user speech if you alrea | Package | Supported | | ---------------------- | --------- | | `@ricky0123/vad-web` | Yes | -| `@ricky0123/vad-node` | Yes | | `@ricky0123/vad-react` | No | ### Example @@ -98,7 +99,6 @@ A React hook wrapper for [MicVAD](api.md#micvad). Use this if you want to run th | Package | Supported | | ---------------------- | ------------------------------- | | `@ricky0123/vad-web` | No, use [MicVAD](api.md#micvad) | -| `@ricky0123/vad-node` | No | | `@ricky0123/vad-react` | Yes | ### Example