title: Taro.getBackgroundAudioPlayerState(option)

sidebar_label: getBackgroundAudioPlayerState

获取后台音乐播放状态。 注意：1.2.0 版本开始，本接口不再维护。建议使用能力更强的 Taro.getBackgroundAudioManager 接口

支持情况：getBackgroundAudioPlayerState - 图1 getBackgroundAudioPlayerState - 图2 getBackgroundAudioPlayerState - 图3

参考文档

类型

  1. (option?: Option) => Promise<SuccessCallbackResult>

参数

参数 类型
option Option

Option

参数 类型 必填 说明
complete (res: TaroGeneral.CallbackResult) => void 否 接口调用结束的回调函数（调用成功、失败都会执行）
fail (res: TaroGeneral.CallbackResult) => void 否 接口调用失败的回调函数
success (result: SuccessCallbackResult) => void 否 接口调用成功的回调函数

SuccessCallbackResult

参数 类型 说明
currentPosition number 选定音频的播放位置（单位：s），只有在音乐播放中时返回
dataUrl string 歌曲数据链接，只有在音乐播放中时返回
downloadPercent number 音频的下载进度百分比，只有在音乐播放中时返回
duration number 选定音频的长度（单位：s），只有在音乐播放中时返回
status keyof Status 播放状态
errMsg string 调用结果

Status

参数 说明
0 暂停中
1 播放中
2 没有音乐播放

示例代码

  1. Taro.getBackgroundAudioPlayerState({
  2.   success: function (res) {
  3.     var status = res.status
  4.     var dataUrl = res.dataUrl
  5.     var currentPosition = res.currentPosition
  6.     var duration = res.duration
  7.     var downloadPercent = res.downloadPercent
  8.   }
  9. })