id3v2header.html

Java MP3 Player, Here s a list of features: - Reads, creates, updates, and removes id3v2.3 and id3

<A NAME="ID3v2Header(java.io.File)"><!-- --></A><H3>
ID3v2Header</H3>
<PRE>
public <B>ID3v2Header</B>(java.io.File&nbsp;mp3)
            throws java.io.FileNotFoundException,
                   java.io.IOException</PRE>
<DL>
<DD>Create an id3v2header linked to the file passed as a parameter.  An
 attempt will be made to read the header from the file.  If a header
 exists, then information in the header will be extracted.  If a header
 doesn't exist, default data will be used.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>mp3</CODE> - the file to attempt to read data from<DT><B>Throws:</B><DD><CODE>java.io.FileNotFoundException</CODE> - if an error occurs<DD><CODE>java.io.IOException</CODE> - if an error occurs</DL>
</DD>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<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>

<A NAME="getBytes()"><!-- --></A><H3>
getBytes</H3>
<PRE>
public byte[] <B>getBytes</B>()</PRE>
<DL>
<DD>Return an array of bytes representing the header.  This can be used
 to easily write the header to a file.<DD><DL>
<DT><B>Returns:</B><DD>a binary representation of this header</DL>
</DD>
</DL>
<HR>

<A NAME="headerExists()"><!-- --></A><H3>
headerExists</H3>
<PRE>
public boolean <B>headerExists</B>()</PRE>
<DL>
<DD>Returns true if a header exists<DD><DL>
<DT><B>Returns:</B><DD>true if a header exists</DL>
</DD>
</DL>
<HR>

<A NAME="getHeaderSize()"><!-- --></A><H3>
getHeaderSize</H3>
<PRE>
public int <B>getHeaderSize</B>()</PRE>
<DL>
<DD>Returns the size (in bytes) of this header.  This is 10 if the header
 exists and 0 otherwise<DD><DL>
<DT><B>Returns:</B><DD>the size of this header</DL>
</DD>
</DL>
<HR>

<A NAME="getTagSize()"><!-- --></A><H3>
getTagSize</H3>
<PRE>
public int <B>getTagSize</B>()</PRE>
<DL>
<DD>Returns the size (in bytes) of the frames and/or extended header portion
 of the id3v2 tag according to the size field in the header.<DD><DL>
<DT><B>Returns:</B><DD>the size field of the header</DL>
</DD>
</DL>
<HR>

<A NAME="setTagSize(int)"><!-- --></A><H3>
setTagSize</H3>
<PRE>
public void <B>setTagSize</B>(int&nbsp;size)</PRE>
<DL>
<DD>Sets the size of the frames and/or extended header.  If this function
 is called, the headerExists function will return true.  This is called
 every time a frame is updated, added, or removed.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>size</CODE> - a value of type 'int'</DL>
</DD>
</DL>
<HR>

<A NAME="getMajorVersion()"><!-- --></A><H3>
getMajorVersion</H3>
<PRE>
public int <B>getMajorVersion</B>()</PRE>
<DL>
<DD>Returns the major version of this id3v2 tag.<DD><DL>
<DT><B>Returns:</B><DD>the major version of this id3v2 tag.</DL>
</DD>
</DL>
<HR>

<A NAME="getMinorVersion()"><!-- --></A><H3>
getMinorVersion</H3>
<PRE>
public int <B>getMinorVersion</B>()</PRE>
<DL>
<DD>Return the minor version/revision of this id3v2 tag.<DD><DL>
<DT><B>Returns:</B><DD>the minor version/revision of this id3v2 tag.</DL>
</DD>
</DL>
<HR>

<A NAME="getUnsynchronisation()"><!-- --></A><H3>
getUnsynchronisation</H3>
<PRE>
public boolean <B>getUnsynchronisation</B>()</PRE>
<DL>
<DD>Returns true if the unsynchronisation bit is set in this header.<DD><DL>
<DT><B>Returns:</B><DD>true if the unsynchronisation bit is set in this header.</DL>
</DD>
</DL>
<HR>

<A NAME="setUnsynchronisation(boolean)"><!-- --></A><H3>
setUnsynchronisation</H3>
<PRE>
public void <B>setUnsynchronisation</B>(boolean&nbsp;unsynch)</PRE>
<DL>
<DD>Set the unsynchronisation flag for this header.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>unsynch</CODE> - the new value of the unsynchronisation flag</DL>
</DD>
</DL>
<HR>

<A NAME="getExtendedHeader()"><!-- --></A><H3>
getExtendedHeader</H3>
<PRE>
public boolean <B>getExtendedHeader</B>()</PRE>
<DL>
<DD>Returns true if this tag has an extended header.<DD><DL>
<DT><B>Returns:</B><DD>true if this tag has an extended header</DL>
</DD>
</DL>
<HR>

<A NAME="setExtendedHeader(boolean)"><!-- --></A><H3>
setExtendedHeader</H3>
<PRE>
public void <B>setExtendedHeader</B>(boolean&nbsp;extend)</PRE>
<DL>
<DD>Set the value of the extended header bit of this header.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>extend</CODE> - the new value of the extended header bit</DL>
</DD>
</DL>
<HR>

<A NAME="getExperimental()"><!-- --></A><H3>
getExperimental</H3>
<PRE>
public boolean <B>getExperimental</B>()</PRE>
<DL>
<DD>Returns true if the experimental bit of this header is set.<DD><DL>
<DT><B>Returns:</B><DD>true if the experimental bit of this header is set</DL>
</DD>
</DL>
<HR>

<A NAME="setExperimental(boolean)"><!-- --></A><H3>
setExperimental</H3>
<PRE>
public void <B>setExperimental</B>(boolean&nbsp;experiment)</PRE>
<DL>
<DD>Set the value of the experimental bit of this header.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>experiment</CODE> - the new value of the experimental bit</DL>
</DD>
</DL>
<HR>

<A NAME="getFooter()"><!-- --></A><H3>
getFooter</H3>
<PRE>
public boolean <B>getFooter</B>()</PRE>
<DL>
<DD>Returns true if this tag has a footer.<DD><DL>
<DT><B>Returns:</B><DD>true if this tag has a footer</DL>
</DD>
</DL>
<HR>

<A NAME="setFooter(boolean)"><!-- --></A><H3>
setFooter</H3>
<PRE>
public void <B>setFooter</B>(boolean&nbsp;foot)</PRE>
<DL>
<DD>Sets the value of the footer bit for this header.<DD><DL>
<DT><B>Parameters:</B><DD><CODE>foot</CODE> - the new value of the footer bit for this header</DL>
</DD>
</DL>
<HR>

<A NAME="toString()"><!-- --></A><H3>
toString</H3>
<PRE>
public java.lang.String <B>toString</B>()</PRE>
<DL>
<DD>Return a string representation of this object.  Contains all information
 contained within.<DD><DL>
<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a string representation of this object</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>

<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../helliker/id3/ID3v2Frames.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../helliker/id3/ID3v2Tag.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>  &nbsp;
&nbsp;<A HREF="ID3v2Header.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->

<HR>

</BODY>
</HTML>