Skip to main content
Version: 3.x

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

PropertyTypeRequiredDescription
dataUrlstringYesThe music's URL. M4a, AAC, MP3, and WAV file formats are supported.
coverImgUrlstringNoCover URL
titlestringNoMusic title
complete(res: any) => voidNoThe callback function used when the API call completed (always executed whether the call succeeds or fails)
fail(res: any) => voidNoThe callback function for a failed API call
success(res: Result) => voidNoThe callback function for a successful API call

Sample Code

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

API Support

APIWeChat Mini-ProgramH5React Native
Taro.playBackgroundAudio✔️