抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
BackgroundAudioManager 实例。可通过 tt.getBackgroundAudioManager 接口获取,通过它能够操作背景音频播放。

属性

可设置属性

属性名
类型
默认值
必填
说明
最低支持版本
src
string
''
音频源地址, 默认为空字符串,当设置了新的 src 时,会自动开始播放,仅支持临时路径(如通过下载到本地的音频地址)、网络地址(需在小程序开发者平台配置域名白名单),所支持的格式同系统音频播放器
1.36.0
startTime
number
0
开始播放的位置(单位:s)
1.36.0
title
string
小程序 AppID
音频标题, 用于原生音频播放器音频标题
1.36.0
epname
string
''
专辑名
1.36.0
singer
string
''
歌手名,原生音频播放器中的分享功能,分享出去的卡片简介,也将使用该值
1.36.0
coverImgUrl
string
小程序图标
封面图 URL,用于做原生音频播放器背景图。原生音频播放器中的分享功能,分享出去的卡片配图及背景也将使用该图
1.36.0
webUrl
string
''
页面链接,原生音频播放器中的分享功能,分享出去的卡片简介,也将使用该值
1.36.0
protocol
string
'http'
音频协议。默认值为 http,设置 HLS 可以支持播放 HLS 协议的直播音频
1.36.0
audioPage
Object
设置点击悬浮控件/通知栏跳转当前小程序指定页面,数据格式为 {path:"(音乐播放路径)",query:{name:''}}
1.36.0
playbackRate
number
1
播放速度。范围 0.5 ~ 2.0,默认为 1
2.33.0

只读属性

属性名
类型
默认值
必填
说明
最低支持版本
duration
number
当前音频总时长(单位:s)
1.36.0
currentTime
number
当前音频进度(单位:s)
1.36.0
paused
boolean
当前音频是否处于暂停状态
1.36.0
buffered
number
当前音频已缓冲部分(单位:s)
1.36.0

方法

方法名
说明
最低支持版本
播放背景音频。
1.36.0
暂停播放。
1.36.0
停止播放。
1.36.0
跳转到 position 指定的位置播放,数据格式为 number,单位为 s
1.36.0
监听背景音频进入可播放状态事件。但不保证后面可以流畅播放。
1.36.0
移除 onCanplay 绑定的事件处理函数。
1.36.0
监听背景音频播放事件。
1.36.0
移除 onPlay 绑定的事件处理函数。
1.36.0
监听背景音频暂停事件。
1.36.0
移除 onPause 绑定的事件处理函数。
1.36.0
监听背景音频停止事件。
1.36.0
移除 onStop 绑定的事件处理函数。
1.36.0
监听背景音频自然播放结束事件。
1.36.0
移除 onEnded 绑定的事件处理函数。
1.36.0
监听背景音频播放进度更新事件。
1.36.0
移除 onTimeUpdate 绑定的事件处理函数。
1.36.0
监听背景音频播放错误事件。
1.36.0
移除 onError 绑定的事件处理函数
1.36.0
监听背景音频开始跳转操作事件。
1.36.0
移除 onSeeking 绑定的事件处理函数
1.36.0
监听背景音频完成跳转操作事件。
1.36.0
移除 onSeeked 绑定的事件处理函数
1.36.0
监听用户在系统音乐播放面板点击下一曲事件。
1.36.0
移除 onNext 绑定的事件处理函数
1.36.0
监听用户在系统音乐播放面板点击上一曲事件。
1.36.0
移除 onPrev 绑定的事件处理函数
1.36.0

Bug & Tip