Package Exports
- vue-audio-better
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vue-audio-better) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
vue-audio-better
Easy to create custom audio player components for Vue.js.
Overview
Installation
npm install vue-audio-better --saveSetup
Bundler (Webpack, Rollup)
// in your entrypoint
import Vue from 'vue'
import VueAudio from 'vue-audio-better'
Vue.use(VueAudio)Usage
Required Markup
<vue-video
:src="https://example.com/some_audio.mp3"
></vue-video>
Props
sources
Type: String[] - Required
An array of audio file urls
html5
Type: Boolean - Default: false
Whether to force HTML5 Audio
loop
Type: Boolean - Default: false
Whether to start the playback again automatically after it is done playing
preload
Type: Boolean - Default: true
Whether to start downloading the audio file when the component is mounted
autoplay
Type: Boolean - Default: false
Whether to start the playback when the component is mounted
formats
Type: String[] - Default: []
Howler.js automatically detects your file format from the extension, but you may also specify a format in situations where extraction won't work (such as with a SoundCloud stream)
xhrWithCredentials
Type: Boolean - Default: false
Whether to enable the withCredentials flag on XHR requests
used to fetch audio files when using Web Audio API (see reference)
Development
Build
Bundle the js to the dist folder:
npm run build