微信小程序API 音乐播放控制

2016-09-24

wx.getBackgroundAudioPlayerState(OBJECT)


获取音乐播放状态。

OBJECT参数说明:

参数类型必填说明
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

success返回参数说明:

参数 说明
duration 选定音频的长度(单位:s),只有在当前有音乐播放时返回
currentPosition 选定音频的播放位置(单位:s),只有在当前有音乐播放时返回
status 播放状态(2:没有音乐在播放,1:播放中,0:暂停中)
downloadPercent 音频的下载进度(整数,80 代表 80%),只有在当前有音乐播放时返回
dataUrl 歌曲数据链接,只有在当前有音乐播放时返回

示例代码:

wx.getBackgroundAudioPlayerState({
    success:function(res){
        var status = res.status
        var dataUrl = res.dataUrl
        var currentPosition = res.currentPosition
        var duration = res.duration
        var downloadPercent = res.downloadPercent
    }
})

wx.playBackgroundAudio(OBJECT)


使用后台播放器播放音乐,对于微信客户端来说,只能同时有一个后台音乐在播放。当用户离开小程序后,音乐将暂停播放;当用户点击“显示在聊天顶部”时,音乐不会暂停播放;当用户在其他小程序占用了音乐播放器,原有小程序内的音乐将停止播放。

OBJECT参数说明

参数类型必填说明
dataUrlString音乐链接
titleString音乐标题
coverImgUrlString封面URL
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

示例代码

wx.playBackgroundAudio({
    dataUrl: '',
    title: '',
    coverImgUrl: ''
})

wx.pauseBackgroundAudio()


暂停播放音乐。

示例代码

wx.pauseBackgroundAudio()

wx.seekBackgroundAudio(OBJECT)


控制音乐播放进度。

OBJECT参数说明

参数类型必填说明
positionNumber音乐位置,单位:秒
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

示例代码

wx.seekBackgroundAudio({
    position: 30
})

wx.stopBackgroundAudio()


停止播放音乐。

示例代码

wx.stopBackgroundAudio()

wx.onBackgroundAudioPlay(CALLBACK)


监听音乐播放。

wx.onBackgroundAudioPause(CALLBACK)


监听音乐暂停。

wx.onBackgroundAudioStop(CALLBACK)


监听音乐停止。


bug & tip

  1. bug:iOS6.3.30wx.seekBackgroundAudio 会有短暂延迟