# wx-background-audio

**Repository Path**: mengFxing/wx-background-audio

## Basic Information

- **Project Name**: wx-background-audio
- **Description**: 微信背景音乐播放
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-07-31
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# wx-background-audio

#### 介绍
微信背景音乐播放

#### 引用示例
```javascript
  // 直接引用默认实例
  const BackgroundAudio = require('@haoqimao/wx-background-audio')
  // 自定义实例
  const BackgroundAudio = require('@haoqimao/wx-background-audio')
  const BackgroundAudio1 = BackgroundAudio.create({
    key = '', // 当前背景播放唯一标识
    title = '音频', // 音频标题,必填
    startTime = 0, // 音频开始播放的位置（单位：s）
    epname = '', // 专辑名称，分享使用
    singer = '佚名', // 歌手名，分享使用
    coverImgUrl = '', // 封面图 URL，用于做原生音频播放器背景图
    webUrl = '', // 页面链接，原生音频播放器中的分享功能，分享出去的卡片简介，也将使用该值
    protocol = 'http', // 音频协议。默认值为 'http'，设置 'hls' 可以支持播放 HLS 协议的直播音频
  })

```

#### 使用示例
```javascript
const BackgroundAudio from '@haoqimao/wx-background-audio'

// 绑定的事件
const playOn = ()=> {
  return {
    onBeforePlay = null, // 播放回调，非官方回调
    key: rebindKey = null, // 重新绑定key
    onCanplay = null,
    onEnded = null,
    onError = null,
    onNext = null,
    onPause = null,
    onPlay = null,
    onPrev = null,
    onSeeked = null,
    onSeeking = null,
    onStop = null,
    onTimeUpdate = null,
    onWaiting = null,
  }
}

// 播放音乐
BackgroundAudio.play({
  src: this.data.mp3,
  key: this.data.mp3,
  duration: this.data.duration, // 音频的长度（单位：s）
  progress: this.data.progress, // 当前播放进度[0-100]
  ...playOn()
})

// 暂定音乐
BackgroundAudio.pause()

// 绑定事件
BackgroundAudio.on({
  key: this.data.mp3,
  ...this.playOn(),
}).then()

```


#### 暴露属性|方法
|名称|描述|
|---|---|
|duration| 当前音频的长度（单位：s） |
|progress|当前音频的进度 [ 0 - 100 ] |
|currentTime|当前音频的播放位置（单位：s），只有在有合法 src 时返回 |
|src|获取当前播放音频的地址 |
|paused|当前是否暂停或停止 |
|buffered|音频已缓冲的时间<br/>仅保证当前播放时间点到此时间点内容已缓冲 |
|play| 播放音乐 <br />title = '音频', // 音频标题,必填<br />src = '', // 当设置了新的 src 时，会自动开始播放，目前支持的格式有 m4a, aac, mp3, wav。<br />startTime = -1, // 音频开始播放的位置（单位：s）<br />progress = -1, //  音频开始播放的位置（单位：百分比）<br />epname = '', // 专辑名称，分享使用<br />singer = '佚名', // 歌手名，分享使用<br />coverImgUrl = '', // 封面图 URL，用于做原生音频播放器背景图<br />webUrl = '', // 页面链接，原生音频播放器中的分享功能，分享出去的卡片简介，也将使用该值<br />protocol = 'http', // 音频协议。默认值为 'http'，设置 'hls' 可以支持播放 HLS 协议的直播音频<br />key = '', //<br />duration = 0, // 持续时间|
|seek|跳转到指定位置<br/>num: 跳转的位置，单位 s。精确到小数点后 3 位，即支持 ms 级别精确度<br />type: 0:使用百分比跳转；1：使用秒数跳转 |
|stop| 停止音乐 |
|pause| 暂停播放 |
|on| 绑定事件，详情参考 [微信官网](https://developers.weixin.qq.com/miniprogram/dev/api/media/background-audio/BackgroundAudioManager.html) |