https://github.com/wcoder/muzus
:notes: New conception of audio player for web.
https://github.com/wcoder/muzus
audio-player hacktoberfest javascript player pure-javascript webaudio webplayer
Last synced: about 1 month ago
JSON representation
:notes: New conception of audio player for web.
- Host: GitHub
- URL: https://github.com/wcoder/muzus
- Owner: wcoder
- License: mit
- Created: 2017-06-16T20:29:52.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-10-25T18:22:26.000Z (almost 2 years ago)
- Last Synced: 2025-08-24T15:29:05.572Z (about 1 month ago)
- Topics: audio-player, hacktoberfest, javascript, player, pure-javascript, webaudio, webplayer
- Language: JavaScript
- Homepage: https://wcoder.github.io/muzus/
- Size: 133 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
New conception of audio player for web.
## Setup
```html
```
### Available in NPM
```
npm install muzus
```
#### Getting the library from CDN
```html
```
```html
```
## Basic Usage
Each link with `href` attribute and parent element class `muzus` automatically becomes a player for the linked MP3.
### Single track
```html
```
### Playlists
```html
Track name 1
Track name 2
Track name 3
```
Check [muzus/example/index.html](https://github.com/wcoder/muzus/blob/master/example/index.html) to see more examples of usage.
## Advanced Features
### data-attributes
Adding some data-attributes changes the behavior or appearance of the player.
Attribute_Name | Type | Default value | Description
-------------- |:--:|:--:| --
`data-repeat` | `boolean` | `false` | Applied to a element with class `muzus`. Defines whether to repeat the playback after the last track is finished.
### Preload options of script
Adding in `` your page, if you need setup player before initialize. Define in global object `Muzus`. [[Example]](https://github.com/wcoder/muzus/blob/master/example/index.html#L21)
Option | Type | Default Value | Description
-- | -- | -- | --
`autoInit` | `boolean` | `true` | Defines automatically initialize player after page loaded.
`isMobile` | `function` | + | Defines custom function for check is mobile device use.
## Development
### Gulp
Install `gulp-cli`:
```
npm install --global gulp-cli
```
Restore development dependencies:
```
npm i --only=dev
```
### SCSS
Compiling:
```
gulp build:sass
```
Auto-compiling:
```
gulp sass:watch
```
### Run example
```
npm run dev
```
## License
© 2017 Yauheni Pakala | [MIT License](https://github.com/wcoder/muzus/blob/master/LICENSE)