MP3::Tag::Utils - Assorted utilities for manipulating MP3 files via MP3::Tag.

Version 0.0.2

    use MP3::Tag::Utils;

    my $foo = MP3::Tag::Utils->new();
    ...

Change the tags on a MP3 file.

The file to operate on.

If this is defined, the tag is set to it.

If this is defined, the tag is set to it.

If this is defined, the tag is set to it.

If this is defined, the tag is set to it.

If this is defined, the tag is set to it.

If this is defined, the tag is set to it.

If this is defined, the tag is set to it.

    $foo->change(\%args);
    if($foo->error){
        warn('Error '.$foo->error.': '.$foo->errorString);
    }

This renames files. s/\//\\/g is used on all the tags to make sure there are no directory issues.

One argument is taken and it is a hash ref.

The returned argument is a hash ref.

This is a array of files to rename.

This is the template to use for renaming a file.

The template keys are listed below.

    {$title}
    {$track}
    {$artist}
    {$album}
    {$comment}
    {$year}
    {$genre}

The default template is.

    {$artist} - {$album} ({$year}) - {$track} - {$title}.mp3

This is a array of failed files.

This pads a the track out to be this wide with zeros. By default is is 2.

To disable this, set it to 0.

This is true if it succeeds.

If it any thing failed, this is set to false.

    my $returned=$foo->rename(\%args);
    if ( $foo->error ||  ){

    }

This returns a string containing a description of all the specified MP3s.

One argument is taken and it is a hash ref.

The returned argument is a hash ref.

This is a array of files to rename.

This is the template to use for renaming a file.

The template keys are listed below.

    {$file}
    {$title}
    {$track}
    {$artist}
    {$album}
    {$comment}
    {$year}
    {$genre}

The default template is.

    File: {$file}
    Artist: {$artist}
    Album: {$album}
    Year: {$year}
    Track: {$track}
    Title: {$title}

This is a array of failed files.

This pads a the track out to be this wide with zeros. By default is is 2.

To disable this, set it to 0.

This is true if it succeeds.

If it any thing failed, this is set to false.

    my $returned=$foo->rename(\%args);
    if ( $foo->error ||  ){

    }

This returns the current error value.

This returns a integer or undefined, Perl boolean value, indicating if a error is present or not and if it is which.

    if($foo->error){
        print "Error Code: ".$foo->error."\n";
    }

This turns the current error string.

    if($foo->errorString ne ''){
        print "Error String: ".$foo->errorString."\n";
    }

This blanks a error, if a permanent error is not set.

This is a internal method and there is no good reason to call it.

No files specified.

The files key does not contain a array.

No changes specified.

Does not appear to be a MP3.

Track is not numeric.

Year is not numeric.

Zane C. Bowers, <vvelox at vvelox.net>

Please report any bugs or feature requests to bug-mp3-tag-utils at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=MP3-Tag-Utils. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

You can find documentation for this module with the perldoc command.

    perldoc MP3::Tag::Utils

You can also look for information at:

* RT: CPAN's request tracker

http://rt.cpan.org/NoAuth/Bugs.html?Dist=MP3-Tag-Utils

* AnnoCPAN: Annotated CPAN documentation

http://annocpan.org/dist/MP3-Tag-Utils

* CPAN Ratings

http://cpanratings.perl.org/d/MP3-Tag-Utils

* Search CPAN

http://search.cpan.org/dist/MP3-Tag-Utils/

Copyright 2010 Zane C. Bowers.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.