微信小程序API 背景音頻·BackgroundAudioManager實(shí)例

BackgroundAudioManager

BackgroundAudioManager 實(shí)例，可通過 wx.getBackgroundAudioManager 獲取。

屬性

string src

音頻的數(shù)據(jù)源（2.2.3 開始支持云文件ID）。默認(rèn)為空字符串，當(dāng)設(shè)置了新的 src 時，會自動開始播放，目前支持的格式有 m4a, aac, mp3, wav。

number startTime

音頻開始播放的位置（單位：s）。

string title

音頻標(biāo)題，用于原生音頻播放器音頻標(biāo)題（必填）。原生音頻播放器中的分享功能，分享出去的卡片標(biāo)題，也將使用該值。

string epname

專輯名，原生音頻播放器中的分享功能，分享出去的卡片簡介，也將使用該值。

string singer

歌手名，原生音頻播放器中的分享功能，分享出去的卡片簡介，也將使用該值。

string coverImgUrl

封面圖 URL，用于做原生音頻播放器背景圖。原生音頻播放器中的分享功能，分享出去的卡片配圖及背景也將使用該圖。

string webUrl

頁面鏈接，原生音頻播放器中的分享功能，分享出去的卡片簡介，也將使用該值。

string protocol

基礎(chǔ)庫 1.9.94 開始支持，低版本需做兼容處理。

音頻協(xié)議。默認(rèn)值為 'http'，設(shè)置 'hls' 可以支持播放 HLS 協(xié)議的直播音頻。

number playbackRate

基礎(chǔ)庫 2.11.0 開始支持，低版本需做兼容處理。

播放速度。范圍 0.5-2.0，默認(rèn)為 1。（Android 需要 6 及以上版本）

number duration

當(dāng)前音頻的長度（單位：s），只有在有合法 src 時返回。（只讀）

number currentTime

當(dāng)前音頻的播放位置（單位：s），只有在有合法 src 時返回。（只讀）

boolean paused

當(dāng)前是否暫?；蛲Ｖ?。（只讀）

number buffered

音頻已緩沖的時間，僅保證當(dāng)前播放時間點(diǎn)到此時間點(diǎn)內(nèi)容已緩沖。（只讀）

---

方法:

BackgroundAudioManager.onCanplay(function callback)

監(jiān)聽背景音頻進(jìn)入可播放狀態(tài)事件。 但不保證后面可以流暢播放

參數(shù)

function callback

背景音頻進(jìn)入可播放狀態(tài)事件的回調(diào)函數(shù)

BackgroundAudioManager.onEnded(function callback)

監(jiān)聽背景音頻自然播放結(jié)束事件

參數(shù)

function callback

背景音頻自然播放結(jié)束事件的回調(diào)函數(shù)

BackgroundAudioManager.onError(function callback)

監(jiān)聽背景音頻播放錯誤事件

參數(shù)

function callback

背景音頻播放錯誤事件的回調(diào)函數(shù)

BackgroundAudioManager.onNext(function callback)

監(jiān)聽用戶在系統(tǒng)音樂播放面板點(diǎn)擊下一曲事件（僅iOS）

參數(shù)

function callback

用戶在系統(tǒng)音樂播放面板點(diǎn)擊下一曲事件的回調(diào)函數(shù)

BackgroundAudioManager.onPause(function callback)

監(jiān)聽背景音頻暫停事件

參數(shù)

function callback

背景音頻暫停事件的回調(diào)函數(shù)

BackgroundAudioManager.onPlay(function callback)

監(jiān)聽背景音頻播放事件

參數(shù)

function callback

背景音頻播放事件的回調(diào)函數(shù)

BackgroundAudioManager.onPrev(function callback)

監(jiān)聽用戶在系統(tǒng)音樂播放面板點(diǎn)擊上一曲事件（僅iOS）

參數(shù)

function callback

用戶在系統(tǒng)音樂播放面板點(diǎn)擊上一曲事件的回調(diào)函數(shù)

BackgroundAudioManager.onSeeked(function callback)

監(jiān)聽背景音頻完成跳轉(zhuǎn)操作事件

參數(shù)

function callback

背景音頻完成跳轉(zhuǎn)操作事件的回調(diào)函數(shù)

BackgroundAudioManager.onSeeking(function callback)

監(jiān)聽背景音頻開始跳轉(zhuǎn)操作事件

參數(shù)

function callback

背景音頻開始跳轉(zhuǎn)操作事件的回調(diào)函數(shù)

BackgroundAudioManager.onStop(function callback)

監(jiān)聽背景音頻停止事件

參數(shù)

function callback

背景音頻停止事件的回調(diào)函數(shù)

BackgroundAudioManager.onTimeUpdate(function callback)

監(jiān)聽背景音頻播放進(jìn)度更新事件，只有小程序在前臺時會回調(diào)。

參數(shù)

function callback

背景音頻播放進(jìn)度更新事件的回調(diào)函數(shù)

BackgroundAudioManager.onWaiting(function callback)

監(jiān)聽音頻加載中事件。當(dāng)音頻因?yàn)閿?shù)據(jù)不足，需要停下來加載時會觸發(fā)

參數(shù)

function callback

音頻加載中事件的回調(diào)函數(shù)

BackgroundAudioManager.pause()

暫停音樂

錯誤

錯誤碼	錯誤信息	說明
10001		系統(tǒng)錯誤
10002		網(wǎng)絡(luò)錯誤
10003		文件錯誤
10004		格式錯誤
-1		未知錯誤

BackgroundAudioManager.play()

播放音樂

錯誤

錯誤碼	錯誤信息	說明
10001		系統(tǒng)錯誤
10002		網(wǎng)絡(luò)錯誤
10003		文件錯誤
10004		格式錯誤
-1		未知錯誤

BackgroundAudioManager.seek(number currentTime)

跳轉(zhuǎn)到指定位置

參數(shù)

number currentTime

跳轉(zhuǎn)的位置，單位 s。精確到小數(shù)點(diǎn)后 3 位，即支持 ms 級別精確度

錯誤

錯誤碼	錯誤信息	說明
10001		系統(tǒng)錯誤
10002		網(wǎng)絡(luò)錯誤
10003		文件錯誤
10004		格式錯誤
-1		未知錯誤

BackgroundAudioManager.stop()

停止音樂

錯誤

錯誤碼	錯誤信息	說明
10001		系統(tǒng)錯誤
10002		網(wǎng)絡(luò)錯誤
10003		文件錯誤
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'
// 設(shè)置了 src 之后會自動播放
backgroundAudioManager.src = 'http://ws.stream.qqmusic.qq.com/M500001VfvsJ21xFqb.mp3?guid=ffffffff82def4af4b12b3cd9337d5e7&uin=346897220&vkey=6292F51E1E384E061FF02C31F716658E5C81F5594D561F2E88B854E81CAAB7806D5E4F103E55D33C16F3FAC506D1AB172DE8600B37E43FAD&fromtag=46'