0.0.4 ‱ Published 3 years ago

alice-player v0.0.4

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

AlicePlayer

A beautiful H5 music player built with Vue3. 🍉

This project is under heavy development, APIs might be changed in the feature.

Preview

The coverThe play listThe lyrics
npm.ionpm.ionpm.io

Demo here

Install

Using npm:

npm install alice-player --save

Using Yarn:

yarn add alice-player

Quick Start

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/alice-player@latest/dist/style.css" />
<div id="app"></div>
<script src="https://cdn.jsdelivr.net/npm/vue@next"></script>
<script src="https://cdn.jsdelivr.net/npm/alice-player@latest/dist/alice-player.umd.js"></script>
var playList = [
  {
    audio: 'https://s3-hk.2heng.xin/mstdn/static/alice-player/demo/ćƒ•ă‚‰ăźæ‰‹ă«ăŻäœ•ă‚‚ăȘいけべ゙.mp3',
    cover: 'https://s3-hk.2heng.xin/mstdn/static/alice-player/demo/ćƒ•ă‚‰ăźæ‰‹ă«ăŻäœ•ă‚‚ăȘいけべ゙.jpg',
    lrc: 'https://s3-hk.2heng.xin/mstdn/static/alice-player/demo/ćƒ•ă‚‰ăźæ‰‹ă«ăŻäœ•ă‚‚ăȘいけべ゙.lrc',
    name: 'ćƒ•ă‚‰ăźæ‰‹ă«ăŻäœ•ă‚‚ăȘいけべ゙、',
    artist: 'RAM WIRE',
  },
]

var options = {
  container: '#app',
  preload: 'metadata',
}

var ap = new AlicePlayer(playList, options)

Options

KeyTypeDefaultDescription
containerString'#app'Where we render the player on HTML
autoplayBooleanfalseAuto play audio
preloadString'metadata'HTMLMediaElement.preload
colorStringnullThe default theme color, can also be set in track info object in playList, which will overwrite the global color setting
playModeString'order'Value can be one of order, random, and single
volumeNumber0.7The default volume, range from 0 to 1
storageNameString'alice-player-setting'The key prefix where we save values in cookie

Note: This plugin is still under heavy development, some options doesn't really work now.

TODO

  • Audio buffer progress
  • Media error handling
  • HLS stream support
  • Vue component encapsulation
  • Split vender script file
  • Github Pages build workflow