<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<TITLE>
jala.Mp3.Id3v2
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="jala.Mp3.Id3v2";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary-Mp3.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"--><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<B>Jala 1.3</B>
</EM>
</TD
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="jala.Mp3.Id3v1.html"><B>PREV CLASS</B></A><!--
NEXT CLASS
-->
<A HREF="jala.PodcastWriter.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="jala.Mp3.Id3v2.html" TARGET="_top"><B>NO FRAMES</B></A>
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>Class jala.Mp3.Id3v2</H2>
<PRE>Object
|
+--<b>jala.Mp3.Id3v2</b>
</PRE>
<HR>
<DL>
<!-- Class definition -->
<DT>class
<B>jala.Mp3.Id3v2</B>
</DL>
<P>
<BR/>This class represents an Id3v2 tag.
<BR/><I>Defined in <a href='overview-summary-Mp3.js.html'>Mp3.js</a></I><BR/><BR/>
</P>
<HR>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- ======== END NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- =========== END FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD>
<CODE>
<B>
<A HREF="jala.Mp3.Id3v2.html#jala.Mp3.Id3v2()">jala.Mp3.Id3v2</A>
</B>
(audioObj)
</CODE>
<BR>
Constructs a new Id3v2 tag from an Mp3 file
</TD>
</TR>
</TABLE>
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#copyFrom">copyFrom</A></B>(tag)
</CODE>
<BR>
Copies standard fields from another tag.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> String</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getAlbum">getAlbum</A></B>()
</CODE>
<BR>
Returns the album information of the tag.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> String</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getArtist">getArtist</A></B>()
</CODE>
<BR>
Returns the artist information of the tag.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> <a href="jala.Mp3.html">jala.Mp3</a></CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getAudio">getAudio</A></B>()
</CODE>
<BR>
Returns the wrapper for the underlying audio file.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> String</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getAuthor">getAuthor</A></B>()
</CODE>
<BR>
Returns the author information of the tag.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> String</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getComment">getComment</A></B>()
</CODE>
<BR>
Returns the comment information of the tag.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> String</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getCopyright">getCopyright</A></B>()
</CODE>
<BR>
Returns the copyright information of the tag.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> String</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getGenre">getGenre</A></B>()
</CODE>
<BR>
Returns the genre information of the tag.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> helma.util.MimePart</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getImage">getImage</A></B>(<String> pictureType)
</CODE>
<BR>
Extracts the image from the tag
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> org.farng.mp3.id3.AbstractID3v2</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getJavaObject">getJavaObject</A></B>()
</CODE>
<BR>
returns the java representation of the tag,
class depends on the actual library used.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> String</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getSubtitle">getSubtitle</A></B>()
</CODE>
<BR>
Returns the subtitle information of the tag.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> Number</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getSubtype">getSubtype</A></B>()
</CODE>
<BR>
Returns the version number of this id3v2 (values 2 to 4 for id3v2.2 to id3v2.4)
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> String</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getTextContent">getTextContent</A></B>(idStr)
</CODE>
<BR>
This method can be used to retrieve an arbitrary text frame
of the underlying tag.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> Number</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getTextEncoding">getTextEncoding</A></B>()
</CODE>
<BR>
Returns the text encoding used when setting values.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> String</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getTitle">getTitle</A></B>()
</CODE>
<BR>
Returns the title information of the tag.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> String</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getTrackNumber">getTrackNumber</A></B>()
</CODE>
<BR>
Returns the track number information of the tag.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> String</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getUrl">getUrl</A></B>()
</CODE>
<BR>
Returns the Url stored in this tag
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> String</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#getYear">getYear</A></B>()
</CODE>
<BR>
Returns the year information of the tag.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#removeFromAudio">removeFromAudio</A></B>()
</CODE>
<BR>
Removes the tag from the audio file and
nulls out the wrapper.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setAlbum">setAlbum</A></B>(<String> album)
</CODE>
<BR>
Sets the album information.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setArtist">setArtist</A></B>(<String> artist)
</CODE>
<BR>
Sets the artist information.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setAuthor">setAuthor</A></B>(<String> author)
</CODE>
<BR>
Sets the author information in this tag
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setComment">setComment</A></B>(<String> comment)
</CODE>
<BR>
Sets the comment
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setCopyright">setCopyright</A></B>(<String> copyright)
</CODE>
<BR>
Sets the copyright information in this tag
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setGenre">setGenre</A></B>(<String> genre)
</CODE>
<BR>
Sets the genre information.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setImage">setImage</A></B>(<Number> pictureType, <String> mimeType, <Array> byteArray)
</CODE>
<BR>
adds an image to the file.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setSubtitle">setSubtitle</A></B>(<String> title)
</CODE>
<BR>
Sets the subtitle information
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> String</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setTextContent">setTextContent</A></B>(idStr, val)
</CODE>
<BR>
This method can be used to set an arbitrary field
of the underlying tag.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setTextEncoding">setTextEncoding</A></B>(<Number|String> encType)
</CODE>
<BR>
sets the text encoding used when creating new frames
(the encoding type of old frames can't be changed with
JavaMusicTag)
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setTitle">setTitle</A></B>(<String> title)
</CODE>
<BR>
Sets the title information
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setTrackNumber">setTrackNumber</A></B>(<Number> trackNumber)
</CODE>
<BR>
Sets the track number information.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setUrl">setUrl</A></B>(<String> url, <String> desc)
</CODE>
<BR>
Stores the Url passed as argument in this tag.
</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<FONT SIZE="-1">
<CODE> void</CODE>
</FONT>
</TD>
<TD>
<CODE>
<B>
<A HREF="#setYear">setYear</A></B>(<Number> year)
</CODE>
<BR>
Sets the year information.
</TD>
</TR>
</TABLE>
<P>
<!-- ========== END METHOD SUMMARY =========== -->
<!-- ============ FIELD DETAIL START =========== -->
<!-- ============ FIELD DETAIL END =========== -->
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1>
<FONT SIZE="+2"><B>Constructor Detail</B></FONT>
</TD>
</TR>
</TABLE>
<A NAME="jala.Mp3.Id3v2()"><!-- --></A><H3>
jala.Mp3.Id3v2</H3>
<PRE><B>jala.Mp3.Id3v2</B>(audioObj)</PRE>
<UL>
Constructs a new Id3v2 tag from an Mp3 file
</UL>
<UL>
<B>Parameters:</B>
<UL><CODE>mp3File</CODE> -
</UL>
</UL>
<!-- Constructor return value(s) -->
<!-- End constructor return value(s) -->
<!-- ADDITIONAL ATTRIBUTES -->
<HR/>
<!-- END ADDITIONAL ATTRIBUTES -->
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
<!-- ============ METHOD DETAIL START ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT>
</TD>
</TR>
</TABLE>
<!-- One single method detail entry -->
<A NAME="copyFrom"><!-- --></A>
<H3>copyFrom</H3>
<PRE>void <B>copyFrom</B>(tag)</PRE>
<UL>Copies standard fields from another tag.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>src</CODE> - object with getter methods for fields album, artist, comment, title, trackNumber, genre and year.
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getAlbum"><!-- --></A>
<H3>getAlbum</H3>
<PRE>String <B>getAlbum</B>()</PRE>
<UL>Returns the album information of the tag.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
string containing album name
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getArtist"><!-- --></A>
<H3>getArtist</H3>
<PRE>String <B>getArtist</B>()</PRE>
<UL>Returns the artist information of the tag.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
string containing artist name
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getAudio"><!-- --></A>
<H3>getAudio</H3>
<PRE><a href="jala.Mp3.html">jala.Mp3</a> <B>getAudio</B>()</PRE>
<UL>Returns the wrapper for the underlying audio file.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getAuthor"><!-- --></A>
<H3>getAuthor</H3>
<PRE>String <B>getAuthor</B>()</PRE>
<UL>Returns the author information of the tag.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
string containing author information
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getComment"><!-- --></A>
<H3>getComment</H3>
<PRE>String <B>getComment</B>()</PRE>
<UL>Returns the comment information of the tag.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
string containing comment
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getCopyright"><!-- --></A>
<H3>getCopyright</H3>
<PRE>String <B>getCopyright</B>()</PRE>
<UL>Returns the copyright information of the tag.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The copyright information of the tag
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getGenre"><!-- --></A>
<H3>getGenre</H3>
<PRE>String <B>getGenre</B>()</PRE>
<UL>Returns the genre information of the tag.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
string containing genre name
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getImage"><!-- --></A>
<H3>getImage</H3>
<PRE>helma.util.MimePart <B>getImage</B>(<String> pictureType)</PRE>
<UL>Extracts the image from the tag</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>pictureType</CODE> - number describing picture type (default is 3, describing a front cover).
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
image as mime object
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getJavaObject"><!-- --></A>
<H3>getJavaObject</H3>
<PRE>org.farng.mp3.id3.AbstractID3v2 <B>getJavaObject</B>()</PRE>
<UL>returns the java representation of the tag,
class depends on the actual library used.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getSubtitle"><!-- --></A>
<H3>getSubtitle</H3>
<PRE>String <B>getSubtitle</B>()</PRE>
<UL>Returns the subtitle information of the tag.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
string containing subtitle
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getSubtype"><!-- --></A>
<H3>getSubtype</H3>
<PRE>Number <B>getSubtype</B>()</PRE>
<UL>Returns the version number of this id3v2 (values 2 to 4 for id3v2.2 to id3v2.4)</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The version number of this Id3v2 tag
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getTextContent"><!-- --></A>
<H3>getTextContent</H3>
<PRE>String <B>getTextContent</B>(idStr)</PRE>
<UL>This method can be used to retrieve an arbitrary text frame
of the underlying tag. For the list of valid identifiers
and their meaning see http://www.id3.org/
The identifiers vary across the sub versions of id3v2 tags,
use getSubtype to make sure you use the correct version.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>id</CODE> - Frame identifier according to Id3v2 specification or shortcut as defined in jala.Mp3.FIELD_MAPPING.
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
String contained in the frame
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<UL>
<B>See:</B><UL>- <a href="#getSubtype">getSubtype()</a></UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getTextEncoding"><!-- --></A>
<H3>getTextEncoding</H3>
<PRE>Number <B>getTextEncoding</B>()</PRE>
<UL>Returns the text encoding used when setting values.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The text encoding
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getTitle"><!-- --></A>
<H3>getTitle</H3>
<PRE>String <B>getTitle</B>()</PRE>
<UL>Returns the title information of the tag.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
string containing title
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getTrackNumber"><!-- --></A>
<H3>getTrackNumber</H3>
<PRE>String <B>getTrackNumber</B>()</PRE>
<UL>Returns the track number information of the tag.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
string representing track number
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getUrl"><!-- --></A>
<H3>getUrl</H3>
<PRE>String <B>getUrl</B>()</PRE>
<UL>Returns the Url stored in this tag</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
The url stored in this tag
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="getYear"><!-- --></A>
<H3>getYear</H3>
<PRE>String <B>getYear</B>()</PRE>
<UL>Returns the year information of the tag.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<UL>
<B>Returns:</B>
<UL>
string representing year
</UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="removeFromAudio"><!-- --></A>
<H3>removeFromAudio</H3>
<PRE>void <B>removeFromAudio</B>()</PRE>
<UL>Removes the tag from the audio file and
nulls out the wrapper.</UL>
<!-- METHOD PARAMETERS START -->
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setAlbum"><!-- --></A>
<H3>setAlbum</H3>
<PRE>void <B>setAlbum</B>(<String> album)</PRE>
<UL>Sets the album information.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>album</CODE> -
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setArtist"><!-- --></A>
<H3>setArtist</H3>
<PRE>void <B>setArtist</B>(<String> artist)</PRE>
<UL>Sets the artist information.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>artist</CODE> -
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setAuthor"><!-- --></A>
<H3>setAuthor</H3>
<PRE>void <B>setAuthor</B>(<String> author)</PRE>
<UL>Sets the author information in this tag</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>author</CODE> - The author information to set
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setComment"><!-- --></A>
<H3>setComment</H3>
<PRE>void <B>setComment</B>(<String> comment)</PRE>
<UL>Sets the comment</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>comment</CODE> -
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setCopyright"><!-- --></A>
<H3>setCopyright</H3>
<PRE>void <B>setCopyright</B>(<String> copyright)</PRE>
<UL>Sets the copyright information in this tag</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>copyright</CODE> - The copyright information to set
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setGenre"><!-- --></A>
<H3>setGenre</H3>
<PRE>void <B>setGenre</B>(<String> genre)</PRE>
<UL>Sets the genre information. A list of genre names that are compatible
with ID3v1 tags is located in jala.Mp3.GENRES.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>genre</CODE> -
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setImage"><!-- --></A>
<H3>setImage</H3>
<PRE>void <B>setImage</B>(<Number> pictureType, <String> mimeType, <Array> byteArray)</PRE>
<UL>adds an image to the file.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>pictureType</CODE> - number determining picture type
</UL>
<UL><CODE>mimeType</CODE> - mime type of image
</UL>
<UL><CODE>byteArray</CODE> - image binary data
</UL>
<UL><CODE>desc</CODE> - optional description
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<UL>
<B>See:</B><UL>- <a href="jala.Mp3.html#">jala.Mp3</a></UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setSubtitle"><!-- --></A>
<H3>setSubtitle</H3>
<PRE>void <B>setSubtitle</B>(<String> title)</PRE>
<UL>Sets the subtitle information</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>title</CODE> -
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setTextContent"><!-- --></A>
<H3>setTextContent</H3>
<PRE>String <B>setTextContent</B>(idStr, val)</PRE>
<UL>This method can be used to set an arbitrary field
of the underlying tag. For the list of valid identifiers
and their meaning see http://www.id3.org/
The identifiers vary across the sub versions of id3v2 tags,
use getSubtype to make sure you use the correct version.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>id</CODE> - Frame identifier according to Id3v2 specification
</UL>
<UL><CODE>value</CODE> -
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<UL>
<B>See:</B><UL>- <a href="#getSubtype">getSubtype()</a></UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setTextEncoding"><!-- --></A>
<H3>setTextEncoding</H3>
<PRE>void <B>setTextEncoding</B>(<Number|String> encType)</PRE>
<UL>sets the text encoding used when creating new frames
(the encoding type of old frames can't be changed with
JavaMusicTag)</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>encType</CODE> - the new encoding type as number or string
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<UL>
<B>See:</B><UL>- <a href="jala.Mp3.html#!s!TEXT_ENCODINGS">jala.Mp3.TEXT_ENCODINGS</a></UL>
</UL>
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setTitle"><!-- --></A>
<H3>setTitle</H3>
<PRE>void <B>setTitle</B>(<String> title)</PRE>
<UL>Sets the title information</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>title</CODE> -
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setTrackNumber"><!-- --></A>
<H3>setTrackNumber</H3>
<PRE>void <B>setTrackNumber</B>(<Number> trackNumber)</PRE>
<UL>Sets the track number information.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>trackNumber</CODE> -
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setUrl"><!-- --></A>
<H3>setUrl</H3>
<PRE>void <B>setUrl</B>(<String> url, <String> desc)</PRE>
<UL>Stores the Url passed as argument in this tag.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>url</CODE> - The url to store in this tag
</UL>
<UL><CODE>desc</CODE> - An optiona description of the Url
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<A NAME="setYear"><!-- --></A>
<H3>setYear</H3>
<PRE>void <B>setYear</B>(<Number> year)</PRE>
<UL>Sets the year information.</UL>
<!-- METHOD PARAMETERS START -->
<UL>
<B>Parameters:</B>
<UL><CODE>year</CODE> -
</UL>
</UL>
<!-- METHOD PARAMETERS END -->
<!-- ADDITIONAL ATTRIBUTES START -->
<!-- ADDITIONAL ATTRIBUTES END -->
<HR>
<!-- ============ METHOD DETAIL END ========== -->
<!-- ========= END OF CLASS DATA ========= -->
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary-Mp3.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A> </TD>
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<B>Jala 1.3</B>
</EM>
</TD
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="jala.Mp3.Id3v1.html"><B>PREV CLASS</B></A><!--
NEXT CLASS
-->
<A HREF="jala.PodcastWriter.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
<A HREF="jala.Mp3.Id3v2.html" TARGET="_top"><B>NO FRAMES</B></A>
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<FONT SIZE="-1">
</FONT>
<div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Tue Jan 8 15:45:31 2008</div>
</BODY>
</HTML>