# @jswork/next-audio

> Pure audio api for next.

Latest version **1.0.0** (published 2020-11-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @jswork/next-audio
pnpm add @jswork/next-audio
yarn add @jswork/next-audio
bun add @jswork/next-audio
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-11-20 |
| First published | 2020-11-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 11.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | afei |
| Maintainers | afeiship |
| Keywords | next, audio |

## Links

- npm: https://www.npmjs.com/package/@jswork/next-audio
- Homepage: https://github.com/afeiship/next-audio
- npm.io page: https://npm.io/package/@jswork/next-audio

## Dependencies (1)

- [@jswork/next-dom-event](https://npm.io/package/@jswork/next-dom-event.md) ^1.0.1

## Recent versions

- 1.0.0 (latest) — 2020-11-20

## README

# next-audio
> Pure audio api for next.

[![version][version-image]][version-url]
[![license][license-image]][license-url]
[![size][size-image]][size-url]
[![download][download-image]][download-url]

## installation
```bash
npm install -S @jswork/next-audio
```

## status
| code | status  | description                       |
| ---- | ------- | --------------------------------- |
| -1   | error   | 当在音频/视频加载期间发生错误时   |
| 0    | init    | 当音频组件在初始状态              |
| 1    | play    | 当音频/视频已开始或不再暂停时     |
| 2    | pause   | 当音频/视频已暂停时               |
| 3    | loaded  | 当浏览器已加载音频/视频的元数据时 |
| 4    | ended   | 当目前的播放列表已结束时          |
| 5    | canplay | 当浏览器可以播放音频/视频时       |


## method
| api     | member | params      | description                                |
| ------- | ------ | ----------- | ------------------------------------------ |
| play    | method | -           | Play audio                                 |
| pause   | method | -           | Pause audio                                |
| load    | method | -           | Force load audio                           |
| stop    | method | -           | Stop audio                                 |
| seek    | method | (num)       | Set seek by currentTime                    |
| move    | method | (num)       | Set seek percent(0-1)                      |
| destroy | method | (num)       | Destroy from memroy/dom and unload events. |
| prop    | method | (name,args) | Set props(loop/volume/rate/current)        |


## method - prop(name)
| name    | description                |
| ------- | -------------------------- |
| loop    | Set/get loop               |
| volume  | Set/get volume             |
| rate    | Set/get playback rate      |
| current | Set/get play currentTime   |
| muted   | Set/get muted(mute/unmute) |
| ended   | Get if audio is ended      |

## property
| api    | member   | params | description                          |
| ------ | -------- | ------ | ------------------------------------ |
| times  | property | -      | Return rate/current/duration seconds |
| status | property | -      | Get current status.                  |

## usage
```html
<audio id="audio" controls src="http://kolber.github.io/audiojs/demos/mp3/juicy.mp3">
  NOT SUPPORT
</audio>
```

```js
import NxAudio from '@jswork/next-audio';

// code goes here:
const nxAudio = new NxAudio({ element: document.getElementById('audio') });
nxAudio.play();
nxAudio.prop('loop', true);
```

## resources
- https://www.developphp.com/lib/JavaScript/Audio
- http://www.w3school.com.cn/html5/html5_ref_audio_video_dom.asp
- https://www.w3schools.com/tags/ref_av_dom.asp
- https://developer.mozilla.org/en-US/docs/Web/HTML/Element/audio


## license
Code released under [the MIT license](https://github.com/afeiship/next-audio/blob/master/LICENSE.txt).

[version-image]: https://img.shields.io/npm/v/@jswork/next-audio
[version-url]: https://npmjs.org/package/@jswork/next-audio

[license-image]: https://img.shields.io/npm/l/@jswork/next-audio
[license-url]: https://github.com/afeiship/next-audio/blob/master/LICENSE.txt

[size-image]: https://img.shields.io/bundlephobia/minzip/@jswork/next-audio
[size-url]: https://github.com/afeiship/next-audio/blob/master/dist/next-audio.min.js

[download-image]: https://img.shields.io/npm/dm/@jswork/next-audio
[download-url]: https://www.npmjs.com/package/@jswork/next-audio

---
_Source: https://npm.io/package/@jswork/next-audio · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._