Appearance
开始录音
说明
当您调用该接口后, SDK 会将本地和远端的所有音频(包括本地音频,远端音频,背景音乐和音效等)混合并录制到一个本地文件中。
该接口在进入房间前后调用均可生效,如果录制任务在退出房间前尚未通过 stopAudioRecording 停止,则退出房间后录制任务会自动被停止。
本次录制的启动、完成状态会通过本地录制相关回调进行通知。参见 addListener 相关回调
方法名
startAudioRecording
用法
- 用法如下:
js
module.startAudioRecording({
params:{
},
//成功执行的函数
success: (res) => {
let data = res.data;
console.log(data)
},
//失败执行的函数
fail: (res) => {
console.log(res)
},
//接口调用完成返回函数,不管成功还是失败都会返回
complete: (res) => {
// console.log(res)
}
})js
module.startAudioRecording({
params:{
},
//成功执行的函数
success: (res) => {
const data = res.data;
console.log(data)
},
//失败执行的函数
fail: (res) => {
console.log(res)
},
//接口调用完成返回函数,不管成功还是失败都会返回
// complete: (res) => {
// console.log(res)
// }
} as LevenOptions)- 参数说明
参数名 参数类型 是否必填 默认值 参数描述 params Object 是 无 参数配置 params.saveDir String 否 无 录音文件保存目录,不传或传空值插件会保存到默认目录下 params.fileName String 否 无 保存的文件名,如:a.aac params.maxDurationPerFile Integer 否 无 maxDurationPerFile 录制文件分片时长,单位毫秒,最小值10000。默认值为0,表示不分片。 params.recordingContent String 否 无 音频录制内容类型,默认录制所有本地和远端音频,可选值请参考【音频录制内容类型】 success Function 否 无 执行成功的函数 fail Function 否 无 执行失败的函数 complete Function 否 无 执行完成的函数,不管成功还是失败都会执行
音频录制内容类型
| 名称 | 描述 |
|---|---|
| TRTC_AudioRecordingContent_All | 录制本地和远端所有音频 |
| TRTC_AudioRecordingContent_Local | 仅录制本地音频 |
| TRTC_AudioRecordingContent_Remote | 仅录制远端音频 |
回调
- 示例
json
{
"data": {
"result": 0
},
"message": "",
"code": 0
}- 回调说明:
参数名 参数类型 参数描述 message String 消息提示 data Object 数据对象 data.result Integer 0:成功;-1:录音已开始;-2:文件或目录创建失败;-3:后缀指定的音频格式不支持 code Integer 返回类型,0.成功,其他:失败
