amr的三方API

2021-12-29 01:25:15

AMR 录音机

纯前端解码、播放、录音、编码 AMR 音频，无须服务器支持，基于 amr.js 和 RecorderJs。

注意：由于使用了 amr.js 做编码和解码，因此 js 文件（压缩后，未 gzip）接近 500 KB，使用前请考虑。

2019-10-05 更新 (v1.1.0)：增加浏览器支持检测功能，增加暂停播放、设置播放进度功能。

特性

方便的 API 实现解码、播放、录音、编码 AMR 文件。
支持 url 和 blob （即<input type="file">）方式获取 AMR。
支持将浏览器 <audio> 所支持的音频格式（例如 MP3 或 OGG 音频）转换成 AMR 音频。
编码后的 AMR 文件可下载，无须服务器。

Demo

demo.html

浏览器兼容性

最新的浏览器兼容性请参阅 Can I Use 。

仅播放：https://caniuse.com/#feat=audio-api
播放+录音：https://caniuse.com/#feat=stream

安装

方法一：引入 js 文件

<script type="text/javascript" src="./BenzAMRRecorder.min.js"></script>

方法二：使用 npm

npm install benz-amr-recorder

var BenzAMRRecorder = require(‘benz-amr-recorder‘);

用法

注意：建议把 initWithXXX() 或 play() 方法绑定到一个用户事件中（例如 click、touchstart）。因为几乎所有移动设备（以及桌面版 Chrome 70+）都禁止页面自动播放音频。参考：

播放 AMR：

var amr = new BenzAMRRecorder();
amr.initWithUrl(‘path/to/voice.amr‘).then(function() {
  amr.play();
});
amr.onEnded(function() {
  alert(‘播放完毕‘);
})

播放本地文件：

<input type="file" id="amr-file" accept=".amr">

var amr = new BenzAMRRecorder();
var amrFileObj = document.getElementById(‘amr-file‘);
amrFileObj.onchange = function() {
  amr.initWithBlob(this.files[0]).then(function() {
    amr.play();
  });
}

录制 AMR：

var amrRec = new BenzAMRRecorder();
amrRec.initWithRecord().then(function() {
  amrRec.startRecord();
});

下载 AMR：

window.location.href = window.URL.createObjectURL(amr.getBlob());

把 MP3 转换成 AMR （需要浏览器原生支持 MP3）：

var amrFromMp3 = new BenzAMRRecorder();
amrFromMp3.initWithUrl(‘path/to/file.mp3‘).then(function() {
  // 下载 amr 文件
  window.location.href = window.URL.createObjectURL(amrFromMp3.getBlob());
})

API

初始化对象

/**
 * 是否已经初始化
 * @return {boolean}
 */
amr.isInit();

/**
 * 使用浮点数据初始化
 * @param {Float32Array} array
 * @return {Promise}
 */
amr.initWithArrayBuffer(array);

/**
 * 使用 Blob 对象初始化（ <input type="file">）
 * @param {Blob} blob
 * @return {Promise}
 */
amr.initWithBlob(blob);

/**
 * 使用 url 初始化
 * @param {string} url
 * @return {Promise}
 */
amr.initWithUrl(url);

/**
 * 初始化录音
 * @return {Promise}
 */
amr.initWithRecord();

事件

注意：事件不会叠加，也就是说，新注册的事件将覆盖掉旧的事件。

/**
 * 播放
 * @param {Function} fn
 */
amr.onPlay(function() {
  console.log(‘开始播放‘);
});

/**
 * 停止（包括播放结束）
 * @param {Function} fn
 */
amr.onStop(function() {
  console.log(‘停止播放‘);
});

/**
 * 暂停
 * @param {Function} fn
 */
amr.onPause(function() {
  console.log(‘暂停‘);
});

/**
 * （暂停状态中）继续播放
 * @param {Function} fn
 */
amr.onResume(function() {
  console.log(‘继续播放‘);
});

/**
 * 播放结束
 * @param {Function} fn
 */
amr.onEnded(function() {
  console.log(‘播放结束‘);
});

/**
 * 播放到结尾自动结束
 * @param {Function} fn
 */
amr.onAutoEnded(function() {
  console.log(‘播放自动结束‘);
});

/**
 * 开始录音
 * @param {Function} fn
 */
amr.onStartRecord(function() {
  console.log(‘开始录音‘);
});

/**
 * 结束录音
 * @param {Function} fn
 */
amr.onFinishRecord(function() {
  console.log(‘结束录音‘);
});

播放控制

/**
 * 播放（无视暂停状态）
 * @param {number?} startTime 可指定播放开始位置（秒，浮点数，可选）
 */
amr.play();

/**
 * 停止
 */
amr.stop();

/**
 * 暂停
 * @since 1.1.0
 */
amr.pause();

/**
 * 从暂停状态中继续播放
 * @since 1.1.0
 */
amr.resume();

/**
 * 整合 play() 和 resume()，若在暂停状态则继续，否则从头播放
 * @since 1.1.0
 */
amr.playOrResume();

/**
 * 整合 resume() 和 pause()，切换暂停状态
 * @since 1.1.0
 */
amr.pauseOrResume();

/**
 * 整合 play() 和 resume() 和 pause()
 * @since 1.1.0
 */
amr.playOrPauseOrResume();

/**
 * 跳转到音频指定位置，不改变播放状态（若停止状态则等同于 `play(time)`） 
 * @since 1.1.0
 * @param {Number} time 指定位置（秒，浮点数）
 */
amr.setPosition(12.34);

/**
 * 获取当前播放位置（秒） 
 * @since 1.1.0
 * @return {Number} 位置，秒，浮点数
 */
amr.getCurrentPosition();

/**
 * 是否正在播放
 * @return {boolean}
 */
amr.isPlaying();

/**
 * 是否暂停中
 * @since 1.1.0
 * @return {boolean}
 */
amr.isPaused();

录音控制

/**
 * 开始录音
 */
amr.startRecord();

/**
 * 结束录音，并把录制的音频转换成 AMR
 * @return {Promise}
 */
amr.finishRecord();

/**
 * 放弃录音
 */
amr.cancelRecord();

/**
 * 是否正在录音
 * @return {boolean}
 */
amr.isRecording();

其他

/**
 * 获取音频的时间长度（单位：秒）
 * @return {Number}
 */
amr.getDuration();

/**
 * 获取 AMR 文件的 Blob 对象（用于下载文件）
 * @return {Blob}
 */
amr.getBlob();

/**
 * 判断浏览器是否支持播放
 * 注意这是静态(static)方法
 * @since 1.1.0
 * @return {boolean}
 */
BenzAMRRecorder.isPlaySupported();
// 不是 amr.isPlaySupported();

/**
 * 判断浏览器是否支持录音
 * 注意这是静态(static)方法
 * @since 1.1.0
 * @return {boolean}
 */
BenzAMRRecorder.isRecordSupported();
// 不是 amr.isRecordSupported();