背景音频

stopBackgroundAudio

TIP

該API使用方法為： wx.stopBackgroundAudio(Object object)

• 功能說明： 停止播放音樂。
• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

seekBackgroundAudio

TIP

該API使用方法為： wx.seekBackgroundAudio(Object object)

• 功能說明： 控制音樂播放進度。

• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  position	number	-	是	音樂位置，單位：秒
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

• 示例代碼：

wx.seekBackgroundAudio({  
    position: 30
})

playBackgroundAudio

TIP

該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

TIP

該API使用方法為： wx.pauseBackgroundAudio(Object object)

• 功能說明： 暫停播放音樂。
• 參數及說明： Object object

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

onBackgroundAudioStop

TIP

該API使用方法為： wx.onBackgroundAudioStop(function listener)

• 功能說明： 監聽音樂停止事件。
• 參數及說明： function listener，音樂停止事件的監聽函數。

onBackgroundAudioPlay

TIP

該API使用方法為： wx.onBackgroundAudioPlay(function listener)

• 功能說明： 監聽音樂播放事件。
• 參數及說明： function listener，音樂播放事件的監聽函數。

onBackgroundAudioPause

TIP

該API使用方法為： wx.onBackgroundAudioPause(function listener)

• 功能說明： 監聽音樂暫停事件。
• 參數及說明： function listener，音樂暫停事件的監聽函數。

getBackgroundAudioPlayerState

TIP

該API使用方法為： wx.getBackgroundAudioPlayerState(Object object)

• 功能說明： 獲取後臺音樂播放狀態。

• 參數及說明： Object object。

  内容	類型	預設值	必填	說明
  success	Function	-	否	接口調用成功的回呼函數
  fail	Function	-	否	接口調用失敗的回呼函數
  complete	Function	-	否	接口調用結束的回呼函數（無論成功與否都執行）

• object.success回呼函數參數： Object res。

  内容	類型	說明
  duration	number	選定音訊的長度（單位： s）， 只有在音樂播放中時返回
  currentPosition	number	選定音訊的播放位置（單位： s）， 只有在音樂播放中時返回
  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	音訊已緩衝的時間，僅保證當前播放時間點到此時間點內容已緩衝（只讀）

方法集

onCanplay

TIP

該API使用方法為： BackgroundAudioManager.onCanplay(function listener)

• 功能說明： 監聽背景音频進入可播放狀態事件。 但不保證後面可以流暢播放。
• 參數及說明： function listener，背景音频進入可播放狀態事件的監聽函數。

onEnded

TIP

該API使用方法為： BackgroundAudioManager.onEnded(function listener)

• 功能說明： 監聽背景音频自然播放結束事件。
• 參數及說明： function listener，背景音频自然播放結束事件的監聽函數。

onError

TIP

該API使用方法為： BackgroundAudioManager.onError(function listener)

• 功能說明： 監聽背景音频播放錯誤事件。
• 參數及說明： function listener，背景音频播放錯誤事件的監聽函數。

onNext

TIP

該API使用方法為： BackgroundAudioManager.onNext(function listener)

• 功能說明： 監聽用戶在系統音樂播放面板點擊下一曲事件（僅iOS）。
• 參數及說明： function listener，用戶在系統音樂播放面板點擊下一曲事件的監聽函數。

onPause

TIP

該API使用方法為： BackgroundAudioManager.onPause(function listener)

• 功能說明： 監聽背景音频暫停事件。
• 參數及說明： function listener，背景音频暫停事件的監聽函數。

onPlay

TIP

該API使用方法為： BackgroundAudioManager.onPlay(function listener)

• 功能說明： 監聽背景音频播放事件。
• 參數及說明： function listener，背景音频播放事件的監聽函數。

onPrev

TIP

該API使用方法為： BackgroundAudioManager.onPrev(function listener)

• 功能說明： 監聽用戶在系統音樂播放面板點擊上一曲事件（僅iOS）。
• 參數及說明： function listener，用戶在系統音樂播放面板點擊上一曲事件的監聽函數。

onSeeked

TIP

該API使用方法為： BackgroundAudioManager.onSeeked(function listener)

• 功能說明： 監聽背景音频完成跳轉操作事件。
• 參數及說明： function listener，背景音频完成跳轉操作事件的監聽函數。

onSeeking

TIP

該API使用方法為： BackgroundAudioManager.onSeeking(function listener)

• 功能說明： 監聽背景音频開始跳轉操作事件。
• 參數及說明： function listener，背景音频開始跳轉操作事件的監聽函數。

onStop

TIP

該API使用方法為： BackgroundAudioManager.onStop(function listener)

• 功能說明： 監聽背景音频停止事件。
• 參數及說明： function listener，背景音频停止事件的監聽函數。

onTimeUpdate

TIP

該API使用方法為： BackgroundAudioManager.onTimeUpdate(function listener)

• 功能說明： 監聽背景音频播放進度更新事件，只有小程序在前臺時會回檔。
• 參數及說明： function listener，背景音频播放進度更新事件的監聽函數。

onWaiting

TIP

該API使用方法為： BackgroundAudioManager.onWaiting(function listener)

• 功能說明： 監聽音訊加載中事件。 當音訊因為數據不足，需要停下來加載時會觸發。
• 參數及說明： function listener，音訊加載中事件的監聽函數。

pause

TIP

該API使用方法為： BackgroundAudioManager.pause()

• 功能說明： 暫停音樂

• 錯誤碼

  錯誤碼	錯誤資訊	說明
  10001	-	系統錯誤
  10002	-	網絡錯誤
  10003	-	文件錯誤，請檢查是否responseheader是否缺少Content-Length
  10004	-	格式錯誤
  -1	-	未知錯誤

play

TIP

該API使用方法為： BackgroundAudioManager.play()

• 功能說明： 播放音樂

seek

TIP

該API使用方法為： BackgroundAudioManager.seek(number currentTime)

• 功能說明： 跳轉到指定位置

• 參數及說明： number currentTime，跳轉的位置，單位s，精確到小數點後3比特，即支持ms級別精確度。

• 錯誤碼

  錯誤碼	錯誤資訊	說明
  10001	-	系統錯誤
  10002	-	網絡錯誤
  10003	-	文件錯誤，請檢查是否responseheader是否缺少Content-Length
  10004	-	格式錯誤
  -1	-	未知錯誤

stop

TIP

該API使用方法為： BackgroundAudioManager.stop()

• 功能說明： 停止音樂

• 錯誤碼

  錯誤碼	錯誤資訊	說明
  10001	-	系統錯誤
  10002	-	網絡錯誤
  10003	-	文件錯誤，請檢查是否responseheader是否缺少Content-Length
  10004	-	格式錯誤
  -1	-	未知錯誤

示例代碼：

const backgroundAudioManager = wx.getBackgroundAudioManager()

backgroundAudioManager.title = 'This Very Moment'
backgroundAudioManager.epname = 'This Very Moment'
backgroundAudioManager.singer = 'Xu Wei'
backgroundAudioManager.coverImgUrl = 'http://y.gtimg.cn/music/photo_new/T002R300x300M000003rsKF44GyaSk.jpg?max_age=2592000'
// After setting the src, it will play automatically.
backgroundAudioManager.src = 'http://ws.stream.qqmusic.qq.com/M500001VfvsJ21xFqb.mp3?guid=ffffffff82def4af4b12b3cd9337d5e7&uin=346897220&vkey=6292F51E1E384E061FF02C31F716658E5C81F5594D561F2E88B854E81CAAB7806D5E4F103E55D33C16F3FAC506D1AB172DE8600B37E43FAD&fromtag=46'