.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "PurePerl 3pm"
.TH PurePerl 3pm "2011-09-18" "perl v5.12.4" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Ogg::Vorbis::Header::PurePerl \- An object\-oriented interface to Ogg Vorbis
information and comment fields, implemented entirely in Perl.  Intended to be 
a drop in replacement for Ogg::Vobis::Header.
.PP
Unlike Ogg::Vorbis::Header, this module will go ahead and fill in all of the
information fields as soon as you construct the object.  In other words,
the "new" and "load" constructors have identical behavior.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 8
\&        use Ogg::Vorbis::Header::PurePerl;
\&        my $ogg = Ogg::Vorbis::Header::PurePerl\->new("song.ogg");
\&        while (my ($k, $v) = each %{$ogg\->info}) {
\&                print "$k: $v\en";
\&        }
\&        foreach my $com ($ogg\->comment_tags) {
\&                print "$com: $_\en" foreach $ogg\->comment($com);
\&        }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is intended to be a drop in replacement for Ogg::Vorbis::Header,
implemented entirely in Perl.  It provides an object-oriented interface to
Ogg Vorbis information and comment fields.  (\s-1NOTE:\s0 This module currently 
supports only read operations).
.SH "CONSTRUCTORS"
.IX Header "CONSTRUCTORS"
.ie n .SS """new ($filename)"""
.el .SS "\f(CWnew ($filename)\fP"
.IX Subsection "new ($filename)"
Opens an Ogg Vorbis file, ensuring that it exists and is actually an
Ogg Vorbis stream.  This method does not actually read any of the
information or comment fields, and closes the file immediately.
.ie n .SS """load ([$filename])"""
.el .SS "\f(CWload ([$filename])\fP"
.IX Subsection "load ([$filename])"
Opens an Ogg Vorbis file, ensuring that it exists and is actually an
Ogg Vorbis stream, then loads the information and comment fields.  This
method can also be used without a filename to load the information
and fields of an already constructed instance.
.SH "INSTANCE METHODS"
.IX Header "INSTANCE METHODS"
.ie n .SS """info ([$key])"""
.el .SS "\f(CWinfo ([$key])\fP"
.IX Subsection "info ([$key])"
Returns a hashref containing information about the Ogg Vorbis file from
the file's information header.  Hash fields are: version, channels, rate,
bitrate_upper, bitrate_nominal, bitrate_lower, bitrate_window, and length.
The bitrate_window value is not currently used by the vorbis codec, and 
will always be \-1.
.PP
The optional parameter, key, allows you to retrieve a single value from
the object's hash.  Returns \f(CW\*(C`undef\*(C'\fR if the key is not found.
.ie n .SS """comment_tags ()"""
.el .SS "\f(CWcomment_tags ()\fP"
.IX Subsection "comment_tags ()"
Returns an array containing the key values for the comment fields. 
These values can then be passed to \f(CW\*(C`comment\*(C'\fR to retrieve their values.
.ie n .SS """comment ($key)"""
.el .SS "\f(CWcomment ($key)\fP"
.IX Subsection "comment ($key)"
Returns an array of comment values associated with the given key.
.ie n .SS """add_comments ($key, $value, [$key, $value, ...])"""
.el .SS "\f(CWadd_comments ($key, $value, [$key, $value, ...])\fP"
.IX Subsection "add_comments ($key, $value, [$key, $value, ...])"
Unimplemented.
.ie n .SS """edit_comment ($key, $value, [$num])"""
.el .SS "\f(CWedit_comment ($key, $value, [$num])\fP"
.IX Subsection "edit_comment ($key, $value, [$num])"
Unimplemented.
.ie n .SS """delete_comment ($key, [$num])"""
.el .SS "\f(CWdelete_comment ($key, [$num])\fP"
.IX Subsection "delete_comment ($key, [$num])"
Unimplemented.
.ie n .SS """clear_comments ([@keys])"""
.el .SS "\f(CWclear_comments ([@keys])\fP"
.IX Subsection "clear_comments ([@keys])"
Unimplemented.
.ie n .SS """write_vorbis ()"""
.el .SS "\f(CWwrite_vorbis ()\fP"
.IX Subsection "write_vorbis ()"
Unimplemented.
.ie n .SS """path ()"""
.el .SS "\f(CWpath ()\fP"
.IX Subsection "path ()"
Returns the path/filename of the file the object represents.
.SH "AUTHOR"
.IX Header "AUTHOR"
Andrew Molloy <amolloy@kaizolabs.com>
.PP
Dan Sully <daniel | at | cpan.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2003, Andrew Molloy.  All Rights Reserved.
.PP
Copyright (c) 2005\-2008, Dan Sully.  All Rights Reserved.
.PP
This program is free software; you can redistribute it and/or modify it
under the terms of the \s-1GNU\s0 General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at
your option) any later version.  A copy of this license is included
with this module (\s-1LICENSE\s0.GPL).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Ogg::Vorbis::Header, Ogg::Vorbis::Decoder