SEARCH
NEW RPMS
DIRECTORIES
ABOUT
FAQ
VARIOUS
BLOG
DONATE


YUM REPOSITORY

 
 

MAN page from openSUSE Leap 15 perl-Ogg-Vorbis-Header-PurePerl-1.04-pm151.1.1.noarch.rpm

Ogg::Vorbis::Header::PurePerl

Section: User Contributed Perl Documentation (3)
Updated: 2020-09-07
Index 

NAME

Ogg::Vorbis::Header::PurePerl - access Ogg Vorbis info and comment fields 

SYNOPSIS

        use Ogg::Vorbis::Header::PurePerl;        my $ogg = Ogg::Vorbis::Header::PurePerl->new("song.ogg");        while (my ($k, $v) = each %{$ogg->info}) {                print "$k: $v\n";        }        foreach my $com ($ogg->comment_tags) {                print "$com: $_\n" foreach $ogg->comment($com);        }
 

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 toOgg Vorbis information and comment fields. (NOTE: This module currently supports only read operations).

Unlike Ogg::Vorbis::Header, this module will go ahead and fill in all of theinformation fields as soon as you construct the object. 

CONSTRUCTORS

 

new ($filename)

Opens an Ogg Vorbis file, ensuring that it exists and is actually anOgg Vorbis stream. This method does not actually read any of theinformation or comment fields, and closes the file immediately. 

INSTANCE METHODS

 

info ([$key])

Returns a hashref containing information about the Ogg Vorbis file fromthe 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.

The optional parameter, key, allows you to retrieve a single value fromthe object's hash. Returns "undef" if the key is not found. 

comment_tags ()

Returns an array containing the key values for the comment fields. These values can then be passed to "comment" to retrieve their values. 

comment ($key)

Returns an array of comment values associated with the given key. 

add_comments ($key, $value, [$key, $value, ...])

Unimplemented. 

edit_comment ($key, $value, [$num])

Unimplemented. 

delete_comment ($key, [$num])

Unimplemented. 

clear_comments ([@keys])

Unimplemented. 

write_vorbis ()

Unimplemented. 

path ()

Returns the path/filename of the file the object represents. 

SEE ALSO

Ogg::Vorbis::Decoder - module for decoding Ogg Vorbis files.Requires a C compiler.

Ogg::Vorbis::Header - another module for accessing Ogg Vorbis header info.

Ogg::Vorbis - a perl interface to thelibvorbisfile <http://www.xiph.org/vorbis/doc/vorbisfile/> library,for decoding and manipulating Vorbis audio streams. 

REPOSITORY

<https://github.com/dsully/perl-ogg-vorbis-header-pureperl> 

AUTHOR

Andrew Molloy <amolloyAATTkaizolabs.com>

Dan Sully <daniel | at | cpan.org> 

COPYRIGHT

Copyright (c) 2003, Andrew Molloy. All Rights Reserved.

Copyright (c) 2005-2009, Dan Sully. All Rights Reserved.

This program is free software; you can redistribute it and/or modify itunder the terms of the GNU General Public License as published by theFree Software Foundation; either version 2 of the License, or (atyour option) any later version. A copy of this license is includedwith this module (LICENSE.GPL). 

SEE ALSO

Ogg::Vorbis::Header, Ogg::Vorbis::Decoder


 

Index

NAME
SYNOPSIS
DESCRIPTION
CONSTRUCTORS
new ($filename)
INSTANCE METHODS
info ([$key])
comment_tags ()
comment ($key)
add_comments ($key, $value, [$key, $value, ...])
edit_comment ($key, $value, [$num])
delete_comment ($key, [$num])
clear_comments ([@keys])
write_vorbis ()
path ()
SEE ALSO
REPOSITORY
AUTHOR
COPYRIGHT
SEE ALSO

This document was created byman2html,using the manual pages.