开发
API

BackgroundAudioManager

BackgroundAudioManager 实例。可通过 tt.getBackgroundAudioManager 接口获取,通过它能够操作背景音频播放。

属性

属性名类型默认值必填说明最低支持版本
srcstring音频源地址, 默认为空字符串,当设置了新的 src 时,会自动开始播放,仅支持临时路径(如通过下载到本地的音频地址)、网络地址(需在小程序开发者平台配置域名白名单),所支持的格式同系统音频播放器
startTimenumber0开始播放的位置(单位:s)
titlestring小程序 AppID音频标题, 用于原生音频播放器音频标题
epnamestring专辑名
singerstring歌手名,原生音频播放器中的分享功能,分享出去的卡片简介,也将使用该值
coverImgUrlstring小程序图标封面图 URL,用于做原生音频播放器背景图。原生音频播放器中的分享功能,分享出去的卡片配图及背景也将使用该图
webUrlstring页面链接,原生音频播放器中的分享功能,分享出去的卡片简介,也将使用该值
protocolstring'http'音频协议。默认值为 http,设置 hls 可以支持播放 HLS 协议的直播音频
audioPageObject设置点击悬浮控件/通知栏跳转当前小程序指定页面,数据格式为 {path:"(音乐播放路径)",query:{name:''}}
durationnumber当前音频总时长(单位 s),只读
currentTimenumber当前音频进度(单位 s),只读
pausedboolean当前音频是否处于暂停状态,只读
bufferednumber当前音频已缓冲部分(单位 s),只读

方法

BackgroundAudioManager.play()

播放背景音频。

BackgroundAudioManager.pause()

暂停播放。

BackgroundAudioManager.stop()

停止播放。

BackgroundAudioManager.seek(number position)

跳转到 position 指定的位置播放,数据格式为 number,单位为 s

BackgroundAudioManager.onCanplay(function callback)

监听背景音频进入可播放状态事件。但不保证后面可以流畅播放。

BackgroundAudioManager.onPlay(function callback)

监听背景音频播放事件。

BackgroundAudioManager.onPause(function callback)

监听背景音频暂停事件。

BackgroundAudioManager.onStop(function callback)

监听背景音频停止事件。

BackgroundAudioManager.onEnded(function callback)

监听背景音频自然播放结束事件。

BackgroundAudioManager.onTimeUpdate(function callback)

监听背景音频播放进度更新事件。

BackgroundAudioManager.offTimeUpdate(function callback)`

取消监听 TimeUpdate 事件。

BackgroundAudioManager.onError(function callback)

监听背景音频播放错误事件。

BackgroundAudioManager.onWaiting(function callback)

监听音频加载中事件。当音频因为数据不足,需要停下来加载时会触发。

BackgroundAudioManager.onSeeking(function callback)

监听背景音频开始跳转操作事件。

BackgroundAudioManager.onSeeked(function callback)

监听背景音频完成跳转操作事件。

BackgroundAudioManager.onNext(function callback)

监听用户在系统音乐播放面板点击下一曲事件。

BackgroundAudioManager.onPrev(function callback)

监听用户在系统音乐播放面板点击上一曲事件。

点击纠错
评价此篇文档