1482 lines
37 KiB
HTML
1482 lines
37 KiB
HTML
|
<!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
|
||
|
|
</TITLE>
|
||
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
||
|
|
</HEAD>
|
||
|
|
<SCRIPT>
|
||
|
|
function asd()
|
||
|
|
{
|
||
|
|
parent.document.title="jala.Mp3";
|
||
|
|
}
|
||
|
|
</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.ListRenderer.ArrayList.html"><B>PREV CLASS</B></A><!--
|
||
|
|
NEXT CLASS
|
||
|
|
-->
|
||
|
|
<A HREF="jala.Mp3.Id3v1.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.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</H2>
|
||
|
|
<PRE>Object
|
||
|
|
|
|
||
|
|
+--<b>jala.Mp3</b>
|
||
|
|
</PRE>
|
||
|
|
|
||
|
|
|
||
|
|
<HR>
|
||
|
|
<DL>
|
||
|
|
<!-- Class definition -->
|
||
|
|
<DT>class
|
||
|
|
<B>jala.Mp3</B>
|
||
|
|
|
||
|
|
|
||
|
|
</DL>
|
||
|
|
|
||
|
|
<P>
|
||
|
|
<BR/>This is a class representing an MP3 file
|
||
|
|
providing methods to access its metadata.
|
||
|
|
|
||
|
|
<BR/><I>Defined in <a href='overview-summary-Mp3.js.html'>Mp3.js</a></I><BR/><BR/>
|
||
|
|
</P>
|
||
|
|
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
||
|
|
|
||
|
|
<A NAME="inner_classes"><!-- --></A>
|
||
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
||
|
|
<B>Nested Class Summary</B></FONT></TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE><static class></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="jala.Mp3.Id3v1.html">jala.Mp3.Id3v1</A></B></CODE></TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE><static class></CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="jala.Mp3.Id3v2.html">jala.Mp3.Id3v2</A></B></CODE></TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
||
|
|
|
||
|
|
|
||
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
||
|
|
|
||
|
|
<A NAME="field_summary"><!-- --></A>
|
||
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
||
|
|
<B>Field Summary</B></FONT></TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<!-- This is one instance field summary -->
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> Object</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="#album">album</A></B></CODE>
|
||
|
|
<BR>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> Object</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="#artist">artist</A></B></CODE>
|
||
|
|
<BR>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> Object</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="#comment">comment</A></B></CODE>
|
||
|
|
<BR>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> Object</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="#genre">genre</A></B></CODE>
|
||
|
|
<BR>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> Object</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="#title">title</A></B></CODE>
|
||
|
|
<BR>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> Object</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="#trackNumber">trackNumber</A></B></CODE>
|
||
|
|
<BR>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE> Object</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="#year">year</A></B></CODE>
|
||
|
|
<BR>
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE><static> <final> Array</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="#!s!GENRES">GENRES</A></B></CODE>
|
||
|
|
<BR>
|
||
|
|
Array defining valid genres in ID3v1</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE><static> <final> Array</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="#!s!MODES">MODES</A></B></CODE>
|
||
|
|
<BR>
|
||
|
|
Array defining mp3 modes.</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE><static> <final> Array</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="#!s!PICTURE_TYPES">PICTURE_TYPES</A></B></CODE>
|
||
|
|
<BR>
|
||
|
|
Array defining valid picture types.</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
||
|
|
<CODE><static> <final> Array</CODE></FONT></TD>
|
||
|
|
<TD><CODE><B><A HREF="#!s!TEXT_ENCODINGS">TEXT_ENCODINGS</A></B></CODE>
|
||
|
|
<BR>
|
||
|
|
Array defining valid text encodings.</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- =========== 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.html#jala.Mp3()">jala.Mp3</A>
|
||
|
|
</B>
|
||
|
|
(<String|File> file)
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Constructs a new jala.Mp3 wrapper and
|
||
|
|
parses the header data of the 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> Object</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#createTag">createTag</A></B>(<Object> tagClass, <Object> tagObject)
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
This method creates a new tag object, attaches it
|
||
|
|
to the file (thereby replacing an existing tag of
|
||
|
|
this type) and returns it.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> <a href="jala.Mp3.Id3v1.html">jala.Mp3.Id3v1</a></CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#createV1Tag">createV1Tag</A></B>(<Object> tagObject)
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
If the file doesn't contain an ID3v1 tag, this method
|
||
|
|
creates a new ID3v1 tag object, attaches it to the file
|
||
|
|
and returns it.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> <a href="jala.Mp3.Id3v2.html">jala.Mp3.Id3v2</a></CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#createV2Tag">createV2Tag</A></B>(<Object> tagObject)
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
If the file doesn't contain an ID3v2 tag, this method
|
||
|
|
creates a new ID3v2 tag object, attaches it to the file
|
||
|
|
and returns it.
|
||
|
|
</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="#getBitRate">getBitRate</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Returns the bit rate the file was encoded with.
|
||
|
|
</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="#getChannelMode">getChannelMode</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Returns the channel mode the file was encoded with.
|
||
|
|
</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="#getDuration">getDuration</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
The audio length of the file in seconds at best estimate
|
||
|
|
from the file info (method returns immediately).
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> helma.File</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#getFile">getFile</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Returns a helma.File reference to the wrapped file.
|
||
|
|
</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="#getFrequency">getFrequency</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Returns the frequency the file was encoded with.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> org.farng.mp3.MP3File</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#getJavaObject">getJavaObject</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Returns the underlying java object
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> Object</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#getMetadata">getMetadata</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Returns a plain JavaScript object containing the values of
|
||
|
|
all fields stored in either the Id3 V1 or V2 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="#getSize">getSize</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Returns the file size in bytes.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> Object</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#getTag">getTag</A></B>(tagClass)
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Returns a tag object, type is specified using the class name
|
||
|
|
in jala.Mp3.*.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> <a href="jala.Mp3.Id3v1.html">jala.Mp3.Id3v1</a></CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#getV1Tag">getV1Tag</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> <a href="jala.Mp3.Id3v2.html">jala.Mp3.Id3v2</a></CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#getV2Tag">getV2Tag</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> Object</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#hasTag">hasTag</A></B>(tagClass)
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Tells if the file contains a certain tag, type is specified
|
||
|
|
using the class name in jala.Mp3.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> Boolean</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#hasV1Tag">hasV1Tag</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Returns true if the file contains a ID3v1 tag.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> Boolean</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#hasV2Tag">hasV2Tag</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Returns true if the file contains a ID3v2 tag.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> Boolean</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#isVariableBitRate">isVariableBitRate</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Returns true if the file is (or seems to be) encoded with
|
||
|
|
variable bit rate.
|
||
|
|
</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="#parseDuration">parseDuration</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Parses the audio file to extract the precise duration of the audio.
|
||
|
|
</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="#removeTag">removeTag</A></B>(tagClass)
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Removes a tag from the file, type is specified using the
|
||
|
|
class name in jala.Mp3.*
|
||
|
|
</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="#removeV1Tag">removeV1Tag</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Removes the ID3v1 tag from the file.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> Object</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#removeV2Tag">removeV2Tag</A></B>()
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Removes the ID3v2 tag from the file.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
||
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
|
||
|
|
<FONT SIZE="-1">
|
||
|
|
<CODE> Boolean</CODE>
|
||
|
|
</FONT>
|
||
|
|
</TD>
|
||
|
|
<TD>
|
||
|
|
<CODE>
|
||
|
|
<B>
|
||
|
|
<A HREF="#save">save</A></B>(<String|helma.File> outFile)
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Writes changed metadata back to the source file or to a new 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="#setMetadata">setMetadata</A></B>(<Object> metadata)
|
||
|
|
</CODE>
|
||
|
|
<BR>
|
||
|
|
|
||
|
|
Stores the metadata passed as argument in the ID2 v1 and v2 tags
|
||
|
|
of the wrapped MP3 file.
|
||
|
|
</TD>
|
||
|
|
</TR>
|
||
|
|
|
||
|
|
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<P>
|
||
|
|
<!-- ========== END METHOD SUMMARY =========== -->
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ============ FIELD DETAIL START =========== -->
|
||
|
|
|
||
|
|
<A NAME="field_detail"><!-- --></A>
|
||
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
||
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
||
|
|
<TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
|
||
|
|
</TR>
|
||
|
|
</TABLE>
|
||
|
|
|
||
|
|
|
||
|
|
<A NAME="album"><!-- --></A>
|
||
|
|
<H3>album</H3>
|
||
|
|
<PRE>Object <B>album</B></PRE>
|
||
|
|
<UL>
|
||
|
|
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="artist"><!-- --></A>
|
||
|
|
<H3>artist</H3>
|
||
|
|
<PRE>Object <B>artist</B></PRE>
|
||
|
|
<UL>
|
||
|
|
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="comment"><!-- --></A>
|
||
|
|
<H3>comment</H3>
|
||
|
|
<PRE>Object <B>comment</B></PRE>
|
||
|
|
<UL>
|
||
|
|
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="genre"><!-- --></A>
|
||
|
|
<H3>genre</H3>
|
||
|
|
<PRE>Object <B>genre</B></PRE>
|
||
|
|
<UL>
|
||
|
|
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="title"><!-- --></A>
|
||
|
|
<H3>title</H3>
|
||
|
|
<PRE>Object <B>title</B></PRE>
|
||
|
|
<UL>
|
||
|
|
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="trackNumber"><!-- --></A>
|
||
|
|
<H3>trackNumber</H3>
|
||
|
|
<PRE>Object <B>trackNumber</B></PRE>
|
||
|
|
<UL>
|
||
|
|
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="year"><!-- --></A>
|
||
|
|
<H3>year</H3>
|
||
|
|
<PRE>Object <B>year</B></PRE>
|
||
|
|
<UL>
|
||
|
|
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="!s!GENRES"><!-- --></A>
|
||
|
|
<H3>GENRES</H3>
|
||
|
|
<PRE><static> <final> Array <B>GENRES</B></PRE>
|
||
|
|
<UL>
|
||
|
|
Array defining valid genres in ID3v1
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="!s!MODES"><!-- --></A>
|
||
|
|
<H3>MODES</H3>
|
||
|
|
<PRE><static> <final> Array <B>MODES</B></PRE>
|
||
|
|
<UL>
|
||
|
|
Array defining mp3 modes.
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="!s!PICTURE_TYPES"><!-- --></A>
|
||
|
|
<H3>PICTURE_TYPES</H3>
|
||
|
|
<PRE><static> <final> Array <B>PICTURE_TYPES</B></PRE>
|
||
|
|
<UL>
|
||
|
|
Array defining valid picture types. Note: Most image tagged files come with
|
||
|
|
one picture of picture type null!
|
||
|
|
The index position within the array defines the number used in the mp3 file.
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="!s!TEXT_ENCODINGS"><!-- --></A>
|
||
|
|
<H3>TEXT_ENCODINGS</H3>
|
||
|
|
<PRE><static> <final> Array <B>TEXT_ENCODINGS</B></PRE>
|
||
|
|
<UL>
|
||
|
|
Array defining valid text encodings. Note: UTF-8 is valid for v2.4 only.
|
||
|
|
UTF-16 with BOM doesn't work with Winamp etc - use UTF-16BE instead!
|
||
|
|
The index position within the array defines the number used in the mp3 file.
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ============ 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()"><!-- --></A><H3>
|
||
|
|
jala.Mp3</H3>
|
||
|
|
<PRE><B>jala.Mp3</B>(<String|File> file)</PRE>
|
||
|
|
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
Constructs a new jala.Mp3 wrapper and
|
||
|
|
parses the header data of the MP3 file.
|
||
|
|
The standard fields for a tag are accessible
|
||
|
|
as properties of the new object.
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Parameters:</B>
|
||
|
|
|
||
|
|
<UL><CODE>file</CODE> - The mp3 file to be parsed, either as path string or as any kind of file object
|
||
|
|
</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="createTag"><!-- --></A>
|
||
|
|
<H3>createTag</H3>
|
||
|
|
<PRE>Object <B>createTag</B>(<Object> tagClass, <Object> tagObject)</PRE>
|
||
|
|
|
||
|
|
<UL>This method creates a new tag object, attaches it
|
||
|
|
to the file (thereby replacing an existing tag of
|
||
|
|
this type) and returns it. Type is specified using
|
||
|
|
the class name in jala.Mp3.*. If a second
|
||
|
|
argument is provided, its values are copied into
|
||
|
|
the new tag.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Parameters:</B>
|
||
|
|
|
||
|
|
<UL><CODE>tagClass</CODE> -
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
<UL><CODE>tagObject</CODE> - optional tag whose standard properties are copied to the new tag.
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="createV1Tag"><!-- --></A>
|
||
|
|
<H3>createV1Tag</H3>
|
||
|
|
<PRE><a href="jala.Mp3.Id3v1.html">jala.Mp3.Id3v1</a> <B>createV1Tag</B>(<Object> tagObject)</PRE>
|
||
|
|
|
||
|
|
<UL>If the file doesn't contain an ID3v1 tag, this method
|
||
|
|
creates a new ID3v1 tag object, attaches it to the file
|
||
|
|
and returns it. If a second argument is provided, its
|
||
|
|
values are copied into the new tag.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Parameters:</B>
|
||
|
|
|
||
|
|
<UL><CODE>tagObject</CODE> - optional tag whose standard properties are copied to the new tag.
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="createV2Tag"><!-- --></A>
|
||
|
|
<H3>createV2Tag</H3>
|
||
|
|
<PRE><a href="jala.Mp3.Id3v2.html">jala.Mp3.Id3v2</a> <B>createV2Tag</B>(<Object> tagObject)</PRE>
|
||
|
|
|
||
|
|
<UL>If the file doesn't contain an ID3v2 tag, this method
|
||
|
|
creates a new ID3v2 tag object, attaches it to the file
|
||
|
|
and returns it. If a second argument is provided, its
|
||
|
|
values are copied into the new tag.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Parameters:</B>
|
||
|
|
|
||
|
|
<UL><CODE>tagObject</CODE> - optional tag whose standard properties are copied to the new tag.
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getBitRate"><!-- --></A>
|
||
|
|
<H3>getBitRate</H3>
|
||
|
|
<PRE>Number <B>getBitRate</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Returns the bit rate the file was encoded with.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getChannelMode"><!-- --></A>
|
||
|
|
<H3>getChannelMode</H3>
|
||
|
|
<PRE>String <B>getChannelMode</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Returns the channel mode the file was encoded with.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getDuration"><!-- --></A>
|
||
|
|
<H3>getDuration</H3>
|
||
|
|
<PRE>Number <B>getDuration</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>The audio length of the file in seconds at best estimate
|
||
|
|
from the file info (method returns immediately).
|
||
|
|
This method calculates based on the bitrate. Therefore it
|
||
|
|
has to produce wrong results for files encoded with variable
|
||
|
|
bitrate (vbr). For these files parseDuration() can be used.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Returns:</B>
|
||
|
|
<UL>
|
||
|
|
length in seconds
|
||
|
|
</UL>
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>See:</B><UL>- <a href="#parseDuration">parseDuration()</a></UL>
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getFile"><!-- --></A>
|
||
|
|
<H3>getFile</H3>
|
||
|
|
<PRE>helma.File <B>getFile</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Returns a helma.File reference to the wrapped file.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getFrequency"><!-- --></A>
|
||
|
|
<H3>getFrequency</H3>
|
||
|
|
<PRE>Number <B>getFrequency</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Returns the frequency the file was encoded with.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getJavaObject"><!-- --></A>
|
||
|
|
<H3>getJavaObject</H3>
|
||
|
|
<PRE>org.farng.mp3.MP3File <B>getJavaObject</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Returns the underlying java object</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getMetadata"><!-- --></A>
|
||
|
|
<H3>getMetadata</H3>
|
||
|
|
<PRE>Object <B>getMetadata</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Returns a plain JavaScript object containing the values of
|
||
|
|
all fields stored in either the Id3 V1 or V2 tag</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Returns:</B>
|
||
|
|
<UL>
|
||
|
|
An object containing the values of all fields
|
||
|
|
</UL>
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getSize"><!-- --></A>
|
||
|
|
<H3>getSize</H3>
|
||
|
|
<PRE>Number <B>getSize</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Returns the file size in bytes.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getTag"><!-- --></A>
|
||
|
|
<H3>getTag</H3>
|
||
|
|
<PRE>Object <B>getTag</B>(tagClass)</PRE>
|
||
|
|
|
||
|
|
<UL>Returns a tag object, type is specified using the class name
|
||
|
|
in jala.Mp3.*.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getV1Tag"><!-- --></A>
|
||
|
|
<H3>getV1Tag</H3>
|
||
|
|
<PRE><a href="jala.Mp3.Id3v1.html">jala.Mp3.Id3v1</a> <B>getV1Tag</B>()</PRE>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="getV2Tag"><!-- --></A>
|
||
|
|
<H3>getV2Tag</H3>
|
||
|
|
<PRE><a href="jala.Mp3.Id3v2.html">jala.Mp3.Id3v2</a> <B>getV2Tag</B>()</PRE>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="hasTag"><!-- --></A>
|
||
|
|
<H3>hasTag</H3>
|
||
|
|
<PRE>Object <B>hasTag</B>(tagClass)</PRE>
|
||
|
|
|
||
|
|
<UL>Tells if the file contains a certain tag, type is specified
|
||
|
|
using the class name in jala.Mp3.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="hasV1Tag"><!-- --></A>
|
||
|
|
<H3>hasV1Tag</H3>
|
||
|
|
<PRE>Boolean <B>hasV1Tag</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Returns true if the file contains a ID3v1 tag.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="hasV2Tag"><!-- --></A>
|
||
|
|
<H3>hasV2Tag</H3>
|
||
|
|
<PRE>Boolean <B>hasV2Tag</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Returns true if the file contains a ID3v2 tag.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="isVariableBitRate"><!-- --></A>
|
||
|
|
<H3>isVariableBitRate</H3>
|
||
|
|
<PRE>Boolean <B>isVariableBitRate</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Returns true if the file is (or seems to be) encoded with
|
||
|
|
variable bit rate. FIXME: The current implementation returned
|
||
|
|
true for all test files.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="parseDuration"><!-- --></A>
|
||
|
|
<H3>parseDuration</H3>
|
||
|
|
<PRE>Number <B>parseDuration</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Parses the audio file to extract the precise duration of the audio.
|
||
|
|
The upside is that it works fine for files with variable bitrates.
|
||
|
|
The downside is that this action may take a few seconds depending on
|
||
|
|
the size of the audio file.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Returns:</B>
|
||
|
|
<UL>
|
||
|
|
length in seconds
|
||
|
|
</UL>
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>See:</B><UL>- <a href="#getDuration">getDuration()</a></UL>
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="removeTag"><!-- --></A>
|
||
|
|
<H3>removeTag</H3>
|
||
|
|
<PRE>void <B>removeTag</B>(tagClass)</PRE>
|
||
|
|
|
||
|
|
<UL>Removes a tag from the file, type is specified using the
|
||
|
|
class name in jala.Mp3.*</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="removeV1Tag"><!-- --></A>
|
||
|
|
<H3>removeV1Tag</H3>
|
||
|
|
<PRE>void <B>removeV1Tag</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Removes the ID3v1 tag from the file.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="removeV2Tag"><!-- --></A>
|
||
|
|
<H3>removeV2Tag</H3>
|
||
|
|
<PRE>Object <B>removeV2Tag</B>()</PRE>
|
||
|
|
|
||
|
|
<UL>Removes the ID3v2 tag from the file.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="save"><!-- --></A>
|
||
|
|
<H3>save</H3>
|
||
|
|
<PRE>Boolean <B>save</B>(<String|helma.File> outFile)</PRE>
|
||
|
|
|
||
|
|
<UL>Writes changed metadata back to the source file or to a new file.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Parameters:</B>
|
||
|
|
|
||
|
|
<UL><CODE>outFile</CODE> - (optional) save the modified file to a different file
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS END -->
|
||
|
|
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Returns:</B>
|
||
|
|
<UL>
|
||
|
|
true on success, false if the file contains tags that cannot be saved (Id3v2_2).
|
||
|
|
</UL>
|
||
|
|
</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES START -->
|
||
|
|
|
||
|
|
<!-- ADDITIONAL ATTRIBUTES END -->
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="setMetadata"><!-- --></A>
|
||
|
|
<H3>setMetadata</H3>
|
||
|
|
<PRE>void <B>setMetadata</B>(<Object> metadata)</PRE>
|
||
|
|
|
||
|
|
<UL>Stores the metadata passed as argument in the ID2 v1 and v2 tags
|
||
|
|
of the wrapped MP3 file.</UL>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- METHOD PARAMETERS START -->
|
||
|
|
|
||
|
|
<UL>
|
||
|
|
<B>Parameters:</B>
|
||
|
|
|
||
|
|
<UL><CODE>metadata</CODE> - An object containing the fields to set and their values.
|
||
|
|
</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.ListRenderer.ArrayList.html"><B>PREV CLASS</B></A><!--
|
||
|
|
NEXT CLASS
|
||
|
|
-->
|
||
|
|
<A HREF="jala.Mp3.Id3v1.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.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>
|