FNRecordMp3
open start stop getMp3Path pause continue getVolume addEventListener setMp3PathListener removeMp3PathListener
概述
FNRecordMp3 提供了mp3格式的音频文件的录制功能,能够快速的为开发者提供一个完整的录音功能
open
初始化录音
open({params}, callback(ret))
params
path:
- 类型:字符串类型
- 描述:生成的mp3路径;支持fs:// (仅支持iOS)
- 默认:fs://record
fileDir:
- 类型:字符串类型
- 描述:存放mp3文件的路径,文件夹路径;支持fs,原生路径,例:’fs://record/‘ 注意结尾必须要有’/‘ (仅支持安卓)
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: //布尔类型 ;初始化是否成功
}
示例代码
var FNRecordMp3 = api.require('FNRecordMp3');
FNRecordMp3.open({
path:'fs://'
}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
iOS 系统,Android 系统
可提供的 1.0.0 及更高版本
start
开始录音
start({params}, callback(ret))
params
afterSecond:
- 类型:数字类型
- 描述:延时多少秒开始录音
- 默认值:0
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: //布尔类型 ;开始录音是否成功
}
示例代码
var FNRecordMp3 = api.require('FNRecordMp3');
FNRecordMp3.start({
afterSecond:1
}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
iOS 系统,Android 系统
可提供的 1.0.0 及更高版本
stop
停止录音
stop({params}, callback(ret))
params
second:
- 类型:数字类型
- 描述:多少秒以内的录音不保存(仅ios支持)
- 默认值:0.5
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: //布尔类型; 停止录音是否成功
}
示例代码
var FNRecordMp3 = api.require('FNRecordMp3');
FNRecordMp3.stop({
second:2
}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
iOS 系统,Android 系统
可提供的 1.0.0 及更高版本
pause
暂停录音 (仅支持安卓)
pause({params}, callback(ret))
params
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: //布尔类型;暂停录音是否成功
}
示例代码
var FNRecordMp3 = api.require('FNRecordMp3');
FNRecordMp3.pause({
}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
continue
恢复录音/继续录音 (仅支持安卓)
continue({params}, callback(ret))
params
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: //布尔类型;恢复录音是否成功
}
示例代码
var continue = api.require('FNRecordMp3');
continue.continue({
}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
getMp3Path
获取mp3音频文件的路径
getMp3Path({params}, callback(ret))
params
channel:
-类型:数字 -描述:(可选项)声道支持(仅ios支持) -默认:2 -取值范围: 1 单声道 2 立体声道
sampleRates:
-类型:数字 -描述:(可选项)采样率(仅ios支持) -默认:11025
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
path: //字符串类型;生成的mp3文件路径
status: //布尔类型;获取mp3路径是否成功
}
示例代码
var FNRecordMp3 = api.require('FNRecordMp3');
FNRecordMp3.getMp3Path({
channel:2,
sampleRates:11025
}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
iOS 系统,Android 系统
可提供的 1.0.0 及更高版本
getVolume
获取当前/实时音量 (仅安卓支持)
getVolume({params}, callback(ret))
params
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
volume: 0.1202 // 数字类型, 当前振幅,android返回当前分贝
}
示例代码
var FNRecordMp3 = api.require('FNRecordMp3');
FNRecordMp3.getVolume({
}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
addEventListener
添加事件监听者 (仅支持安卓)
addEventListener({params}, callback(ret))
params
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
volume: 0.1202 // 数字类型, 当前振幅,android返回当前分贝
}
示例代码
var FNRecordMp3 = api.require('FNRecordMp3');
FNRecordMp3.addEventListener({
}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
setMp3PathListener
设置音频文件返回监听,停止录音后返回当次录音文件路径(仅android支持)
setMp3PathListener({params}, callback(ret))
params
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
audioPath: '' // 字符串类型, 当次录音文件路径
}
示例代码
var FNRecordMp3 = api.require('FNRecordMp3');
FNRecordMp3.setMp3PathListener({
}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
Android 系统
可提供的 1.0.0 及更高版本
removeMp3PathListener
移除音频文件返回监听(仅android支持)
removeMp3PathListener({params}, callback(ret))
params
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status:, //布尔类型,是否移除成功
}
示例代码
var FNRecordMp3 = api.require('FNRecordMp3');
FNRecordMp3.removeMp3PathListener({
}, function(ret) {
if (ret) {
alert(JSON.stringify(ret));
}
});
可用性
Android 系统
可提供的 1.0.0 及更高版本