Taro.playBackgroundAudio(option)

In WeChat App, only one piece of music can be played at a time in the background player. If the user exits the Mini Program, the music playback stops. If the music player is used by another App, the music playback in the Mini Program stops.

Reference

Type

(option: Option) => Promise<CallbackResult>

Parameters

Option

Property	Type	Required	Description
dataUrl	string	Yes	The music's URL. M4a, AAC, MP3, and WAV file formats are supported.
coverImgUrl	string	No	Cover URL
title	string	No	Music title
complete	(res: any) => void	No	The callback function used when the API call completed (always executed whether the call succeeds or fails)
fail	(res: any) => void	No	The callback function for a failed API call
success	(res: Result) => void	No	The callback function for a successful API call

Sample Code

Taro.playBackgroundAudio({
  dataUrl: '',
  title: '',
  coverImgUrl: ''
})

API Support

API	WeChat Mini-Program	H5	React Native
Taro.playBackgroundAudio	✔️