<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ID3_FrameInfo class Reference</title>
<link href="id3lib.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.12 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
<hr><h1>ID3_FrameInfo Class Reference</h1>Provides information about the frame and field types supported by id3lib.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="field_8h-source.html">id3/field.h</a>></code>
<p>
<a href="class_i_d3___frame_info-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_i_d3___frame_info.html#a0">ID3_FrameInfo</a> ()</td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_i_d3___frame_info.html#a1">~ID3_FrameInfo</a> ()</td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="class_i_d3___frame_info.html#a2">ShortName</a> (<a class="el" href="globals_8h.html#a219">ID3_FrameID</a> frameid)</td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="class_i_d3___frame_info.html#a3">LongName</a> (<a class="el" href="globals_8h.html#a219">ID3_FrameID</a> frameid)</td></tr>
<tr><td nowrap align=right valign=top>const char * </td><td valign=bottom><a class="el" href="class_i_d3___frame_info.html#a4">Description</a> (<a class="el" href="globals_8h.html#a219">ID3_FrameID</a> frameid)</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="class_i_d3___frame_info.html#a5">MaxFrameID</a> ()</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="class_i_d3___frame_info.html#a6">NumFields</a> (<a class="el" href="globals_8h.html#a219">ID3_FrameID</a> frameid)</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="globals_8h.html#a222">ID3_FieldType</a> </td><td valign=bottom><a class="el" href="class_i_d3___frame_info.html#a7">FieldType</a> (<a class="el" href="globals_8h.html#a219">ID3_FrameID</a> frameid, int fieldnum)</td></tr>
<tr><td nowrap align=right valign=top>size_t </td><td valign=bottom><a class="el" href="class_i_d3___frame_info.html#a8">FieldSize</a> (<a class="el" href="globals_8h.html#a219">ID3_FrameID</a> frameid, int fieldnum)</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="globals_8h.html#a40">flags_t</a> </td><td valign=bottom><a class="el" href="class_i_d3___frame_info.html#a9">FieldFlags</a> (<a class="el" href="globals_8h.html#a219">ID3_FrameID</a> frameid, int fieldnum)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Provides information about the frame and field types supported by id3lib.
<p>
You normally only need (at most) one instance of the ID3_FrameInfo. It has no member data -- only methods which provide information about the frame types (and their component fields) supported by id3lib as defined in <a class="el" href="field_8cpp.html">field.cpp</a> .
<p>
Usage is straightforward. The following function uses ID3_FrameInfo to display a summary of all the frames known to id3lib: <div class="fragment"><pre> <font class="keywordtype">void</font> ShowKnownFrameInfo {
<a class="code" href="class_i_d3___frame_info.html">ID3_FrameInfo</a> myFrameInfo;
<font class="keywordflow">for</font> (<font class="keywordtype">int</font> cur = <a class="code" href="globals_8h.html#a219a95">ID3FID_NOFRAME</a>+1; cur <= myFrameInfo.<a class="code" href="class_i_d3___frame_info.html#a5">MaxFrameID</a>(); cur ++)
{
cout << <font class="stringliteral">"Short ID: "</font> << myFrameInfo.<a class="code" href="class_i_d3___frame_info.html#a2">ShortName</a>(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a>(cur)) <<
<font class="stringliteral">" Long ID: "</font> << myFrameInfo.<a class="code" href="class_i_d3___frame_info.html#a3">LongName</a>(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a>(cur)) <<
<font class="stringliteral">" Desription: "</font> << myFrameInfo.<a class="code" href="class_i_d3___frame_info.html#a4">Description</a>(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a>(cur)) << endl;
}
}
</pre></div>
<p>
Functions are also provided to glean more information about the individual fields which make up any given frame type. The following for() loop, embedded into the previous for() loop would provide a raw look at such information. Realize, of course, that the field type is meaningless when printed. Only when it is taken in the context of the ID3_FieldType enum does it take on any meaningful significance.
<p>
<div class="fragment"><pre> <font class="keywordflow">for</font> (<font class="keywordtype">int</font> cur = <a class="code" href="globals_8h.html#a219a95">ID3FID_NOFRAME</a>+1; cur <= fi.MaxFrameID(); cur ++)
{
<font class="keywordtype">int</font> numfields = fi.NumFields(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a>(cur));
cout << <font class="stringliteral">"ID: "</font> << fi.LongName(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a>(cur)) <<
<font class="stringliteral">" FIELDS: "</font> << numfields << endl;
<font class="keywordflow">for</font>(<font class="keywordtype">int</font> i=0;i<numfields;i++) {
cout << <font class="stringliteral">"TYPE: "</font> << fi.FieldType(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a>(cur),i) <<
<font class="stringliteral">" SIZE: "</font> << fi.FieldSize(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a>(cur),i) <<
<font class="stringliteral">" FLAGS: "</font> << fi.FieldFlags(<a class="code" href="globals_8h.html#a219">ID3_FrameID</a>(cur),i) << endl;
}
cout << endl;
}
</pre></div>
<p>
<dl compact><dt><b>
Author: </b><dd>
Cedric Tefft </dl><dl compact><dt><b>
Version: </b><dd>
</dl><dl compact><dt><b>
Id: </b><dd>
field.cpp,v 1.43 2001/09/08 23:53:55 shadrack Exp </dl>
<p>
<p>
Definition at line <a class="el" href="field_8h-source.html#l00096">96</a> of file <a class="el" href="field_8h-source.html">field.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="ID3_FrameInfo::ID3_FrameInfo"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> ID3_FrameInfo::ID3_FrameInfo </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="field_8h-source.html#l00100">100</a> of file <a class="el" href="field_8h-source.html">field.h</a>. </td>
</tr>
</table>
<a name="a1" doxytag="ID3_FrameInfo::~ID3_FrameInfo"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> ID3_FrameInfo::~ID3_FrameInfo </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="field_8h-source.html#l00101">101</a> of file <a class="el" href="field_8h-source.html">field.h</a>.
<p>
References <a class="el" href="globals_8h-source.html#l00095">flags_t</a>, <a class="el" href="globals_8h-source.html#l00311">ID3_FieldType</a>, and <a class="el" href="globals_8h-source.html#l00207">ID3_FrameID</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a4" doxytag="ID3_FrameInfo::Description"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> const char * ID3_FrameInfo::Description </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="globals_8h.html#a219">ID3_FrameID</a> </td>
<td class="mdname1" valign="top" nowrap> <em>frameid</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="field_8cpp-source.html#l01262">1262</a> of file <a class="el" href="field_8cpp-source.html">field.cpp</a>.
<p>
References <a class="el" href="globals_8h-source.html#l00207">ID3_FrameID</a>, <a class="el" href="namespace_3global_scope_4.html#a219a172">ID3FID_LASTFRAMEID</a>, <a class="el" href="globals_8h-source.html#l00404">NULL</a>, and <a class="el" href="frame__def_8h-source.html#l00044">ID3_FrameDef::sDescription</a>. </td>
</tr>
</table>
<a name="a9" doxytag="ID3_FrameInfo::FieldFlags"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="globals_8h.html#a40">flags_t</a> ID3_FrameInfo::FieldFlags </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="globals_8h.html#a219">ID3_FrameID</a> </td>
<td class="mdname" nowrap> <em>frameid</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>fieldnum</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="field_8cpp-source.html#l01292">1292</a> of file <a class="el" href="field_8cpp-source.html">field.cpp</a>.
<p>
References <a class="el" href="field__def_8h-source.html#l00040">ID3_FieldDef::_flags</a>, <a class="el" href="frame__def_8h-source.html#l00043">ID3_FrameDef::aeFieldDefs</a>, <a class="el" href="globals_8h-source.html#l00095">flags_t</a>, and <a class="el" href="globals_8h-source.html#l00207">ID3_FrameID</a>. </td>
</tr>
</table>
<a name="a8" doxytag="ID3_FrameInfo::FieldSize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> size_t ID3_FrameInfo::FieldSize </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="globals_8h.html#a219">ID3_FrameID</a> </td>
<td class="mdname" nowrap> <em>frameid</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>fieldnum</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="field_8cpp-source.html#l01288">1288</a> of file <a class="el" href="field_8cpp-source.html">field.cpp</a>.
<p>
References <a class="el" href="field__def_8h-source.html#l00037">ID3_FieldDef::_fixed_size</a>, <a class="el" href="frame__def_8h-source.html#l00043">ID3_FrameDef::aeFieldDefs</a>, and <a class="el" href="globals_8h-source.html#l00207">ID3_FrameID</a>. </td>
</tr>
</table>
<a name="a7" doxytag="ID3_FrameInfo::FieldType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="globals_8h.html#a222">ID3_FieldType</a> ID3_FrameInfo::FieldType </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="globals_8h.html#a219">ID3_FrameID</a> </td>
<td class="mdname" nowrap> <em>frameid</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>fieldnum</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="field_8cpp-source.html#l01284">1284</a> of file <a class="el" href="field_8cpp-source.html">field.cpp</a>.
<p>
References <a class="el" href="field__def_8h-source.html#l00036">ID3_FieldDef::_type</a>, <a class="el" href="frame__def_8h-source.html#l00043">ID3_FrameDef::aeFieldDefs</a>, <a class="el" href="globals_8h-source.html#l00311">ID3_FieldType</a>, and <a class="el" href="globals_8h-source.html#l00207">ID3_FrameID</a>. </td>
</tr>
</table>
<a name="a3" doxytag="ID3_FrameInfo::LongName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char * ID3_FrameInfo::LongName </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="globals_8h.html#a219">ID3_FrameID</a> </td>
<td class="mdname1" valign="top" nowrap> <em>frameid</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="field_8cpp-source.html#l01254">1254</a> of file <a class="el" href="field_8cpp-source.html">field.cpp</a>.
<p>
References <a class="el" href="globals_8h-source.html#l00207">ID3_FrameID</a>, <a class="el" href="namespace_3global_scope_4.html#a219a172">ID3FID_LASTFRAMEID</a>, <a class="el" href="globals_8h-source.html#l00404">NULL</a>, and <a class="el" href="frame__def_8h-source.html#l00040">ID3_FrameDef::sLongTextID</a>. </td>
</tr>
</table>
<a name="a5" doxytag="ID3_FrameInfo::MaxFrameID"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int ID3_FrameInfo::MaxFrameID </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="field_8cpp-source.html#l01270">1270</a> of file <a class="el" href="field_8cpp-source.html">field.cpp</a>.
<p>
References <a class="el" href="namespace_3global_scope_4.html#a219a172">ID3FID_LASTFRAMEID</a>. </td>
</tr>
</table>
<a name="a6" doxytag="ID3_FrameInfo::NumFields"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int ID3_FrameInfo::NumFields </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="globals_8h.html#a219">ID3_FrameID</a> </td>
<td class="mdname1" valign="top" nowrap> <em>frameid</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="field_8cpp-source.html#l01274">1274</a> of file <a class="el" href="field_8cpp-source.html">field.cpp</a>.
<p>
References <a class="el" href="field__def_8h-source.html#l00035">ID3_FieldDef::_id</a>, <a class="el" href="frame__def_8h-source.html#l00043">ID3_FrameDef::aeFieldDefs</a>, <a class="el" href="globals_8h-source.html#l00207">ID3_FrameID</a>, and <a class="el" href="namespace_3global_scope_4.html#a218a70">ID3FN_NOFIELD</a>. </td>
</tr>
</table>
<a name="a2" doxytag="ID3_FrameInfo::ShortName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char * ID3_FrameInfo::ShortName </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="globals_8h.html#a219">ID3_FrameID</a> </td>
<td class="mdname1" valign="top" nowrap> <em>frameid</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Definition at line <a class="el" href="field_8cpp-source.html#l01246">1246</a> of file <a class="el" href="field_8cpp-source.html">field.cpp</a>.
<p>
References <a class="el" href="globals_8h-source.html#l00207">ID3_FrameID</a>, <a class="el" href="namespace_3global_scope_4.html#a219a172">ID3FID_LASTFRAMEID</a>, <a class="el" href="globals_8h-source.html#l00404">NULL</a>, and <a class="el" href="frame__def_8h-source.html#l00039">ID3_FrameDef::sShortTextID</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="field_8cpp-source.html">field.cpp</a><li>include/id3/<a class="el" href="field_8h-source.html">field.h</a></ul>
<hr><address><small>Generated on Thu Jan 3 07:35:56 2002 for id3lib by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.12 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
8.2
>
i586
>
media
>
contrib
>
by-pkgid
>
2c9d30f3cf217a6cae41860ebc0d6704
>
files
>
46
