Skip to content

开始播放背景音乐

说明

每个音乐都需要您指定具体的 ID,您可以通过该 ID 对音乐的开始、停止、音量等进行设置

方法名

startPlayMusic

用法

  • 用法如下:
js
module.startPlayMusic({
  params:{
  },
  //成功执行的函数
  success: (res) => {
    let data = res.data;
    console.log(data)
  },
  //失败执行的函数
  fail: (res) => {
    console.log(res)
  },
  //接口调用完成返回函数,不管成功还是失败都会返回
  complete: (res) => {
    // console.log(res)
  }
})
js
module.startPlayMusic({
  params:{
  },
  //成功执行的函数
  success: (res) => {
    const data = res.data;
    console.log(data)
  },
  //失败执行的函数
  fail: (res) => {
    console.log(res)
  },
  //接口调用完成返回函数,不管成功还是失败都会返回
  // complete: (res) => {
  //   console.log(res)
  // }
} as LevenOptions)
  • 参数说明

    参数名参数类型是否必填默认值参数描述
    paramsObject参数配置
    params.idInteger音乐 ID
    params.pathString音效文件的完整路径或 URL 地址。支持的音频格式包括 MP3、AAC、M4A、WAV
    params.endTimeMSInteger音乐结束播放时间点,单位毫秒,0表示播放至文件结尾
    params.isShortFileBoolean播放的是否为短音乐文件
    true:需要重复播放的短音乐文件;false:正常的音乐文件。默认值:false
    params.loopCountInteger音乐循环播放的次数
    取值范围为 [0, 任意正整数],默认值:0。0 表示播放音乐一次;1 表示播放音乐两次;以此类推
    params.publishBoolean是否将音乐传到远端
    true:音乐在本地播放的同时,远端用户也能听到该音乐;false:主播只能在本地听到该音乐,远端观众听不到。默认值:false
    params.startTimeMSInteger音乐开始播放时间点,单位:毫秒
    successFunction执行成功的函数
    failFunction执行失败的函数
    completeFunction执行完成的函数,不管成功还是失败都会执行

    注意

    1. 如果要多次播放同一首背景音乐,请不要每次播放都分配一个新的 ID,我们推荐使用相同的 ID。
    2. 若您希望同时播放多首不同的音乐,请为不同的音乐分配不同的 ID 进行播放。
    3. 如果使用同一个 ID 播放不同音乐,SDK 会先停止播放旧的音乐,再播放新的音乐。

回调

  • 示例
json
{
"data": {
  "result": true
},
"message": "",
"code": 0
}
  • 回调说明:
    参数名参数类型参数描述
    messageString消息提示
    dataObject数据对象
    data.resultBoolean播放状态
    codeInteger返回类型,0.成功,其他:失败