upAudioRecorderModule 录音模块

模块概述

音频模块为H5页面提供音频录制相关功能,方便开发者在移动端录入音频信息


方法列表

  • startRecord (开始录音)
  • stopRecord (停止录音)
  • getAttr (获取文件属性)

公共数据

  • 所有数据均以JSON结构返回,由代码,信息和数据三部分组成
    {
      "retCode": "000000",  // 接口状态标识码,错误标识码以20开头
      "retInfo": "操作成功", // 接口信息说明
      "retData": null  // 业务数据
    }
    

具体定义:返回数据通用

  • fs://路径说明

fs://是容器内的路径标识,在需要路径时,一般都使用fs://的路径。fs://路径是容器沙盒的相对路径,本接口仅支持保存在根路径下

    'fs://myRecord.aac': 沙盒根目录下的myRecord.aac

模块变更记录

  • V3.0.0 -方法变更:
    • 修改startRecord的返回数据结构,从retCode判断接口执行结果
    • 修改stopRecord的返回数据结构,从retCode判断接口执行结果
  • V3.2.0
    • 音频模块未定义的retCode编码按照通用数据规定变为990001,'初始化失败!'使用通用retCode为000001
    • Nebula容器下仅支持Android

方法说明

  • startRecord

    startRecord({params})

目前仅支持保存为aac音频格式

适用性
容器 cordova APICloud Nebula
支持情况
APP版本 / 5.2.0 及以上 6.12.0 及以上
params 输入参数:
属性名 数据类型 是否必填 说明
savePath String 保存的文件路径(仅支持 fs://)
错误返回 retCode说明:
retCode编码 retInfo说明
000001 参数无效/操作无效-正在录音
000000 录音开始成功
200002 输出路径无效
200005 获取录音权限失败
正确返回 retData说明:

示例
{
    "retCode": "000000",  // 接口状态标识码,错误标识码以20开头
    "retInfo": "录音开始成功", // 接口信息说明
}
示例
uplusapi.upAudioRecorderModule.startRecord({savePath:'fs://myRecord.aac'}).then((result) => {
  console.log('result',result);
},(err) =>{
  console.log('err',err);
});
  • stopRecord

    stopRecord()
适用性
容器 cordova APICloud Nebula
支持情况
APP版本 / 5.2.0 及以上 6.12.0 及以上
params 输入参数:

错误返回 retCode说明:
retCode编码 retInfo说明
000001 操作无效,未开始录音
000000 录音结束成功
正确返回 retData说明:
属性名 数据类型 说明
fullPath String /storage/emulated/0/haier/audio/fs/test.aac
示例
{
    "retCode": "000000",
    "retInfo": "录音结束成功",
    "retData": {
        "fullPath": "\/storage\/emulated\/0\/haier\/audio\/fs\/test.aac"
    }
}
示例
uplusapi.upAudioRecorderModule.stopRecord().then((result) => {
  console.log('result',result);
});
  • getAttr 获取文件属性

    getAttr({params})
适用性
容器 cordova APICloud Nebula
支持情况
APP版本 / 5.2.0 及以上 6.12.0 及以上
params 输入参数:
属性名 数据类型 是否必填 说明
path String 保存的文件路径
错误返回 retCode说明:
retCode编码 retInfo说明
200000 参数无效(入参Json)/文件不存在
200005 获取读写存储卡权限失败
000000 获取录音文件属性成功
正确返回 retData说明:
属性名 数据类型 说明
duration Number 100000 音频的时长;单位:ms
length Number 6434734 文件大小;单位:byte
示例
{
    "retCode": "000000",
    "retInfo": "获取录音文件属性成功",
    "retData": {
        "duration": 2647,
        "length": 43169
    }
}
示例
uplusapi.upAudioRecorderModule.getAttr({path:'fs://myRecord.aac'}).then((result) => {
  console.log('result',result);
},(err) =>{
  console.log('err',err);
});

results matching ""

    No results matching ""