3.4.4 • Published 10 months ago

@futuremeng/vue3-wave-audio-player v3.4.4

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

Vue 3 wave-audio-player

Image demo

NPM install

npm i @futuremeng/vue3-wave-audio-player

Import ans use

<template>
  <div style="max-width: 250px">
    <Vue3WaveAudioPlayer
    :wave-width="250"
    :wave-height="40"
    wave-type="mirror"
    src="/samples/file.mp3"
    :index-self="0"
    :index-sync="index"
    @on-play="index = 0"
    title="第一交响曲"
    :wave-animation="false"
    :current-time-visible="false"
    :duration-time-visible="false"
    />  
    <!-- optional wave_options -->
    <Vue3WaveAudioPlayer
    :wave-width="250"
    :wave-height="40"
    :wave-options='{"samples":50}' 
    src="/samples/file.mp3"
    :load-audio-onmount="false"
    :index-self="1"
    :index-sync="index"
    @on-play="index = 1"
    title="第二交响曲"
    :wave-animation="false"
    :current-time-visible="false"
    :duration-time-visible="false"
    />  
    <Vue3WaveAudioPlayer
    :wave-width="250"
    :wave-height="40"
    :wave-options='{"samples":40,"type":"steps","width":192,"height":40}'
    src="/samples/file.mp3"
    :index-self="2"
    :index-sync="index"
    @on-play="index = 2"
    title="第三交响曲"
    :wave-animation="false"
    :current-time-visible="false"
    :duration-time-visible="false"
    />   
  </div>
</template>
<script>
import Vue3WaveAudioPlayer from 'vue3-wave-audio-player'

export default {
  name: 'App',
  components: {
    Vue3WaveAudioPlayer
  },
  data() {
    return {
      index: 0
    }
  }
}
</script>

Attributes

NameRequiredTypeDescription
srcTrueaudio fileSource path to audio file
titleFalseStringTitle of the player
wave-widthTrueIntegerWidth of the Waves. (Not responsive, Also remember that the buttons and the timing strings will take extra ~250px. For example, if(container === 500px) => wave-width = 500 - 250 = 250 )
wave-heightTrueIntegerHeight of the waves (Not Responsive)
wave-typeFalseStringType of wave. (Not working yet)
wave-optionsFalseObjectSet settings for the waves (Not working yet)
load-audio-onmountFalseBooleanLoad the path and audio data on mounted
disable-seekingFalseBooleanDisable time seeking
current-time-visibleFalseBooleanShow current time
duration-time-visibleFalseBooleanShow duration time
index-selfFalseIntegerIndex of the player (for multiple players)
index-syncFalseIntegerIndex of the playing player to sync with (for multiple players)
disable-seekingFalseBooleanDisable seeking
load-audio-onmountFalseBooleanLoad the path and audio data on mounted
circleFalseBooleanShow circle button

Events

I have added all the events that html has in the audio tag with a "on-" prefix. Additional events:

NameRequiredTypeReturnDescription
tried_to_seekFalseFuncBooleanTriggered when user try to seek time
on-playFalseFuncBooleanTriggered when user click on play button
// Example 
<Vue3WaveAudioPlayer
:wave-width="250"
:wave-height="40"
src="/samples/file.mp3"

@on-error="onError"
@on-ended="customCallback" // ... many more
/> 

Check MDN Doc for all the events.

Report bug or Suggestion

please send a mail at futuremeng@gmail.com or imdarif122@mail.com or contact@arifdev.com. You can also open any issue in the GitHub page. Thanks for using this package.

Inspired by

wave-path-audio-player package waveform-path package

3.4.0

10 months ago

3.3.0

10 months ago

3.2.0

10 months ago

3.1.0

10 months ago

3.4.4

10 months ago

3.4.3

10 months ago

3.4.2

10 months ago

3.4.1

10 months ago

3.0.0

10 months ago