wx-audio-manager
微信小程序背景音频 backgroundAudio 封装
Last updated 3 months ago by tinkgu .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install wx-audio-manager 
SYNC missed versions from official npm registry.

wx-audio-manager

全局的微信背景音频管理器,支持 TypeScript

Install

yarn add wx-audio-manager --save

# or

npm i wx-audio-manager -S

Get Start

import { AudioManager } from 'wx-audio-manager';

class App extends Component {
  componentDidMount() {
    // 初始化
    AudioManager.init();
    // 播放
    AudioManager.play({
      src: '',
      startTime: 5, // 音频开始播放的位置(单位:s)。
    });
    // 或
    AudioManager.playSrc('');
  }

  render() {
    return this.props.children;
  }
}

API

AudioManager.init

初始化

AudioManager.get

function get(): AudioManagerInfo 获取当前音频信息

AudioManager.isPlaying

function isPlaying(): boolean

是否正在播放音频

AudioManager.play

function play(am: AudioManagerInfo): void ⏯ 播放音频

AudioManager.play({
  src: '', // 音频地址
  startTime: 5, // 从第几秒开始播放
  duration: 120, // 音频长度,秒。人为设置 duration 仅在未播放时有效,实际播放时展示音频的真实长度
});

AudioManager.playSrc

function playSrc(src: string): void 直接播放音频

AudioManager.seek

function seek(am: AudioManagerInfo): void

⏩ 快进到第几秒,本质也是 AudioManager.play

AudioManager.pause

⏸ 暂停

AudioManager.stop

⏹ 停止播放。停止播放后进行 get 会丢失 src 等信息

AudioManager.stopLater

function stopLater(count: number): void

⏰⏹ 一段时间后再停止播放

AudioManager.on

function on(callbacks: AudiManagerEvents): () => void

type AudioManagerEvents = {
  update: (currentInfo: { data: AudioManagerInfo; evname: string }, lastAm: AudioManagerInfo) => void;
  error: (err: Error) => void;
  srcUpdate: (lastAm: AudioManagerInfo) => void;
};

监听音频事件,返回一个取消监听的 off 方法

const off = AudioManager.on({
  /** src 更换时触发 */
  srcUpdate() {},
  /** 音频播放错误 */
  error(e) {},
  /** audioManager 有任何信息发生变化 */
  update(res) {
    const { data, evname } = res;
    // dosomething
  },
});

Current Tags

  • 1.2.1                                ...           latest (3 months ago)

2 Versions

  • 1.2.1                                ...           3 months ago
  • 1.2.0                                ...           3 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 2
Last Day 0
Last Week 0
Last Month 5
Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2021 © npmmirror.com |