documentation

Documentation generator: JsDoc Toolkit 2.4.0
Template: Wink 1.0
Generated on:

Class wink.mm.LRCReader

Implements a LRC file reader

Class Summary
Constructor Attributes Constructor Name and Description
 
wink.mm.LRCReader(properties)

Method Summary

Class Detail

wink.mm.LRCReader(properties)
Parameters:
{object} properties
The properties object
{string} properties.file
The path to the lyrics file to be read

Field Detail

{string} album
The name of the album
{string} artist
The name of the artist
{string} creator
The creator of the LRC file
{string} editor
The player or editor that creates LRC file
{array} lyricsTab
The lyrics
{string} offset
The overall timestamp adjustment in milliseconds
{string} title
The title of the lyrics
{integer} uId
Unique identifier
{string} version
The version of the program which edited the lyrics

Method Detail

  • {string} getLyric(time)
    Return the current lyric
    Parameters:
    {number} time
    The position of the audio file in millisecond
    Returns:
    {string} The lyrics for this position