Skip to content

lyswhut/lrc-file-parser

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Apr 23, 2023
d0fd167 · Apr 23, 2023
Oct 28, 2022
Apr 23, 2023
Apr 23, 2023
Apr 23, 2023
Apr 23, 2023
Sep 7, 2018
Apr 23, 2023
Sep 7, 2018
Apr 23, 2023
Apr 23, 2023
Apr 23, 2023
Sep 7, 2018
Apr 23, 2023
Apr 23, 2023
Apr 23, 2023
Apr 23, 2023
Apr 23, 2023
Apr 23, 2023

Repository files navigation

lrc-file-parser

A lrc file parser based javascript

demo

Installation

  • Use npm install
# install
npm install lrc-file-parser
// import
import Lyric from 'lrc-file-parser'
  • Use script link
<script src="./lrc-file-parser.min.js"></script>

How to use

var lrc = new Lyric({
  onPlay: function (line, text) { // Listening play event
    console.log(line, text) // line is line number of current play
                            // text is lyric text of current play line
  },
  onSetLyric: function (lines) { // listening lyrics seting event
    console.log(lines) // lines is array of all lyric text
  },
  offset: 150, // offset time(ms), default is 150 ms
  playbackRate: 1, // playback rate, default is 1
  isRemoveBlankLine: true // is remove blank line, default is true
})

var extendedLyricStrs = [translationLyricStr]
lrc.setLyric(lyricStr, extendedLyricStrs) // set lyric, lyricStr is lyric file text, extendedLyricStrs is extended lyric file text array (optional)
                      // note: Setting the lyrics will automatically pause the lyrics playback
lrc.play(30000) // play lyric, 30000 is curent play time, unit: ms
lrc.pause() // pause lyric

lrc.setPlaybackRate(1.2) // set playback rate to 1.2x

CHANGELOG

See CHANGELOG.md

LICENSE

MIT