Audio::TagLib::Ogg::Vorbis::File - An implementation of Ogg::File with Vorbis


Audio-TagLib documentation  | view source Contained in the Audio-TagLib distribution.

Index


NAME

Top

Audio::TagLib::Ogg::Vorbis::File - An implementation of Ogg::File with Vorbis specific methods

SYNOPSIS

Top

  use Audio::TagLib::Ogg::Vorbis::File;

  my $i = Audio::TagLib::Ogg::Vorbis::File->new("sample vorblis file.ogg");
  print $i->tag()->comment()->toCString(), "\n"; # got comment

DESCRIPTION

Top

This is the central class in the Ogg Vorbis metadata processing collection of classes. It's built upon Ogg::File which handles processing of the Ogg logical bitstream and breaking it down into pages which are handled by the codec implementations, in this case Vorbis specifically.

new(PV $file, BOOL $readProperties = TRUE, PV $propertiesStyle = "Average")

Contructs a Vorbis file from $file. If $readProperties is true the file's audio properties will also be read using $propertiesStyle. If false, $propertiesStyle is ignored.

DESTROY()

Destroys this instance of the File.

Ogg::XiphComment tag()

Returns the XiphComment for this file. XiphComment implements the tag interface, so this serves as the reimplementation of Audio::TagLib::File::tag().

Properties audioProperties()

Returns the Vorbis::Properties for this file. If no audio properties were read then this will return undef.

BOOL save()

Saves the File.

EXPORT

None by default.

SEE ALSO

Top

Audio::TagLib Ogg::File

AUTHOR

Top

Dongxu Ma, <dongxu@cpan.org>

COPYRIGHT AND LICENSE

Top


Audio-TagLib documentation  | view source Contained in the Audio-TagLib distribution.