预加载背景音乐

说明

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

方法名

preloadMusic

用法

用法如下：

uniappuniappx

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

module.preloadMusic({
  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.id	Integer	是	无	音乐 ID SDK 允许播放多路音乐，因此需要使用 ID 进行标记，用于控制音乐的开始、停止、音量等
params.path	String	是	无	音效文件的完整路径或 URL 地址。支持的音频格式包括 MP3、AAC、M4A、WAV
params.endTimeMS	Integer	否	无	音乐结束播放时间点，单位毫秒，0表示播放至文件结尾
params.isShortFile	Boolean	否	无	播放的是否为短音乐文件 true：需要重复播放的短音乐文件；false：正常的音乐文件。默认值：false
params.loopCount	Integer	否	无	音乐循环播放的次数取值范围为 [0, 任意正整数]，默认值：0。0 表示播放音乐一次；1 表示播放音乐两次；以此类推
params.publish	Boolean	否	无	是否将音乐传到远端 true：音乐在本地播放的同时，远端用户也能听到该音乐；false：主播只能在本地听到该音乐，远端观众听不到。默认值：false
params.startTimeMS	Integer	否	无	音乐开始播放时间点，单位：毫秒
success	Function	否	无	执行成功的函数
fail	Function	否	无	执行失败的函数
complete	Function	否	无	执行完成的函数，不管成功还是失败都会执行

注意

预先加载最多同时支持2个不同 ID 的预加载，且预加载时长不超过10分钟，使用完需调用 stopPlayMusic，否则内存不释放。
若该ID对应的音乐正在播放中，预加载会失败，需先调用 stopPlayMusic。
当参数和传入 startPlayMusic 的参数完全相同时，预加载有效。

回调

示例

json

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

回调说明：
参数名参数类型参数描述
message String 消息提示
data Object 数据对象
data.result Boolean 设置结果
code Integer 返回类型，0.成功，其他：失败

预加载背景音乐 ​

方法名 ​

用法 ​

回调 ​

预加载背景音乐

方法名

用法

回调