ye-man / lrcplayer

A .lrc runner written in JavaScript (NodeJS) that works like a music player.

LrcPlayer

A .lrc runner written in JavaScript (NodeJS) that works like a music player.

Usage

const fs = require('fs');
const LrcPlayer = require('./lrcplayer');

const lrc = fs.readFileSync('./hey-jude.lrc').toString();

const myPlayer = new LrcPlayer(lrc);
myPlayer.on('lrc', (line) => {
  console.log(line);
});

myPlayer.play();

Documentation

LrcPlayer ⇐ EventEmitter

The .lrc player

Kind: global class

• LrcPlayer
  • new LrcPlayer(lrcFile)
  • .play()
  • .pause()
  • .stop()
  • .jumpTo(newTime)

new LrcPlayer(lrcFile)

Creates a new .lrc player

Param	Type	Description
lrcFile	string	the .lrc file to run

lrcPlayer.play()

Start player

Kind: instance method of LrcPlayer

lrcPlayer.pause()

Pause player

Kind: instance method of LrcPlayer

lrcPlayer.stop()

Stop player

Kind: instance method of LrcPlayer

lrcPlayer.jumpTo(newTime)

Jump to new time

Kind: instance method of LrcPlayer

Param	Type	Description
newTime	string | number	the new time to jump in. In miliseconds or time string (01:20.00)

Events

lrcPlayer.on('lrc', cb(line, time))

Event when player streams lyrics

myPlayer.on('lrc', function(line, time) {
    console.log(line);
});

lrcPlayer.on('play', cb(time))

Event when player starts

myPlayer.on('play', function(time) {
    console.log('Player started at: ' + time);
});

*similar:

lrcPlayer.on('stop', cb(time))

lrcPlayer.on('pause', cb(time))