Audio::File::Type(3pm)

Overview

An instance of an object inherited from Audio::File::Type is returned by the constructor of Audio::File. This object currently provides access to the audio files information like its audio properties (bitrate, sample rate, number of channels, ...) and the data stored in the files tag, but also providing access to the raw audio data and other information should be easy to be implemented.

Methods

new

Constructor. In fact you don't need to use it. Please use Audio::File which will call the appropriate constructor corresponding to the files type.

init

This method will be called by the constructor. It's empty by default and should be overwritten by inheriting subclasses to initialize themselfes.

name

Returns the name of the audio file.

is_readable

Checks whether the file is readable or not. At the moment it's only used by the constructor, but it will be more useful with later versions of Audio::File.

is_writeable

Checks whether the file is writeable or not. At the moment you'll probably don't need to call this method, but it'll be more useful as soon as changing the audio file is implemented.

tag

Returns a reference to the files tag object. See the documentation of Audio::File::Tag to learn about what the tag object does.

audio_properties

Returns a reference to the files audio properties object. See the documentation of Audio::File::AudioProperties to get information about what the audio properties object does.

save

Saves the audio file. This is not yet implemented but it should remember me to do it at some time.. :-)

type

Returns the files type.

Todo

implement changing the file

Copyright and license

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Releases

11 releases since Debian 3.1 (Sarge); the text changed 5 times.