aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2017-11-02 10:41:21 +1300
committerTom Ryder <tom@sanctum.geek.nz>2017-11-02 10:41:21 +1300
commita845cd015a000c56035fa930e5579d5b4e810529 (patch)
tree5dbec81cd9d5a80885e2540c1c48dd278c49f99f
parentUpdate Changes for 0.07 (diff)
downloadMusic-Lyrics-LRC-a845cd015a000c56035fa930e5579d5b4e810529.tar.gz
Music-Lyrics-LRC-a845cd015a000c56035fa930e5579d5b4e810529.zip
Regenerate README.markdown for 0.07
-rw-r--r--README.markdown27
1 files changed, 14 insertions, 13 deletions
diff --git a/README.markdown b/README.markdown
index 91432c9..fcaecd7 100644
--- a/README.markdown
+++ b/README.markdown
@@ -4,7 +4,7 @@ Music::Lyrics::LRC - Manipulate LRC karaoke timed lyrics files
# VERSION
-Version 0.05
+Version 0.07
# DESCRIPTION
@@ -35,9 +35,16 @@ For details on the LRC file format, please see Wikipedia:
# SUBROUTINES/METHODS
-## `new()`
+## `new(%opts)`
-Constructor; no arguments.
+Constructor method. Accepts a hash with one attribute `verbose`. This
+specifies whether the module will `warn` explicitly when it cannot parse an
+input line from a file. It defaults to 0.
+
+ my $lrc = MRC::Lyrics::LRC->new();
+ ...
+ my $lrc_verbose = MRC::Lyrics::LRC->new(verbose => 1);
+ ...
## `lyrics()`
@@ -89,16 +96,6 @@ Load lyrics from the given readable filehandle.
Save lyrics to the given writeable filehandle.
-## `ts_to_msec(\%ts)`
-
-Convert the internal LRC timestamp hash structure to milliseconds. You are
-probably not interested in this.
-
-## `msec_to_ts($msec)`
-
-Convert milliseconds to the internal LRC timestamp hash structure. You are
-probably not interested in this, either.
-
# DIAGNOSTICS
- `Bad lyric time`
@@ -169,6 +166,10 @@ may change in future revisions.
The format accepted here is very liberal, and needs to be tested with lots of
different LRC files from the wild.
+Fractional seconds of any length can be parsed, and preserved in the
+millisecond count return by `lyrics()`, but any resolution beyond 2 decimal
+places is lost on `save()`.
+
The test suite is skeletal, and needs a lot of fleshing out.
# AUTHOR