getBackgroundAudioManager 1.36.0+

获取全局唯一的背景音频管理器BackgroundAudioManager。 小程序切入后台,如果音频处于播放状态,可以继续播放。但是后台状态不能通过调用 API 操纵音频的播放状态。(注:正在内测中,可能会存在问题。)

BackgroundAudioManager的属性列表

名称数据类型属性默认值描述
srcstringN/A音频源地址, 默认为空字符串,当设置了新的 src 时,会自动开始播放
startTimenumber0开始播放的位置,单位s
titlestring音频标题, 用于原生音频播放器音频标题(必填)
epnamestring专辑名
singerstring歌手名,原生音频播放器中的分享功能,分享出去的卡片简介,也将使用该值
coverImgUrlstring封面图 URL,用于做原生音频播放器背景图。原生音频播放器中的分享功能,分享出去的卡片配图及背景也将使用该图
webUrlstring页面链接,原生音频播放器中的分享功能,分享出去的卡片简介,也将使用该值
protocolstringhttp音频协议。默认值为 'http',设置 'hls' 可以支持播放 HLS 协议的直播音频
audioPageobject设置点击悬浮控件/通知栏跳转当前小程序指定页面
durationnumberreadonly当前音频总时长,单位s
currentTimenumberreadonly当前音频进度,单位s
pausedbooleanreadonly当前音频是否处于暂停状态
bufferednumberreadonly当前音频已缓冲部分,单位s

注:audioPage 的数据格式为{path:"(音乐播放路径)",query:{name:''}}

BackgroundAudioManager的方法列表

play()

播放背景音频

pause()

暂停播放

stop()

停止播放

seek(position)

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

onCanplay(() => {})

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

onPlay(() => {})

监听背景音频播放事件

onPause(() => {})

监听背景音频暂停事件

onStop(() => {})

监听背景音频停止事件

onEnded(() => {})

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

onTimeUpdate(() => {})

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

offTimeUpdate(() => {})

取消监听 TimeUpdate 事件

onError((error) => {})

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

onWaiting(() => {})

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

onSeeking(() => {})

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

onSeeked(() => {})

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

onNext(() => {})

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

onPrev(() => {})

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

代码示例

const backgroundAudioManager = tt.getBackgroundAudioManager();

backgroundAudioManager.title = "test";
backgroundAudioManager.epname = "test";
backgroundAudioManager.singer = "jack";
backgroundAudioManager.src =
  "https://tosv.byted.org/obj/developer/sdk/0000-0001.mp3";