recorder-client 1.0.3 → 1.0.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/README.md +10 -10
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -28,7 +28,7 @@ npm i recorder-client
28
28
  | onpause | () => void | pause event |
29
29
  | onresume | () => void | resume event |
30
30
  | onstart | () => void | start event |
31
- | onstop | (wav: Blob) => void | stop event |
31
+ | onstop | (pcm: Int16Array) => void | stop event |
32
32
  | pause | () => void | audio pause |
33
33
  | resume | () => void | audio resume |
34
34
  | start | () => void | audio start |
@@ -36,12 +36,12 @@ npm i recorder-client
36
36
 
37
37
  ### Helper
38
38
 
39
- | property | type | description |
40
- | :--------: | :----------------------------------------------: | :-----------------------------------: |
41
- | pcmMerge | (pcms: Int16Array[]) => Int16Array<ArrayBuffer> | merge multiple pcm streams |
42
- | pcmToWav | (pcm: Int16Array, sampleRate: number) => Blob | convert PCM to WAV |
43
- | parseWav | (buffer: ArrayBuffer) => object | obtain information about the wav file |
44
- | isSpeaking | (pcm: Int16Array, sampleRate: number) => boolean | check if there is any input of audio |
39
+ | property | type | description |
40
+ | :------: | :----------------------------------------------: | :-----------------------------------: |
41
+ | pcmMerge | (pcms: Int16Array[]) => Int16Array | merge multiple pcm streams |
42
+ | pcmToWav | (pcm: Int16Array, sampleRate: number) => Blob | convert PCM to WAV |
43
+ | parseWav | (buffer: ArrayBuffer) => object | obtain information about the wav file |
44
+ | isSpeak | (pcm: Int16Array, sampleRate: number) => boolean | check if there is any input of audio |
45
45
 
46
46
  ### Example
47
47
 
@@ -86,7 +86,7 @@ recorder.ondataavailable = (pcm) => {
86
86
  };
87
87
 
88
88
  const onMerge = () => {
89
- return Recorder.pcmMerge(pcms);
89
+ const data = Recorder.pcmMerge(pcms);
90
90
  };
91
91
  ```
92
92
 
@@ -124,7 +124,7 @@ const getWav = async (file: File) => {
124
124
  };
125
125
  ```
126
126
 
127
- > isSpeaking
127
+ > isSpeak
128
128
 
129
129
  ```ts
130
130
  import { Recorder } from 'recorder-client';
@@ -135,6 +135,6 @@ const recorder = new Recorder({
135
135
  });
136
136
 
137
137
  recorder.ondataavailable = (pcm) => {
138
- const flag = Recorder.isSpeaking(pcm, 16000);
138
+ const flag = Recorder.isSpeak(pcm, 16000);
139
139
  };
140
140
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "recorder-client",
3
- "version": "1.0.3",
3
+ "version": "1.0.4",
4
4
  "description": "audio recording client",
5
5
  "type": "module",
6
6
  "main": "dist/index.cjs.js",