.\" 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 "Audio::File::Tag 3pm"
.TH Audio::File::Tag 3pm "2021-01-05" "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"
Audio::File::Tag \- abstracts the tag of an audio file
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Audio::File::Tag is the base class for other file format independent tag classes
like Audio::File::Flac::Tag or Audio::File::Ogg::Tag. You shouldn't use this
class yourself except if you're writing your own file format dependent subclass.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
Constructor. Creates a new Audio::File::Tag object. You shouldn't use this
method yourself. It is called by the filetype-dependant subclasses of
Audio::File::Type automatically.
.SS "init"
.IX Subsection "init"
Initializes the object. It's called by the constructor and empty by default.
It's ought to be overwritten by subclasses.
.SS "title"
.IX Subsection "title"
Using \fBtitle()\fR you can get or set the tags title field. If called without any
argument it'll return the current content of the title field. If you call
\&\fBtitle()\fR with an scalar argument it will set the title field to what the argument
contains. The methods \fBartist()\fR, \fBalbum()\fR, \fBcomment()\fR, \fBgenre()\fR, \fByear()\fR, \fBtrack()\fR, \fBdisc()\fR
and \fBtotal()\fR are called in the same way.
.SS "artist"
.IX Subsection "artist"
Set/get the artist field in the files tag.
.SS "album"
.IX Subsection "album"
Set/get the album field in the files tag.
.SS "comment"
.IX Subsection "comment"
Set/get the comment field in the files tag.
.SS "genre"
.IX Subsection "genre"
Set/get the genre field in the files tag.
.SS "year"
.IX Subsection "year"
Set/get the year field in the files tag.
.SS "track"
.IX Subsection "track"
Set/get the track field in the files tag.
.SS "disc"
.IX Subsection "disc"
Set/get the disc field in the files tag.
.SS "total"
.IX Subsection "total"
Set/get the total number of tracks.
.SS "all"
.IX Subsection "all"
Set/get all tags. To set the tags pass a hash reference with the names of the
tags as keys and the tag values as hash values. Returns a hash reference if no
argument is specified.
.SS "is_empty"
.IX Subsection "is_empty"
Returns whether all tag fields are empty or not.
.SS "save"
.IX Subsection "save"
Saves the changed tag information. Not yet implemented.
.SH "TODO"
.IX Header "TODO"
.IP "Implement writing tags" 4
.IX Item "Implement writing tags"
.SH "AUTHOR"
.IX Header "AUTHOR"
Florian Ragwitz <flora@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) Florian Ragwitz
.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.
.PP
This program is distributed in the hope that it will be useful,
but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0  See the
\&\s-1GNU\s0 Library General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place \- Suite 330, Boston, \s-1MA 02111\-1307, USA.\s0