<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>id3lib: ID3_FrameInfo Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="id3lib.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>ID3_FrameInfo Class Reference</h1><!-- doxytag: class="ID3_FrameInfo" -->
<p>Provides information about the frame and field types supported by id3lib.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="field_8h_source.html">id3/field.h</a>></code></p>
<p><a href="class_i_d3___frame_info-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___frame_info.html#ae97a90793d3ce9f1e1d2a730692e364d">ID3_FrameInfo</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___frame_info.html#ae099786a1015b039827f0e470c14d992">~ID3_FrameInfo</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___frame_info.html#aa31a3c338681605920789090d183c22d">ShortName</a> (<a class="el" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a">ID3_FrameID</a> frameid)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___frame_info.html#a51b0ed9322614beb426666303d58467b">LongName</a> (<a class="el" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a">ID3_FrameID</a> frameid)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___frame_info.html#a987aa56f2b1e1c085f62ce371837132e">Description</a> (<a class="el" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a">ID3_FrameID</a> frameid)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___frame_info.html#abe8243fa8d00b5f8e40900895d93ce70">MaxFrameID</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___frame_info.html#a3a9fbef09bb595ba0c028fac22e48bf7">NumFields</a> (<a class="el" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a">ID3_FrameID</a> frameid)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="globals_8h.html#adc0ffe8cf70623e6d4d17092b20bdd6b">ID3_FieldType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___frame_info.html#aa488b046d83c84deb011e0cc94bfb33a">FieldType</a> (<a class="el" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a">ID3_FrameID</a> frameid, int fieldnum)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___frame_info.html#a3a7493e6195890646fea915e05ad7051">FieldSize</a> (<a class="el" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a">ID3_FrameID</a> frameid, int fieldnum)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="globals_8h.html#ab20eda11df95fbb997872386ec0d6004">flags_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_i_d3___frame_info.html#aed6939fc1dc70e66fc368e11a6b9b59b">FieldFlags</a> (<a class="el" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a">ID3_FrameID</a> frameid, int fieldnum)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Provides information about the frame and field types supported by id3lib. </p>
<p>You normally only need (at most) one instance of the <a class="el" href="class_i_d3___frame_info.html" title="Provides information about the frame and field types supported by id3lib.">ID3_FrameInfo</a>. 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>
<p>Usage is straightforward. The following function uses <a class="el" href="class_i_d3___frame_info.html" title="Provides information about the frame and field types supported by id3lib.">ID3_FrameInfo</a> to display a summary of all the frames known to id3lib: </p>
<div class="fragment"><pre class="fragment"> <span class="keywordtype">void</span> ShowKnownFrameInfo {
<a class="code" href="class_i_d3___frame_info.html" title="Provides information about the frame and field types supported by id3lib.">ID3_FrameInfo</a> myFrameInfo;
<span class="keywordflow">for</span> (<span class="keywordtype">int</span> cur = <a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8aac969f7fe3c50b9d87efdf0ad15c3802c" title="No known frame.">ID3FID_NOFRAME</a>+1; cur <= myFrameInfo.<a class="code" href="class_i_d3___frame_info.html#abe8243fa8d00b5f8e40900895d93ce70">MaxFrameID</a>(); cur ++)
{
cout << <span class="stringliteral">"Short ID: "</span> << myFrameInfo.<a class="code" href="class_i_d3___frame_info.html#aa31a3c338681605920789090d183c22d">ShortName</a>(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a>(cur)) <<
<span class="stringliteral">" Long ID: "</span> << myFrameInfo.<a class="code" href="class_i_d3___frame_info.html#a51b0ed9322614beb426666303d58467b">LongName</a>(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a>(cur)) <<
<span class="stringliteral">" Desription: "</span> << myFrameInfo.<a class="code" href="class_i_d3___frame_info.html#a987aa56f2b1e1c085f62ce371837132e">Description</a>(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">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 class="fragment"> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> cur = <a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8aac969f7fe3c50b9d87efdf0ad15c3802c" title="No known frame.">ID3FID_NOFRAME</a>+1; cur <= fi.MaxFrameID(); cur ++)
{
<span class="keywordtype">int</span> numfields = fi.NumFields(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a>(cur));
cout << <span class="stringliteral">"ID: "</span> << fi.LongName(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a>(cur)) <<
<span class="stringliteral">" FIELDS: "</span> << numfields << endl;
<span class="keywordflow">for</span>(<span class="keywordtype">int</span> i=0;i<numfields;i++) {
cout << <span class="stringliteral">"TYPE: "</span> << fi.FieldType(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a>(cur),i) <<
<span class="stringliteral">" SIZE: "</span> << fi.FieldSize(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a>(cur),i) <<
<span class="stringliteral">" FLAGS: "</span> << fi.FieldFlags(<a class="code" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a" title="Enumeration of the different types of frames recognized by id3lib.">ID3_FrameID</a>(cur),i) << endl;
}
cout << endl;
}
</pre></div><dl class="author"><dt><b>Author:</b></dt><dd>Cedric Tefft </dd></dl>
<dl class="version"><dt><b>Version:</b></dt><dd></dd></dl>
<dl class="rcs"><dt><b>Id</b></dt><dd><a class="el" href="field_8cpp.html">field.cpp</a>,v 1.47 2002/11/03 00:41:27 t1mpy Exp </dd></dl>
<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>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae97a90793d3ce9f1e1d2a730692e364d"></a><!-- doxytag: member="ID3_FrameInfo::ID3_FrameInfo" ref="ae97a90793d3ce9f1e1d2a730692e364d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ID3_FrameInfo::ID3_FrameInfo </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>.</p>
</div>
</div>
<a class="anchor" id="ae099786a1015b039827f0e470c14d992"></a><!-- doxytag: member="ID3_FrameInfo::~ID3_FrameInfo" ref="ae099786a1015b039827f0e470c14d992" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ID3_FrameInfo::~ID3_FrameInfo </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a987aa56f2b1e1c085f62ce371837132e"></a><!-- doxytag: member="ID3_FrameInfo::Description" ref="a987aa56f2b1e1c085f62ce371837132e" args="(ID3_FrameID frameid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * ID3_FrameInfo::Description </td>
<td>(</td>
<td class="paramtype"><a class="el" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a">ID3_FrameID</a> </td>
<td class="paramname"> <em>frameid</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="field_8cpp_source.html#l01260">1260</a> of file <a class="el" href="field_8cpp_source.html">field.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aed6939fc1dc70e66fc368e11a6b9b59b"></a><!-- doxytag: member="ID3_FrameInfo::FieldFlags" ref="aed6939fc1dc70e66fc368e11a6b9b59b" args="(ID3_FrameID frameid, int fieldnum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="globals_8h.html#ab20eda11df95fbb997872386ec0d6004">flags_t</a> ID3_FrameInfo::FieldFlags </td>
<td>(</td>
<td class="paramtype"><a class="el" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a">ID3_FrameID</a> </td>
<td class="paramname"> <em>frameid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>fieldnum</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="field_8cpp_source.html#l01306">1306</a> of file <a class="el" href="field_8cpp_source.html">field.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3a7493e6195890646fea915e05ad7051"></a><!-- doxytag: member="ID3_FrameInfo::FieldSize" ref="a3a7493e6195890646fea915e05ad7051" args="(ID3_FrameID frameid, int fieldnum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t ID3_FrameInfo::FieldSize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a">ID3_FrameID</a> </td>
<td class="paramname"> <em>frameid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>fieldnum</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="field_8cpp_source.html#l01297">1297</a> of file <a class="el" href="field_8cpp_source.html">field.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa488b046d83c84deb011e0cc94bfb33a"></a><!-- doxytag: member="ID3_FrameInfo::FieldType" ref="aa488b046d83c84deb011e0cc94bfb33a" args="(ID3_FrameID frameid, int fieldnum)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="globals_8h.html#adc0ffe8cf70623e6d4d17092b20bdd6b">ID3_FieldType</a> ID3_FrameInfo::FieldType </td>
<td>(</td>
<td class="paramtype"><a class="el" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a">ID3_FrameID</a> </td>
<td class="paramname"> <em>frameid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>fieldnum</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
</div>
</div>
<a class="anchor" id="a51b0ed9322614beb426666303d58467b"></a><!-- doxytag: member="ID3_FrameInfo::LongName" ref="a51b0ed9322614beb426666303d58467b" args="(ID3_FrameID frameid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * ID3_FrameInfo::LongName </td>
<td>(</td>
<td class="paramtype"><a class="el" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a">ID3_FrameID</a> </td>
<td class="paramname"> <em>frameid</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="field_8cpp_source.html#l01251">1251</a> of file <a class="el" href="field_8cpp_source.html">field.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="abe8243fa8d00b5f8e40900895d93ce70"></a><!-- doxytag: member="ID3_FrameInfo::MaxFrameID" ref="abe8243fa8d00b5f8e40900895d93ce70" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ID3_FrameInfo::MaxFrameID </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="field_8cpp_source.html#l01269">1269</a> of file <a class="el" href="field_8cpp_source.html">field.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3a9fbef09bb595ba0c028fac22e48bf7"></a><!-- doxytag: member="ID3_FrameInfo::NumFields" ref="a3a9fbef09bb595ba0c028fac22e48bf7" args="(ID3_FrameID frameid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ID3_FrameInfo::NumFields </td>
<td>(</td>
<td class="paramtype"><a class="el" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a">ID3_FrameID</a> </td>
<td class="paramname"> <em>frameid</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
</div>
</div>
<a class="anchor" id="aa31a3c338681605920789090d183c22d"></a><!-- doxytag: member="ID3_FrameInfo::ShortName" ref="aa31a3c338681605920789090d183c22d" args="(ID3_FrameID frameid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * ID3_FrameInfo::ShortName </td>
<td>(</td>
<td class="paramtype"><a class="el" href="globals_8h.html#a78f454bf66f16b1e1c9f8e37bda9ab8a">ID3_FrameID</a> </td>
<td class="paramname"> <em>frameid</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="field_8cpp_source.html#l01242">1242</a> of file <a class="el" href="field_8cpp_source.html">field.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/id3/<a class="el" href="field_8h_source.html">field.h</a></li>
<li>src/<a class="el" href="field_8cpp_source.html">field.cpp</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Jan 12 23:46:36 2011 for id3lib by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mageia
>
1
>
i586
>
media
>
core-release
>
by-pkgid
>
1b812d1b0e765bcc0430721ff58676d2
>
files
>
43
