腾讯云小程序平台背景音频-开发指南-文档中心-腾讯云

stopBackgroundAudio
该 API 使用方法为 wx.stopBackgroundAudio(Object object)
功能说明：停止播放音乐。
参数及说明：Object object。
属性
类型
默认值
必填
说明
success
function
-
否
接口调用成功的回调函数
fail
function
-
否
接口调用失败的回调函数
complete
function
-
否
接口调用结束的回调函数（调用成功、失败都会执行）
seekBackgroundAudio
该 API 使用方法为 wx.seekBackgroundAudio(Object object)
功能说明：控制音乐播放进度。
参数及说明：Object object。
属性
类型
默认值
必填
说明
position
number
-
是
音乐位置，单位：秒
success
function
-
否
接口调用成功的回调函数
fail
function
-
否
接口调用失败的回调函数
complete
function
-
否
接口调用结束的回调函数（调用成功、失败都会执行）
示例代码
wx.seekBackgroundAudio({  
    position: 30
})
playBackgroundAudio
该 API 使用方法为 wx.playBackgroundAudio(Object object)
功能说明：使用后台播放器播放音乐。对于宿主客户端来说，只能同时有一个后台音乐在播放。当用户离开小程序后，音乐将暂停播放；当用户在其他小程序占用了音乐播放器，原有小程序内的音乐将停止播放。
参数及说明：Object object。
属性
类型
默认值
必填
说明
dataUrl
string
-
是
音乐链接，目前支持的格式有 m4a, aac, mp3, wav
title
string
-
否
音乐标题
coverImgUrl
string
-
否
封面URL
success
function
-
否
接口调用成功的回调函数
fail
function
-
否
接口调用失败的回调函数
complete
function
-
否
接口调用结束的回调函数（调用成功、失败都会执行）
示例代码
wx.playBackgroundAudio({
  dataUrl: '',
  title: '',
  coverImgUrl: ''
})
pauseBackgroundAudio
该 API 使用方法为 wx.pauseBackgroundAudio(Object object)
功能说明：暂停播放音乐。
参数及说明：Object object。
属性
类型
默认值
必填
说明
success
function
-
否
接口调用成功的回调函数
fail
function
-
否
接口调用失败的回调函数
complete
function
-
否
接口调用结束的回调函数（调用成功、失败都会执行）
onBackgroundAudioStop
该 API 使用方法为 wx.onBackgroundAudioStop(function listener)
功能说明：监听音乐停止事件。
参数及说明：function listener，音乐停止事件的监听函数。
onBackgroundAudioPlay
该 API 使用方法为 wx.onBackgroundAudioPlay(function listener)
功能说明：监听音乐播放事件。
参数及说明：function listener，音乐播放事件的监听函数。
onBackgroundAudioPause
该 API 使用方法为 wx.onBackgroundAudioPause(function listener)
功能说明：监听音乐暂停事件。
参数及说明：function listener，音乐暂停事件的监听函数。
getBackgroundAudioPlayerState
该 API 使用方法为 wx.getBackgroundAudioPlayerState(Object object)
功能说明：获取后台音乐播放状态。
参数及说明：Object object。
属性
类型
默认值
必填
说明
success
function
-
否
接口调用成功的回调函数
fail
function
-
否
接口调用失败的回调函数
complete
function
-
否
接口调用结束的回调函数（调用成功、失败都会执行）
object.success 回调函数参数：Object res。
属性
类型
说明
duration
number
选定音频的长度（单位：s），只有在音乐播放中时返回
currentPosition
number
选定音频的播放位置（单位：s），只有在音乐播放中时返回 getBackgroundAudioManager
status
number
播放状态，合法值：
0：暂停中
1：播放中
2：没有音乐播放
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
  }
})
getBackgroundAudioManager
功能说明：获取全局唯一的背景音频管理器。 小程序切入后台，如果音频处于播放状态，可以继续播放。但是后台状态不能通过调用API操纵音频的播放状态。
BackgroundAudioManager
BackgroundAudioManager 实例，可通过 wx.getBackgroundAudioManager 获取。
属性
类型
说明
string src
音频的数据源。默认为空字符串，当设置了新的 src 时，会自动开始播放，目前支持的格式有 m4a, aac, mp3, wav
number startTime
音频开始播放的位置，单位：s
string title
音频标题，用于原生音频播放器音频标题（必填）。原生音频播放器中的分享功能，分享出去的卡片标题，也将使用该值
string epname
专辑名，原生音频播放器中的分享功能，分享出去的卡片简介，也将使用该值
string singer
歌手名，原生音频播放器中的分享功能，分享出去的卡片简介，也将使用该值
string coverImgUrl
封面图 URL，用于做原生音频播放器背景图。原生音频播放器中的分享功能，分享出去的卡片配图及背景也将使用该图
string webUrl
页面链接，原生音频播放器中的分享功能，分享出去的卡片简介，也将使用该值
string protocol
音频协议。默认值为 'http'，设置 'hls' 可以支持播放 HLS 协议的直播音频
number playbackRate
播放速度。范围 0.5-2.0，默认为 1（Android 需要 6 及以上版本）
number duration
当前音频的长度（单位：s），只有在有合法 src 时返回（只读）
number currentTime
当前音频的播放位置（单位：s），只有在有合法 src 时返回（只读）
boolean paused
当前是否暂停或停止（只读）
number buffered
音频已缓冲的时间，仅保证当前播放时间点到此时间点内容已缓冲（只读）
string referrerPolicy
origin：发送完整的referrer；no-referrer：不发送。格式固定为
https://servicewechat.com/{appid}/{version}/page-frame.html，其中 {appid} 为小程序的 appid，{version} 为小程序的版本号，版本号为 0 表示为开发版、体验版以及审核版本，版本号为 devtools 表示为开发者工具，其余为正式版本；
方法集
onCanplay
该 方法 使用方式为 BackgroundAudioManager.onCanplay(function listener)
功能说明：监听背景音频进入可播放状态事件。 但不保证后面可以流畅播放。
参数及说明：function listener，背景音频进入可播放状态事件的监听函数。
onEnded
该 方法 使用方式为 BackgroundAudioManager.onEnded(function listener)
功能说明：监听背景音频自然播放结束事件。
参数及说明：function listener，背景音频自然播放结束事件的监听函数。
onError
该 方法 使用方式为 BackgroundAudioManager.onError(function listener)
功能说明：监听背景音频播放错误事件。
参数及说明：function listener，背景音频播放错误事件的监听函数。
onNext
该 方法 使用方式为 BackgroundAudioManager.onNext(function listener)
功能说明：监听用户在系统音乐播放面板点击下一曲事件（仅 iOS）。
参数及说明：function listener，用户在系统音乐播放面板点击下一曲事件的监听函数。
onPause
该 方法 使用方式为 BackgroundAudioManager.onPause(function listener)
功能说明：监听背景音频暂停事件。
参数及说明：function listener，背景音频暂停事件的监听函数。
onPlay
该 方法 使用方式为 BackgroundAudioManager.onPlay(function listener)
功能说明：监听背景音频播放事件。
参数及说明：function listener，背景音频播放事件的监听函数。
onPrev
该 方法 使用方式为 BackgroundAudioManager.onPrev(function listener)
功能说明：监听用户在系统音乐播放面板点击上一曲事件（仅 iOS）。
参数及说明：function listener，用户在系统音乐播放面板点击上一曲事件的监听函数。
onSeeked
该 方法 使用方式为 BackgroundAudioManager.onSeeked(function listener)
功能说明：监听背景音频完成跳转操作事件。
参数及说明：function listener，背景音频完成跳转操作事件的监听函数。
onSeeking
该 方法 使用方式为 BackgroundAudioManager.onSeeking(function listener)
功能说明：监听背景音频开始跳转操作事件。
参数及说明：function listener，背景音频开始跳转操作事件的监听函数。
onStop
该 方法 使用方式为 BackgroundAudioManager.onStop(function listener)
功能说明：监听背景音频停止事件。
参数及说明：function listener，背景音频停止事件的监听函数。
onTimeUpdate
该 方法 使用方式为 BackgroundAudioManager.onTimeUpdate(function listener)
功能说明：监听背景音频播放进度更新事件，只有小程序在前台时会回调。
参数及说明：function listener，背景音频播放进度更新事件的监听函数。
onWaiting
该 方法 使用方式为 BackgroundAudioManager.onWaiting(function listener)
功能说明：监听音频加载中事件。当音频因为数据不足，需要停下来加载时会触发。
参数及说明：function listener，音频加载中事件的监听函数。
pause
该 方法 使用方式为 BackgroundAudioManager.pause()
功能说明：暂停音乐
错误码
错误码
错误信息
说明
10001
-
系统错误
10002
-
网络错误
10003
-
文件错误，请检查是否responseheader是否缺少Content-Length
10004
-
格式错误
-1
-
未知错误
﻿
play
该 方法 使用方式为 BackgroundAudioManager.play()
功能说明：播放音乐。
seek
该 方法 使用方式为 BackgroundAudioManager.seek(number currentTime)
功能说明：跳转到指定位置
参数及说明：number currentTime，跳转的位置，单位 s。精确到小数点后3位，即支持 ms 级别精确度。
错误码
错误码
错误信息
说明
10001
-
系统错误
10002
-
网络错误
10003
-
文件错误，请检查是否 responseheader 是否缺少 Content-Length
10004
-
格式错误
-1
-
未知错误
﻿
stop
该 方法 使用方式为 BackgroundAudioManager.stop()
功能说明：停止音乐
错误码
错误码
错误信息
说明
10001
-
系统错误
10002
-
网络错误
10003
-
文件错误，请检查是否 responseheader 是否缺少 Content-Length
10004
-
格式错误
-1
-
未知错误
﻿
示例代码
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 = 'http://ws.stream.qqmusic.qq.com/M500001VfvsJ21xFqb.mp3?guid=ffffffff82def4af4b12b3cd9337d5e7&uin=346897220&vkey=6292F51E1E384E061FF02C31F716658E5C81F5594D561F2E88B854E81CAAB7806D5E4F103E55D33C16F3FAC506D1AB172DE8600B37E43FAD&fromtag=46'
﻿

属性	类型	默认值	必填	说明
success	function	-	否	接口调用成功的回调函数
fail	function	-	否	接口调用失败的回调函数
complete	function	-	否	接口调用结束的回调函数（调用成功、失败都会执行）

类型	说明
string src	音频的数据源。默认为空字符串，当设置了新的 src 时，会自动开始播放，目前支持的格式有 m4a, aac, mp3, wav
number startTime	音频开始播放的位置，单位：s
string title	音频标题，用于原生音频播放器音频标题（必填）。原生音频播放器中的分享功能，分享出去的卡片标题，也将使用该值
string epname	专辑名，原生音频播放器中的分享功能，分享出去的卡片简介，也将使用该值
string singer	歌手名，原生音频播放器中的分享功能，分享出去的卡片简介，也将使用该值
string coverImgUrl	封面图 URL，用于做原生音频播放器背景图。原生音频播放器中的分享功能，分享出去的卡片配图及背景也将使用该图
string webUrl	页面链接，原生音频播放器中的分享功能，分享出去的卡片简介，也将使用该值
string protocol	音频协议。默认值为 'http'，设置 'hls' 可以支持播放 HLS 协议的直播音频
number playbackRate	播放速度。范围 0.5-2.0，默认为 1（Android 需要 6 及以上版本）
number duration	当前音频的长度（单位：s），只有在有合法 src 时返回（只读）
number currentTime	当前音频的播放位置（单位：s），只有在有合法 src 时返回（只读）
boolean paused	当前是否暂停或停止（只读）
number buffered	音频已缓冲的时间，仅保证当前播放时间点到此时间点内容已缓冲（只读）
string referrerPolicy	origin：发送完整的referrer；no-referrer：不发送。格式固定为 https://servicewechat.com/{appid}/{version}/page-frame.html，其中 {appid} 为小程序的 appid，{version} 为小程序的版本号，版本号为 0 表示为开发版、体验版以及审核版本，版本号为 devtools 表示为开发者工具，其余为正式版本；

错误码	错误信息	说明
10001	-	系统错误
10002	-	网络错误
10003	-	文件错误，请检查是否responseheader是否缺少Content-Length
10004	-	格式错误
-1	-	未知错误

背景音频

本页目录：

stopBackgroundAudio

seekBackgroundAudio

playBackgroundAudio

pauseBackgroundAudio

onBackgroundAudioStop

onBackgroundAudioPlay

onBackgroundAudioPause

getBackgroundAudioPlayerState

getBackgroundAudioManager

BackgroundAudioManager

属性

方法集

示例代码