# recorder
**Repository Path**: gisxiaowei/recorder
## Basic Information
- **Project Name**: recorder
- **Description**: 原生js实现的web端录音
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://2fps.github.io/demo/js%E5%BD%95%E9%9F%B3/js%E5%BD%95%E9%9F%B3.html
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 19
- **Created**: 2022-07-12
- **Last Updated**: 2022-07-12
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# recorder
js audio recorder plugin.
  
> 主要用于Web端录制短音频。
+ 支持录音，暂停，恢复，和录音播放。
+ 支持音频数据的压缩，支持单双通道录音。
+ 支持录音时长显示。
+ 支持导出录音文件，格式为pcm或wav。
+ 支持录音波形显示，可自己定制。
## 使用
### 在线演示地址
[recorder](https://2fps.github.io/demo/js%E5%BD%95%E9%9F%B3/js%E5%BD%95%E9%9F%B3.html)
### demo使用
```
npm ci (推荐) 或 npm install
npm run dev
```
### 调试移动端
```
npm run https
```
### 编译
```
npm run build
```
### 使用方法
#### 引入方式
+ npm方式：
安装：
```
npm i js-audio-recorder
```
调用：
``` js
import Recorder from 'js-audio-recorder';
let recorder = new Recorder();
```
+ script标签方式
``` js
let recorder = new Recorder();
```
## API
### 初始化实例
可以配置输出数据参数，
``` js
let recorder = new Recorder({
sampleBits: 16, // 采样位数，支持 8 或 16，默认是16
sampleRate: 16000, // 采样率，支持 11025、16000、22050、24000、44100、48000，根据浏览器默认值，我的chrome是48000
numChannels: 1, // 声道，支持 1 或 2， 默认是1
});
```
+ 返回: \
### 开始录音
``` js
recorder.start().then(function() {
// 开始录音
});
```
+ 返回: Promise<{}>
### 录音暂停
``` js
// 暂停录音
recorder.pause();
```
+ 返回: void
### 继续录音
``` js
// 继续录音
recorder.resume()
```
+ 返回: void
仅支持暂停后，恢复录音。
### 结束录音
``` js
// 结束录音
recorder.stop();
```
+ 返回: void
### 录音播放
``` js
// 录音播放
recorder.play();
```
+ 返回: void
支持不结束直接调用录音播放。
### 销毁实例
``` js
// 销毁录音实例，置为null释放资源，fn为回调函数，
recorder.destroy().then(function() {
recorder = null;
});
```
+ 返回: Promise<{}>
### 直接获取录音数据
#### 获取 PCM 数据
``` js
// 获取 PCM 数据(Blob)
recorder.getPCMBlob();
```
+ 返回: \
#### 获取 WAV 数据
``` js
// 获取 WAV 数据(Blob)
recorder.getWAVBlob();
```
+ 返回: \
### 下载录音文件
#### 下载 PCM 格式
``` js
// 下载pcm文件
recorder.downloadPCM(fileName ?);
```
+ fileName \ 重命名文件
+ 返回: \
#### 下载 WAV 格式
``` js
// 下载wav文件
recorder.downloadWAV(fileName ?);
```
+ fileName \ 重命名文件
+ 返回: \
### 获取录音时长
``` js
// 回调持续输出时长(当收集的栈满时触发)
recorder.onprocess = function(duration) {
console.log(duration);
}
// 手动获取录音时长
console.log(recorder.duration);
```
### 录音波形显示
``` js
let dataArray = recorder.getRecordAnalyseData();
```
返回的是一个1024长的，0-255大小的Uint8Array类型。用户可以根据这些数据自定义录音波形。
### 播放外部音频文件
``` js
Recorder.playAudio(/* 放入blob数据 */);
```
支持的音乐格式由浏览器的audio支持的类型决定。
## 任务列表
- [ ] 拆分recorder到各个功能模块。
- [x] 增加test代码。
- [ ] promise，支持async, await。
- [ ] 功能完善。
- [x] 兼容性测试。
## 注意
1. 使用127.0.0.1或localhost尝试，因为getUserMedia在高版本的chrome下需要使用https。
## 兼容性
> 以下为测试结果，低于以下版本并不表示不支持，可能是未测试到，增加或标注请查看：[issues6](https://github.com/2fps/recorder/issues/6)
### window pc端
|  |  |  |  |  |  |
| ---- | ---- | ---- | ---- | ---- | ---- |
| 38+ | 30+ | 42+ | 11+ | 21+ | 不支持 |
### 移动端
|  |  |  |  |  |  |  | ![搜狗]() | ![华为]() | ![小米]() |
| ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- | ---- |
| 42+ | 40+ | 11+ | 不支持 | 不支持 | 9.2+ | 不支持 | 不支持 | 不支持 | 不支持 |
> 需要打开浏览器录音权限，在设置-权限中可以配置。
## 其他资源
+ [webAudio播放本地音乐](https://github.com/2fps/demo/tree/master/view/2019/04/webAudio%E6%92%AD%E6%94%BE%E6%9C%AC%E5%9C%B0%E9%9F%B3%E4%B9%90)
+ [webAudio制造噪音并播放](https://github.com/2fps/demo/tree/master/view/2019/04/webAudio%E5%88%B6%E9%80%A0%E5%99%AA%E9%9F%B3%E5%B9%B6%E6%92%AD%E6%94%BE)
+ [web Audio实现pcm音频数据收集](https://github.com/2fps/demo/tree/master/view/2019/04/webAudio%E5%AE%9E%E7%8E%B0pcm%E9%9F%B3%E9%A2%91%E6%95%B0%E6%8D%AE%E6%94%B6%E9%9B%86)
+ [js实现pcm数据编码](https://github.com/2fps/demo/tree/master/view/2019/04/js%E5%AE%9E%E7%8E%B0pcm%E6%95%B0%E6%8D%AE%E7%BC%96%E7%A0%81)
+ [基于阿里云实现简单的语音识别功能(node)](https://github.com/2fps/demo/tree/master/view/2019/01/%E5%9F%BA%E4%BA%8E%E9%98%BF%E9%87%8C%E4%BA%91%E5%AE%9E%E7%8E%B0%E7%AE%80%E5%8D%95%E7%9A%84%E8%AF%AD%E9%9F%B3%E8%AF%86%E5%88%AB%E5%8A%9F%E8%83%BD(node))