@neosjs/h5-recorder
基于 HTML5 的 JS 录音库,支持 mp3、wav 两种输出格式,覆盖 PC 与 Android、iOS 部分浏览器。提供完整的录音生命周期控制(开始、暂停、恢复、停止、关闭)、波形图渲染、播放、获取录音文件与浏览器支持检测。
安装
sh
pnpm add @neosjs/h5-recordersh
npm i @neosjs/h5-recordersh
yarn add @neosjs/h5-recorder快速上手
先通过 init 初始化录音机并监听各状态回调,再调用对应接口控制录音:
js
import Recorder from '@neosjs/h5-recorder'
Recorder.init(
{
type: 'wav', // 音频类型
sampleRate: 16000, // 码率
bitRate: 16, // 采样数位
waveForm: {
type: 'wave', // 波形类型
dom: '.waveContent' // 波形容器 css 选择器
}
},
(cb) => {
switch (cb.action) {
case 'initState': // 初始化状态
case 'connectRecord': // 连接录音
case 'disconnectRecord': // 断开录音连接
case 'startRecord': // 开始录音
case 'stopRecord': // 停止录音
case 'closeRecord': // 关闭录音、释放资源
case 'pauseRecord': // 暂停录音
case 'resumeRecord': // 恢复录音
case 'playRecord': // 播放录音
case 'isSupport': // 浏览器是否支持 H5 录音功能
console.log(cb.data)
break
}
}
)
// 开始录音(异步接口)
await Recorder.startRecord()
// 停止录音(异步接口)
await Recorder.stopRecord()
// 获取录音文件
const blob = await Recorder.getRecordBlob()API
接口列表
| 接口 | 说明 |
|---|---|
Recorder.init(configs, callback) | 初始化录音机 |
Recorder.startRecord() | 开始录音 |
Recorder.stopRecord(success?, fail?) | 停止录音 |
Recorder.closeRecord() | 关闭录音、释放资源(v1.0.4 及以上版本) |
Recorder.pauseRecord() | 暂停录音(v1.0.1 及以上版本) |
Recorder.resumeRecord() | 恢复录音(v1.0.1 及以上版本) |
Recorder.getRecordBlob() | 获取录音文件 |
Recorder.playRecord(audioDomId) | 播放录音 |
Recorder.getRecordSrc(blobFile?) | 获取本地 src 地址 |
Recorder.isSupport() | 获取浏览器是否支持录音(同步接口,返回 true / false) |
DANGER
不再需要录音的时候,必须调用 closeRecord() 关闭录音、释放资源。
除 isSupport 为同步接口外,其余均为异步接口。
初始化参数
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
configs.bitRate | 采样数位 | number | 8 / 16 | 16 |
configs.sampleRate | 采样率 | number | - | 16000 |
configs.type | 音频类型 | string | mp3 / wav | wav |
configs.waveForm | 波形图配置(v1.0.2 调整此参数) | object | - | - |
configs.waveForm.type | 波形图类型 | string | frequency / wave | wave |
configs.waveForm.dom | 波形容器 css 选择器 | string | - | .waveContent |
方法参数
stopRecord(success, fail)
| 参数 | 说明 | 类型 | 是否必填 |
|---|---|---|---|
success | 成功的回调 | function | 否 |
fail | 失败的回调 | function | 否 |
playRecord(audioDomId)
| 参数 | 说明 | 类型 | 是否必填 |
|---|---|---|---|
audioDomId | audio 标签的 id | string | 是 |
getRecordSrc(blobFile)
| 参数 | 说明 | 是否必填 |
|---|---|---|
blobFile | blob 文件 | 否 |
WARNING
createWaves(config, canvasDomId) 与 uploadRecord(url, method, callback) 两个接口已在 v1.0.1 废弃:波形图能力合并到 init 的 waveForm 参数中,上传请自行获取 blob 后处理。