v-audio-player

0.2.1 • Public • Published

v-audio-player

NPM version npm download jsdelivr license

A audio player vue component based on html5.

Demo

demo

Installation

npm i v-audio-player

Usage

<template>
  <div id="app">
    <v-audio-player :audio="audio" ref="audio"></v-audio-player>
  </div>
</template>
 
<script>
import VAudioPlayer from '../src/index.js'
 
export default {
  data () {
    return {
      audio: {
        name: 'Sometimes When We Touch',
        loop: true,
        url: 'https://fengxianqi.github.io/v-audio-player/dist/media/sometimes_when_we_touch.010fafb2.mp3'
      }
    }
  },
  components: {
    VAudioPlayer
  }
}
</script>

props

audio 属性下:

name Explanation Type Default
url 音频路径 string
name 音频名称 string
autoplay 是否自动播放 bool true
loop 是否循环播放 bool false

Events

暴露一些audio标签默认的常用事件

name Explanation
play 音频开始播放时触发
pause 音频暂停时触发
loadstart 音频开始加载时
progress 音频正在加载时
canplay 音频可以播放时
error 音频加载失败或出现错误时
ended 音频播放结束时触发

Events Example

<template>
  <v-audio-player :audio="audio" @play="onPlay" @ended="onEnded"></v-audio-player>
</template>
<script>
export default {
  data () {
    return {
      audio: {
        name: 'Sometimes When We Touch',
        url: 'https://fengxianqi.github.io/v-audio-player/dist/media/sometimes_when_we_touch.010fafb2.mp3'
      }
    }
  },
  methods: {
    onPlay (e) {
      console.log('onplay', e)
    },
    onEnded (e) {
      console.log('this audio play ended', e)
    }
  }
}
</script>

Methods

可以通过ref来调用音频的方法,如

<v-audio-player :audio="audio" ref="audio"></v-audio-player>
name Explanation
this.$refs.audio.play() 播放音频
this.$refs.audio.pause() 暂停音频
this.$refs.audio.volume() 获取或设置音频的音量,设置时的值范围是:0~1
this.$refs.audio.seek(seconds) 跳到指定时间开始播放,单位:秒
this.$refs.audio.currentSrc() 获取当前播放的音频url
this.$refs.audio.duration() 获取当前音频的时长,单位:秒
this.$refs.audio.currentTime 获取当前播放的时间,单位:秒
this.$refs.audio.audioReady 获取当前音频是否已ready
this.$refs.audio.isPlaying 获取当前音频是否正在播放

Readme

Keywords

Package Sidebar

Install

npm i v-audio-player

Weekly Downloads

2

Version

0.2.1

License

MIT

Unpacked Size

4.32 MB

Total Files

21

Last publish

Collaborators

  • fengxianqi