recorder-client 1.0.3 → 1.0.5

package/README.md

@@ -28,7 +28,7 @@ npm i recorder-client
 |     onpause     |        () => void         |     pause event      |
 |    onresume     |        () => void         |     resume event     |
 |     onstart     |        () => void         |     start event      |
-|     onstop      |    (wav: Blob) => void    |      stop event      |
+|     onstop      | (pcm: Int16Array) => void |      stop event      |
 |      pause      |        () => void         |     audio pause      |
 |     resume      |        () => void         |     audio resume     |
 |      start      |        () => void         |     audio start      |
@@ -36,12 +36,12 @@ npm i recorder-client
 
 ### Helper
 
-|  property  |                       type                       |              description              |
-| :--------: | :----------------------------------------------: | :-----------------------------------: |
-|  pcmMerge  | (pcms: Int16Array[]) => Int16Array<ArrayBuffer>  |      merge multiple pcm streams       |
-|  pcmToWav  |  (pcm: Int16Array, sampleRate: number) => Blob   |          convert PCM to WAV           |
-|  parseWav  |         (buffer: ArrayBuffer) => object          | obtain information about the wav file |
-| isSpeaking | (pcm: Int16Array, sampleRate: number) => boolean | check if there is any input of audio  |
+| property |                       type                       |              description              |
+| :------: | :----------------------------------------------: | :-----------------------------------: |
+| pcmMerge |        (pcms: Int16Array[]) => Int16Array        |      merge multiple pcm streams       |
+| pcmToWav |  (pcm: Int16Array, sampleRate: number) => Blob   |          convert PCM to WAV           |
+| parseWav |         (buffer: ArrayBuffer) => object          | obtain information about the wav file |
+| isSpeak  | (pcm: Int16Array, sampleRate: number) => boolean | check if there is any input of audio  |
 
 ### Example
 
@@ -58,7 +58,7 @@ const recorder = new Recorder({
 recorder.onstart = () => {};
 recorder.onpause = () => {};
 recorder.onresume = () => {};
-recorder.onstop = (blob) => {};
+recorder.onstop = (pcm) => {};
 recorder.ondataavailable = (pcm) => {};
 
 const onClick = () => {
@@ -86,7 +86,7 @@ recorder.ondataavailable = (pcm) => {
 };
 
 const onMerge = () => {
-  return Recorder.pcmMerge(pcms);
+  const data = Recorder.pcmMerge(pcms);
 };
 ```
 
@@ -100,7 +100,7 @@ const recorder = new Recorder({
   chunkSize: 1900,
 });
 
-recorder.ondataavailable = (pcm) => {
+recorder.onstop = (pcm) => {
   const blob = pcmToWav(pcm, 16000);
 };
 ```
@@ -124,7 +124,7 @@ const getWav = async (file: File) => {
 };
 ```
 
-> isSpeaking
+> isSpeak
 
 ```ts
 import { Recorder } from 'recorder-client';
@@ -135,6 +135,6 @@ const recorder = new Recorder({
 });
 
 recorder.ondataavailable = (pcm) => {
-  const flag = Recorder.isSpeaking(pcm, 16000);
+  const flag = Recorder.isSpeak(pcm, 16000);
 };
 ```

package/dist/index.cjs.js

@@ -150,7 +150,7 @@ class Recorder {
       const { e, data } = event.data;
       if (e === 'data') {
         if (ignoreMute) {
-          if (Recorder.isSpeaking(data, sampleRate)) {
+          if (Recorder.isSpeak(data, sampleRate)) {
             this._pcmData.push(data);
             this.ondataavailable?.(data);
           }
@@ -181,7 +181,7 @@ class Recorder {
     this._source = undefined;
     this._workletNode = undefined;
     this._audioContext = undefined;
-    this.onstop?.(Recorder.pcmToWav(Recorder.pcmMerge(this._pcmData), this._options.sampleRate));
+    this.onstop?.(Recorder.pcmMerge(this._pcmData));
     this._pcmData = [];
   }
   static pcmMerge(arrays) {
@@ -234,7 +234,7 @@ class Recorder {
     const wavBlob = new Blob([buffer], { type: 'audio/wav' });
     return wavBlob;
   }
-  static isSpeaking(int16Array, sampleRate) {
+  static isSpeak(int16Array, sampleRate) {
     const frameSize = Math.floor(0.02 * sampleRate); // 20ms 帧长度
     const threshold = 0.01; // 能量阈值（需根据实际调整）
     let speakingFrames = 0;

package/dist/index.d.ts

@@ -14,15 +14,15 @@ declare class Recorder {
     onpause?: () => void;
     onresume?: () => void;
     onstart?: () => void;
-    onstop?: (blob: Blob) => void;
+    onstop?: (data: Int16Array) => void;
     constructor(options: RecorderConstructor);
     start(): Promise<void>;
     pause(): void;
     resume(): void;
     stop(): void;
-    static pcmMerge(arrays: Int16Array[]): Int16Array<ArrayBuffer>;
+    static pcmMerge(arrays: Int16Array[]): Int16Array;
     static pcmToWav(data: Int16Array, sampleRate: number): Blob;
-    static isSpeaking(int16Array: Int16Array, sampleRate: number): boolean;
+    static isSpeak(int16Array: Int16Array, sampleRate: number): boolean;
     static parseWav(buffer: ArrayBuffer): {
         numChannels: number;
         sampleRate: number;

package/dist/index.esm.js

@@ -148,7 +148,7 @@ class Recorder {
       const { e, data } = event.data;
       if (e === 'data') {
         if (ignoreMute) {
-          if (Recorder.isSpeaking(data, sampleRate)) {
+          if (Recorder.isSpeak(data, sampleRate)) {
             this._pcmData.push(data);
             this.ondataavailable?.(data);
           }
@@ -179,7 +179,7 @@ class Recorder {
     this._source = undefined;
     this._workletNode = undefined;
     this._audioContext = undefined;
-    this.onstop?.(Recorder.pcmToWav(Recorder.pcmMerge(this._pcmData), this._options.sampleRate));
+    this.onstop?.(Recorder.pcmMerge(this._pcmData));
     this._pcmData = [];
   }
   static pcmMerge(arrays) {
@@ -232,7 +232,7 @@ class Recorder {
     const wavBlob = new Blob([buffer], { type: 'audio/wav' });
     return wavBlob;
   }
-  static isSpeaking(int16Array, sampleRate) {
+  static isSpeak(int16Array, sampleRate) {
     const frameSize = Math.floor(0.02 * sampleRate); // 20ms 帧长度
     const threshold = 0.01; // 能量阈值（需根据实际调整）
     let speakingFrames = 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "recorder-client",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "audio recording client",
   "type": "module",
   "main": "dist/index.cjs.js",