微信小程序插件:支持
微信 鸿蒙 OS 版:支持
功能描述
监听用户在系统音乐播放面板点击上一曲的事件
参数
function listener
用户在系统音乐播放面板点击上一曲事件的监听函数
BackgroundAudioManager 实例,可通过 wx.getBackgroundAudioManager 获取。
音频的数据源(2.2.3 开始支持云文件ID)。默认为空字符串,当设置了新的 src 时,会自动开始播放,目前支持的格式有 m4a, aac, mp3, wav。
音频开始播放的位置(单位:s)。
音频标题,用于原生音频播放器音频标题(必填)。原生音频播放器中的分享功能,分享出去的卡片标题,也将使用该值。
专辑名,原生音频播放器中的分享功能,分享出去的卡片简介,也将使用该值。
歌手名,原生音频播放器中的分享功能,分享出去的卡片简介,也将使用该值。
封面图 URL,用于做原生音频播放器背景图。原生音频播放器中的分享功能,分享出去的卡片配图及背景也将使用该图。
页面链接,原生音频播放器中的分享功能,分享出去的卡片简介,也将使用该值。
基础库 1.9.94 开始支持,低版本需做兼容处理。
音频协议。默认值为 ‘http’,设置 ‘hls’ 可以支持播放 HLS 协议的直播音频。
基础库 2.11.0 开始支持,低版本需做兼容处理。
播放速度。范围 0.5-2.0,默认为 1。(Android 需要 6 及以上版本)
当前音频的长度(单位:s),只有在有合法 src 时返回。(只读)
当前音频的播放位置(单位:s),只有在有合法 src 时返回。(只读)
当前是否暂停或停止。(只读)
音频已缓冲的时间,仅保证当前播放时间点到此时间点内容已缓冲。(只读)
基础库 2.13.0 开始支持,低版本需做兼容处理。
origin: 发送完整的referrer; no-referrer: 不发送。格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html,其中 {appid} 为微信小程序的 appid,{version} 为微信小程序的版本号,版本号为 0 表示为开发版、体验版以及审核版本,版本号为 devtools 表示为开发者工具,其余为正式版本;
基础库 3.4.8 开始支持,低版本需做兼容处理。
关联页面路径。设置后,当点击播放器上的微信小程序跳转链接时,将跳转到这个关联页面路径(实验特性,目前仅Android端支持)
基础库 3.4.8 开始支持,低版本需做兼容处理。
音频类型。可设置 “audio” 和 “music” 两种值,默认为 “audio”。不同音频类型对应的播放器样式不一样(实验特性,目前仅iOS和Android端支持)
播放音乐
暂停音乐
跳转到指定位置
停止音乐
跳转至指定句子。
设置听书定时关闭模式。
监听背景音频播放进度更新事件,只有微信小程序在前台时会回调。
监听背景音频进入可播放状态事件。 但不保证后面可以流畅播放
监听音频加载中事件。当音频因为数据不足,需要停下来加载时会触发
监听背景音频播放错误事件
监听背景音频播放事件
监听背景音频暂停事件
监听背景音频开始跳转操作事件
监听背景音频完成跳转操作事件
监听背景音频自然播放结束事件
监听背景音频停止事件
监听用户在系统音乐播放面板点击下一曲事件
监听用户在系统音乐播放面板点击上一曲事件
const backgroundAudioManager = wx.getBackgroundAudioManager()
backgroundAudioManager.title = '此时此刻'
backgroundAudioManager.epname = '此时此刻'
backgroundAudioManager.singer = '许巍'
backgroundAudioManager.coverImgUrl = 'http://y.gtimg.cn/music/photo_new/T002R300x300M000003rsKF44GyaSk.jpg?max_age=2592000'
// 设置了 src 之后会自动播放
backgroundAudioManager.src = 'https://wx_test.mp3'
基础库 1.2.0 开始支持,低版本需做兼容处理。
微信小程序插件:支持,需要微信小程序基础库版本不低于 1.9.6
微信 Windows 版:支持
微信 Mac 版:支持
微信 鸿蒙 OS 版:支持
获取全局唯一的背景音频管理器。 微信小程序切入后台,如果音频处于播放状态,可以继续播放。但是后台状态不能通过调用API操纵音频的播放状态。
从微信客户端6.7.2版本开始,若需要在微信小程序切后台后继续播放音频,需要在 app.json 中配置 requiredBackgroundModes 属性。开发版和体验版上可以直接生效,正式版还需通过审核。
从基础库 1.2.0 开始,本接口停止维护,请使用 wx.getBackgroundAudioManager 代替
以 Promise 风格 调用:支持
微信小程序插件:支持,需要微信小程序基础库版本不低于 1.9.6
微信 鸿蒙 OS 版:支持
获取后台音乐播放状态。
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| success | function | 否 | 接口调用成功的回调函数 | |
| fail | function | 否 | 接口调用失败的回调函数 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
| 属性 | 类型 | 说明 | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| duration | number | 选定音频的长度(单位:s),只有在音乐播放中时返回 | |||||||||
| currentPosition | number | 选定音频的播放位置(单位:s),只有在音乐播放中时返回 | |||||||||
| status | number | 播放状态 | |||||||||
| |||||||||||
| downloadPercent | number | 音频的下载进度百分比,只有在音乐播放中时返回 | |||||||||
| dataUrl | string | 歌曲数据链接,只有在音乐播放中时返回 | |||||||||
wx.getBackgroundAudioPlayerState({
success (res) {
const status = res.status
const dataUrl = res.dataUrl
const currentPosition = res.currentPosition
const duration = res.duration
const downloadPercent = res.downloadPercent
}
})