@crewhaus/vad-engine 0.1.2 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/src/index.ts +8 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@crewhaus/vad-engine",
3
- "version": "0.1.2",
3
+ "version": "0.1.4",
4
4
  "type": "module",
5
5
  "description": "Voice activity detection — energy + ZCR heuristic over PCM 16-bit frames (Section 24 VOICE)",
6
6
  "main": "src/index.ts",
package/src/index.ts CHANGED
@@ -31,7 +31,14 @@ export type VadVerdict = "speech" | "silence" | "transitioning";
31
31
 
32
32
  export type DetectorOptions = {
33
33
  readonly aggressiveness?: Aggressiveness;
34
- /** Sample rate of incoming PCM (Hz). Default 24kHz. */
34
+ /**
35
+ * Sample rate of incoming PCM (Hz). RESERVED — currently has no effect on
36
+ * detection: the energy thresholds and zero-crossing band below are
37
+ * sample-rate-independent, and the detector does NOT resample. The option is
38
+ * accepted for forward compatibility (a planned band-pass filter stage). Pass
39
+ * it for clarity if you like, but do not infer any resampling behaviour from
40
+ * it.
41
+ */
35
42
  readonly sampleRate?: number;
36
43
  };
37
44