Skip to content

开始录音

说明

当您调用该接口后, 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)
  • 参数说明
    参数名参数类型是否必填默认值参数描述
    paramsObject参数配置
    params.saveDirString录音文件保存目录,不传或传空值插件会保存到默认目录下
    params.fileNameString保存的文件名,如:a.aac
    params.maxDurationPerFileIntegermaxDurationPerFile 录制文件分片时长,单位毫秒,最小值10000。默认值为0,表示不分片。
    params.recordingContentString音频录制内容类型,默认录制所有本地和远端音频,可选值请参考【音频录制内容类型
    successFunction执行成功的函数
    failFunction执行失败的函数
    completeFunction执行完成的函数,不管成功还是失败都会执行

音频录制内容类型

名称描述
TRTC_AudioRecordingContent_All录制本地和远端所有音频
TRTC_AudioRecordingContent_Local仅录制本地音频
TRTC_AudioRecordingContent_Remote仅录制远端音频

回调

  • 示例
json
{
"data": { 
  "result": 0
},
"message": "",
"code": 0
}
  • 回调说明:
    参数名参数类型参数描述
    messageString消息提示
    dataObject数据对象
    data.resultInteger0:成功;-1:录音已开始;-2:文件或目录创建失败;-3:后缀指定的音频格式不支持
    codeInteger返回类型,0.成功,其他:失败