赞
踩
获取全局唯一的背景音频管理器 backgroundAudioManager
。
背景音频,不是游戏的背景音乐,而是类似QQ音乐那样,App在后台时,仍然在播放音乐。如果你不需要在App切后台时继续播放,那么不应该使用本API,而应该使用普通音频APIuni.createInnerAudioContext。
平台差异说明
| App | H5 | 微信小程序 | 支付宝小程序 | 百度小程序 | 字节跳动小程序 | 飞书小程序 | QQ小程序 | 快手小程序 |
| :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: |
| √ | x | √ | x | √ | √ | x | √ | x |
backgroundAudioManager 对象的属性列表
| 属性 | 类型 | 说明 | 只读 |
| :-- | :-- | :-- | :-- |
| duration | Number | 当前音频的长度(单位:s),只有在当前有合法的 src 时返回 | 是 |
| currentTime | Number | 当前音频的播放位置(单位:s),只有在当前有合法的 src 时返回 | 是 |
| paused | Boolean | 当前是是否暂停或停止状态,true 表示暂停或停止,false 表示正在播放 | 是 |
| src | String | 音频的数据源,默认为空字符串,**当设置了新的 src 时,会自动开始播放,**目前支持的格式有 m4a, aac, mp3, wav | 否 |
| startTime | Number | 音频开始播放的位置(单位:s) | 否 |
| buffered | Number | 音频缓冲的时间点,仅保证当前播放时间点到此时间点内容已缓冲。 | 是 |
| title | String | 音频标题,用于做原生音频播放器音频标题。原生音频播放器中的分享功能,分享出去的卡片标题,也将使用该值。 | 否 |
| epname | String | 专辑名,原生音频播放器中的分享功能,分享出去的卡片简介,也将使用该值。 | 否 |
| singer | String | 歌手名,原生音频播放器中的分享功能,分享出去的卡片简介,也将使用该值。 | 否 |
| coverImgUrl | String | 封面图url,用于做原生音频播放器背景图。原生音频播放器中的分享功能,分享出去的卡片配图及背景也将使用该图。 | 否 |
| webUrl | String | 页面链接,原生音频播放器中的分享功能,分享出去的卡片简介,也将使用该值。 | 否 |
| protocol | String | 音频协议。默认值为 ‘http’,设置 ‘hls’ 可以支持播放 HLS 协议的直播音频,App平台暂不支持 | 否 |
backgroundAudioManager 对象的方法列表
| 方法 | 参数 | 说明 |
| :-- | :-- | :-- |
| play | | 播放 |
| pause | | 暂停 |
| stop | | 停止 |
| seek | position | 跳转到指定位置,单位 s |
| onCanplay | callback | 背景音频进入可以播放状态,但不保证后面可以流畅播放 |
| onPlay | callback | 背景音频播放事件 |
| onPause | callback | 背景音频暂停事件 |
| onStop | callback | 背景音频停止事件 |
| onEnded | callback | 背景音频自然播放结束事件 |
| onTimeUpdate | callback | 背景音频播放进度更新事件 |
| onPrev | callback | 用户在系统音乐播放面板点击上一曲事件(iOS only) |
| onNext | callback | 用户在系统音乐播放面板点击下一曲事件(iOS only) |
| onError | callback | 背景音频播放错误事件 |
| onWaiting | callback | 音频加载中事件,当音频因为数据不足,需要停下来加载时会触发 |
errCode 说明
| errCode | 说明 |
| :-- | :-- |
| 10001 | 系统错误 |
| 10002 | 网络错误 |
| 10003 | 文件错误 |
| 10004 | 格式错误 |
| -1 | 未知错误 |
示例
const bgAudioManager = uni.getBackgroundAudioManager();
bgAudioManager.title = ‘致爱丽丝’;
bgAudioManager.singer = ‘暂无’;
bgAudioManager.coverImgUrl = ‘https://bjetxgzv.cdn.bspapp.com/VKCEYUGU-uni-app-doc/7fbf26a0-4f4a-11eb-b680-7980c8a877b8.png’;
bgAudioManager.src = ‘https://bjetxgzv.cdn.bspapp.com/VKCEYUGU-hello-uniapp/2cc220e0-c27a-11ea-9dfb-6da8e309e0d8.mp3’;
注意
因为背景音频播放耗费手机电量,所以平台都有管控,需在manifest中填写申请。
ios App平台,背景播放需在manifest.json -> app-plus -> distribute -> ios 节点添加 "UIBackgroundModes":["audio"]
才能保证音乐可以后台播放(打包成ipa生效)
小程序平台,需在manifest.json 对应的小程序节点下,填写"requiredBackgroundModes": [“audio”]。发布小程序时平台会审核
Android App端默认不会在通知栏出现音量控制,如需此功能,需要在插件市场单独下载原生插件,详见
创建并返回内部 audio 上下文 innerAudioContext
对象。
平台差异说明
| App | H5 | 微信小程序 | 支付宝小程序 | 百度小程序 | 字节跳动小程序、飞书小程序 | QQ小程序 | 快手小程序 |
| :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: |
| √ | √ | √ | 1.23.4+ | √ | √ | √ | √ |
innerAudioContext 对象的属性列表
| 属性 | 类型 | 说明 | 只读 | 平台差异说明 |
| :-- | :-- | :-- | :-- | :-- |
| src | String | 音频的数据链接,用于直接播放。 | 否 | 微信小程序不支持本地路径 |
| startTime | Number | 开始播放的位置(单位:s),默认 0 | 否 | |
| autoplay | Boolean | 是否自动开始播放,默认 false | 否 | H5端部分浏览器不支持 |
| loop | Boolean | 是否循环播放,默认 false | 否 | |
| obeyMuteSwitch | Boolean | 是否遵循系统静音开关,当此参数为 false 时,即使用户打开了静音开关,也能继续发出声音,默认值 true | 否 | 微信小程序、百度小程序、字节跳动小程序、飞书小程序 |
| duration | Number | 当前音频的长度(单位:s),只有在当前有合法的 src 时返回,需要在onCanplay中获取 | 是 | |
| currentTime | Number | 当前音频的播放位置(单位:s),只有在当前有合法的 src 时返回,时间不取整,保留小数点后 6 位 | 是 | |
| paused | Boolean | 当前是是否暂停或停止状态,true 表示暂停或停止,false 表示正在播放 | 是 | |
| buffered | Number | 音频缓冲的时间点,仅保证当前播放时间点到此时间点内容已缓冲。 | 是 | |
| volume | Number | 音量。范围 0~1。 | 否 | |
innerAudioContext 对象的方法列表
| 方法 | 参数 | 说明 | 平台差异说明 |
| :-- | :-- | :-- | :-- |
| play | | 播放(H5端部分浏览器需在用户交互时进行) | |
| pause | | 暂停 | |
| stop | | 停止 | |
| seek | position | 跳转到指定位置,单位 s | |
| destroy | | 销毁当前实例 | |
| onCanplay | callback | 音频进入可以播放状态,但不保证后面可以流畅播放 | |
| onPlay | callback | 音频播放事件 | |
| onPause | callback | 音频暂停事件 | |
| onStop | callback | 音频停止事件 | |
| onEnded | callback | 音频自然播放结束事件 | |
| onTimeUpdate | callback | 音频播放进度更新事件 | |
| onError | callback | 音频播放错误事件 | |
| onWaiting | callback | 音频加载中事件,当音频因为数据不足,需要停下来加载时会触发 | |
| onSeeking | callback | 音频进行 seek 操作事件 | |
| onSeeked | callback | 音频完成 seek 操作事件 | |
| offCanplay | callback | 取消监听 onCanplay 事件 | 微信小程序1.9.0+,支付宝小程序,字节小程序、百度小程序 |
| offPlay | callback | 取消监听 onPlay 事件 | 微信小程序1.9.0+,支付宝小程序,字节小程序、百度小程序 |
| offPause | callback | 取消监听 onPause 事件 | 微信小程序1.9.0+,支付宝小程序,字节小程序、百度小程序 |
| offStop | callback | 取消监听 onStop 事件 | 微信小程序1.9.0+,支付宝小程序,字节小程序、百度小程序 |
| offEnded | callback | 取消监听 onEnded 事件 | 微信小程序1.9.0+,支付宝小程序,字节小程序、百度小程序 |
| offTimeUpdate | callback | 取消监听 onTimeUpdate 事件 | 微信小程序1.9.0+,支付宝小程序,字节小程序、百度小程序 |
| offError | callback | 取消监听 onError 事件 | 微信小程序1.9.0+,支付宝小程序,字节小程序、百度小程序 |
| offWaiting | callback | 取消监听 onWaiting 事件 | 微信小程序1.9.0+,支付宝小程序,字节小程序、百度小程序 |
| offSeeking | callback | 取消监听 onSeeking 事件 | 微信小程序1.9.0+,支付宝小程序,字节小程序、百度小程序 |
| offSeeked | callback | 取消监听 onSeeked 事件 | 微信小程序1.9.0+,支付宝小程序,字节小程序、百度小程序 |
errCode 说明
| errCode | 说明 |
| :-- | :-- |
| 10001 | 系统错误 |
| 10002 | 网络错误 |
| 10003 | 文件错误 |
| 10004 | 格式错误 |
| -1 | 未知错误 |
支持格式
| 格式 | iOS | Android |
| :-- | :-- | :-- |
| flac | x | √ |
| m4a | √ | √ |
| ogg | x | √ |
| ape | x | √ |
| amr | x | √ |
| wma | x | √ |
| wav | √ | √ |
| mp3 | √ | √ |
| mp4 | x | √ |
| aac | √ | √ |
| aiff | √ | x |
| caf | √ | x |
示例
const innerAudioContext = uni.createInnerAudioContext();
innerAudioContext.autoplay = true;
innerAudioContext.src = ‘https://bjetxgzv.cdn.bspapp.com/VKCEYUGU-hello-uniapp/2cc220e0-c27a-11ea-9dfb-6da8e309e0d8.mp3’;
innerAudioContext.onPlay(() => {
console.log(‘开始播放’);
});
innerAudioContext.onError((res) => {
cons
Copyright © 2003-2013 www.wpsshop.cn 版权所有,并保留所有权利。