# lc-lyric-parser

> A simple and easy-to-use lyric parser.

Latest version **1.0.0** (published 2017-07-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install lc-lyric-parser
pnpm add lc-lyric-parser
yarn add lc-lyric-parser
bun add lc-lyric-parser
```

## 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 | 2017-07-12 |
| First published | 2017-07-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | JamesYin |
| Maintainers | elantion |
| Keywords | lyric, parser |

## Links

- npm: https://www.npmjs.com/package/lc-lyric-parser
- Repository: https://github.com/lazycoffee/lc-lyric-parser
- Homepage: https://github.com/lazycoffee/lc-lyric-parser#readme
- Issues: https://github.com/lazycoffee/lc-lyric-parser/issues
- npm.io page: https://npm.io/package/lc-lyric-parser

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2017-07-12

## README

# [lc-lyric-parser](https://lazycoffee.github.io/lc-lyric-parser)
A simple and easy-to-use lyric parser.

## Install

```bash
npm i lc-lyric-parser --save
```

## Usage
```lc-lyric-parser``` follow LRC format stander.
### Example
```javascript
const LyricParser = require('lc-lyric-parser');
let audio = new Audio();
// you should use ajax to get lyricString instead
let lyricString = `
[ti:会呼吸的痛]
[ar:梁静茹]
[al:崇拜]
[by:Creator]
[00:13.03]Lyric Creator
[01:53.90][00:00.61]
[04:20.51][01:54.84][00:02.30]梁静茹-会呼吸的痛
[00:05.86]作词：姚若龙 作曲：宇恒
[00:08.66]编曲：黄中岳/安栋
[04:26.99][01:47.93]专辑：崇拜
`;
let lyricParser = new LyricParser(lyricString);
lyricParser.lines.forEach(function(line){
    // add line to your document
});
lyricParser.handler = function(line){
    // switch lyric line by line.index
};
audio.addEventListener('play', function () {
    if(lyricParser && lyricParser.hasTimeLine){
        lyricParser.play(audio.currentTime);
    }
});
audio.addEventListener('pause', function () {
    if(lyricParser && lyricParser.hasTimeLine){
        lyricParser.pause();
    }
});
audio.play();
```
## API
```lc-lyric-parser``` only has few api. I design it as easy and simple.

### play(audioCurrentTime)
```lc-lyric-parser``` just like Audio object. You just need to play it and it will tell you where the current line of lyric. You need to pass a time of current audio play point to tell ```lc-lyric-parser``` where the current time of audio.

### pause()
There is no ```stop``` function. The only way you can stop ```lc-lyric-parser``` is using ```pause``` function.

## Property
```lc-lyric-parser``` supply some useful properties.

### lines
```lc-lyric-parser``` will parse lyric string and push it to ```lines``` property. Each line has these properties:

```
lyricParser.lines.forEach(line){
    // line.index: the index(number) of current line
    // line.time:  the time(number) of current line
    // line.text:  the lyric text (string) of current line
}
```
### isPlaying
If you want to know it weather playing. This property will tell you the status of playing.

## Licence
MIT

---
_Source: https://npm.io/package/lc-lyric-parser · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._