设置背景音乐的事件回调接口

说明

请在播放背景音乐之前使用该接口设置播放事件回调，以便感知背景音乐的播放进度

方法名

setMusicObserver

用法

用法如下：

uniappuniappx

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

module.setMusicObserver({
  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.musicId	Integer	是	无	音乐 ID
success	Function	否	无	执行成功的函数
fail	Function	否	无	执行失败的函数
complete	Function	否	无	执行完成的函数，不管成功还是失败都会执行

回调

示例

json

{
"data": {
  "type": "onStart",
  "id": 8888,
  "errCode": 0
},
"message": "",
"code": 0
}

回调说明：

参数名	参数类型	参数描述
message	String	消息提示
data	Object	数据对象
data.type	String	当前状态 `onSetMusicObserver`：接口调用成功 `onStart`：背景音乐开始播放 `onPlayProgress`：背景音乐的播放进度 `onComplete`：背景音乐已经播放完毕
data.id	Integer	音乐 ID
data.errCode	Integer	错误码。0: 开始播放成功；-4001:打开文件失败，如音频数据无效，FFMPEG 协议未找到等；-4005:非法路径导致打开文件失败，请检查您传入的路径参数是否指向一个合法的音乐文件；-4006:非法URL导致打开文件失败，请用浏览器检查您传入的 URL 地址是否可以下载到期望的音乐文件，如果操作系统为 iOS 或 MacOS 请确保使用 https 链接；-4007:无音频流导致打开文件失败，请确认您传入的文件是否是合法的音频文件，以及文件是否被损坏；-4008:格式不支持导致打开文件失败，请确认您传入的文件格式是否是支持的文件格式，移动端支持【mp3，aac，m4a，wav，ogg，mp4，mkv】，桌面端支持【mp3，aac，m4a，wav，mp4，mkv】；-4009:同时播放 bgm 数量超过限定值，如当前同时播放 bgm 数量超过 10 后提示该错误，请检查并发播放 bgm 数量
data.curPtsMS	Integer	当前播放时长
data.durationMS	Integer	总时长
code	Integer	返回类型，0.成功，其他：失败

设置背景音乐的事件回调接口 ​

方法名 ​

用法 ​

回调 ​

设置背景音乐的事件回调接口

方法名

用法

回调