Audio:...e::Type(3pm)

πŸ“¦
version 0.11 Β· 2 versions
  • 0.11 Β· debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking (latest)
  • 0.11 Β· ubuntu jammy
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

πŸ’– Audio::File::Type β€” the vibe check on your audio file's whole identity πŸ’–

Perl-verse bestie, this is a page from the User Contributed Perl Documentation β€” and yes, it's literally about Audio::File::Type, the lil class that represents an audio filetype. πŸŽ€


✨ NAME ✨

Audio::File::Type β€” she represents an audio filetype. That's the whole job. Iconic of her honestly. πŸ’…


🌸 DESCRIPTION 🌸

So here's the tea: when you call the constructor of Audio::File, what you get back is an instance of an object that inherits from Audio::File::Type. πŸ¦‹

Right now this object is out here giving you access to the audio file's info β€” think its audio properties (bitrate, sample rate, number of channels, ...) and the data chillin' in the file's tag. ✨

But bestie, that's not all she could do. Providing access to the raw audio data and other information should be easy to be implemented too. The potential? Immaculate. 🌈


πŸ‘‘ METHODS πŸ‘‘

🫢 new

Constructor. But real talk? You don't need to use it. 🚫

Please use Audio::File instead β€” she'll call the appropriate constructor corresponding to the file's type for you. Let her handle it, she's got main character energy. πŸ’…

🧚 init

This method gets called by the constructor. By default it's just... empty. A blank canvas. 🀍

It should be overwritten by inheriting subclasses so they can initialize themselfes. Do your thing, subclasses. ✨

⭐ name

Returns the name of the audio file. Simple. Slay.

πŸ”₯ 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. Manifesting it for her. πŸ™

πŸ’œ 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. Soon, bestie, soon. πŸŒ™

πŸŽ€ tag

Returns a reference to the file's tag object. 🏷️

Wanna know what that tag object actually does? See the documentation of Audio::File::Tag. Go read her page, she's worth it. πŸ“š

πŸ¦‹ audio_properties

Returns a reference to the file's audio properties object. 🎧

For the full rundown on what that audio properties object does, see the documentation of Audio::File::AudioProperties. πŸ’–

πŸ’€ save

Saves the audio file. 🫠

...except it's not yet implemented but it should remember me to do it at some time.. :-)

Bestie this one is literally a promise note to self. Do not come for her, she knows. 😭

🌟 type

Returns the file's type. Yeah. That's it. She ate and left no crumbs. πŸ‘‘


πŸ™ˆ TODO πŸ™ˆ

  • implement changing the file

🌈 SEE ALSO 🌈

  • Audio::File
  • Audio::File::Tag
  • Audio::File::AudioProperties

πŸ’– AUTHOR πŸ’–

Florian Ragwitz <flora@cpan.org> β€” the original mastermind, we stan. 🫢


Copyright (C) 2004 Florian Ragwitz

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.


And that's the whole page, bestie!! πŸŽ‰ This was perl v5.36.0, dated 2022-11-20, and it's your girl Audio:...e::Type(3pm) signing off. Go read your audio files' minds. πŸ’…βœ¨πŸ¦‹