.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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" ''
. ds C`
. ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Ogg::Vorbis::Header::PurePerl 3pm"
.TH Ogg::Vorbis::Header::PurePerl 3pm "2020-12-08" "perl v5.32.0" "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 \- access Ogg Vorbis info and comment fields
.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).
.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.
.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.
.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 "SEE ALSO"
.IX Header "SEE ALSO"
Ogg::Vorbis::Decoder \- module for decoding Ogg Vorbis files.
Requires a C compiler.
.PP
Ogg::Vorbis::Header \- another module for accessing Ogg Vorbis header info.
.PP
Ogg::Vorbis \- a perl interface to the
libvorbisfile library,
for decoding and manipulating Vorbis audio streams.
.SH "REPOSITORY"
.IX Header "REPOSITORY"
.SH "AUTHOR"
.IX Header "AUTHOR"
Andrew Molloy
.PP
Dan Sully
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2003, Andrew Molloy. All Rights Reserved.
.PP
Copyright (c) 2005\-2009, 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.GPL\s0).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Ogg::Vorbis::Header, Ogg::Vorbis::Decoder