启用/关闭自定义音轨

说明

开启后，您可以通过本接口向 SDK 混入一条自定义的音轨。通过两个布尔型参数，您可以控制该音轨是否要在远端和本地播放。

方法名

enableMixExternalAudioFrame

用法

• 用法如下：

uniapp

module.enableMixExternalAudioFrame({
  params:{
  },
  //成功执行的函数
  success: (res) => {
    let data = res.data;
    console.log(data)
  },
  //失败执行的函数
  fail: (res) => {
    console.log(res)
  },
  //接口调用完成返回函数，不管成功还是失败都会返回
  complete: (res) => {
    // console.log(res)
  }
})

uniappx

module.enableMixExternalAudioFrame({
  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.enablePlayout	Boolean	否	无	控制混入的音轨是否要在本地播放，默认值：false
  params.enablePublish	Boolean	否	无	控制混入的音轨是否要在远端播放，默认值：false
  success	Function	否	无	执行成功的函数
  fail	Function	否	无	执行失败的函数
  complete	Function	否	无	执行完成的函数，不管成功还是失败都会执行

  注意

  如果您指定参数 enablePublish 和 enablePlayout 均为 false，代表完全关闭您的自定义音轨

回调

• 示例

{
"data": {},
"message": "",
"code": 0
}

• 回调说明：

  参数名	参数类型	参数描述
  message	String	消息提示
  data	Object	数据对象
  code	Integer	返回类型，0.成功，其他：失败