<!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_Frame 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_Frame Class Reference</h1>The representative class of an id3v2 frame.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="frame_8h-source.html">id3/frame.h</a>></code>
<p>
<a href="class_i_d3___frame-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.html#a0">ID3_Frame</a> (<a class="el" href="globals_8h.html#a219">ID3_FrameID</a> id=ID3FID_NOFRAME)</td></tr>
<tr><td> </td><td><font size=-1><em>Default constructor; accepts as a default parameter the type of frame to create.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a1">ID3_Frame</a> (const ID3_Frame &)</td></tr>
<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a2">~ID3_Frame</a> ()</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a3">Clear</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Clears the frame of all data and resets the frame such that it can take on the form of any id3v2 frame that id3lib supports.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a4">SetID</a> (<a class="el" href="globals_8h.html#a219">ID3_FrameID</a> id)</td></tr>
<tr><td> </td><td><font size=-1><em>Establishes the internal structure of an <a class="el" href="class_i_d3___frame_impl.html">ID3_FrameImpl</a> object so that it represents the id3v2 frame indicated by the parameter.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="globals_8h.html#a219">ID3_FrameID</a> </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a5">GetID</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the type of frame that the object represents.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="class_i_d3___field.html">ID3_Field</a> * </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a6">GetField</a> (<a class="el" href="globals_8h.html#a218">ID3_FieldID</a> name) const</td></tr>
<tr><td nowrap align=right valign=top>size_t </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a7">NumFields</a> () const</td></tr>
<tr><td nowrap align=right valign=top>const char * </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a8">GetDescription</a> () const</td></tr>
<tr><td nowrap align=right valign=top>const char * </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a9">GetTextID</a> () const</td></tr>
<tr><td nowrap align=right valign=top>ID3_Frame & </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a10">operator=</a> (const ID3_Frame &)</td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a11">HasChanged</a> () const</td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a12">Parse</a> (<a class="el" href="class_i_d3___reader.html">ID3_Reader</a> &)</td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a13">Render</a> (<a class="el" href="class_i_d3___writer.html">ID3_Writer</a> &) const</td></tr>
<tr><td nowrap align=right valign=top>size_t </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a14">Size</a> ()</td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a15">Contains</a> (<a class="el" href="globals_8h.html#a218">ID3_FieldID</a> fld) const</td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a16">SetSpec</a> (<a class="el" href="globals_8h.html#a216">ID3_V2Spec</a>)</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="globals_8h.html#a216">ID3_V2Spec</a> </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a17">GetSpec</a> () const</td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a18">SetCompression</a> (bool b)</td></tr>
<tr><td> </td><td><font size=-1><em>Sets the compression flag within the frame.</em> <a href="#a18">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a19">GetCompression</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns whether or not the compression flag is set.</em> <a href="#a19">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>size_t </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a20">GetDataSize</a> () const</td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a21">SetEncryptionID</a> (<a class="el" href="globals_8h.html#a33">uchar</a> id)</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="globals_8h.html#a33">uchar</a> </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a22">GetEncryptionID</a> () const</td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a23">SetGroupingID</a> (<a class="el" href="globals_8h.html#a33">uchar</a> id)</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="globals_8h.html#a33">uchar</a> </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a24">GetGroupingID</a> () const</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="class_i_d3___frame_1_1_iterator.html">Iterator</a> * </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a25">CreateIterator</a> ()</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="class_i_d3___frame_1_1_const_iterator.html">ConstIterator</a> * </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a26">CreateIterator</a> () const</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="class_i_d3___field.html">ID3_Field</a> & </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#a27">Field</a> (<a class="el" href="globals_8h.html#a218">ID3_FieldID</a> name) const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns a pointer to the frame's internal field indicated by the parameter.</em> <a href="#a27">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>const char * </td><td valign=bottom><a class="el" href="class_i_d3___frame.html#d0">GetDescription</a> (<a class="el" href="globals_8h.html#a219">ID3_FrameID</a>)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The representative class of an id3v2 frame.
<p>
id3lib defines frames in a funny way. Using some nice c++ conventions, <a class="el" href="class_i_d3___frame_impl.html">ID3_FrameImpl</a> class objects appear to be quite polymorphic; that is, they can take on many forms. The same <a class="el" href="class_i_d3___frame_impl.html">ID3_FrameImpl</a> class provides the facilities for the implementation of a complex APIC frame and for a simple text frame.
<p>
<dl compact><dt><b>
Author: </b><dd>
Dirk Mahoney </dl><dl compact><dt><b>
Version: </b><dd>
</dl><dl compact><dt><b>
Id: </b><dd>
frame.cpp,v 1.32 2000/10/24 07:00:08 eldamitri Exp </dl> <dl compact><dt><b>
See also: </b><dd>
<a class="el" href="class_i_d3___tag.html">ID3_Tag</a> , <a class="el" href="class_i_d3___field.html">ID3_Field</a> , <a class="el" href="globals_8h.html#a223">ID3_Err</a> </dl>
<p>
<p>
Definition at line <a class="el" href="frame_8h-source.html#l00038">38</a> of file <a class="el" href="frame_8h-source.html">frame.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="ID3_Frame::ID3_Frame"></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_Frame::ID3_Frame </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>id</em> = ID3FID_NOFRAME </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>
Default constructor; accepts as a default parameter the type of frame to create.
<p>
The parameter which will internally set the frame's structure. See <a class="el" href="class_i_d3___frame.html#a4">SetID</a>() for more details.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>id</em> </td><td>
The type of frame to create </td></tr>
</table>
</dl><dl compact><dt><b>
See also: </b><dd>
<a class="el" href="globals_8h.html#a219">ID3_FrameID</a> , <a class="el" href="class_i_d3___frame.html#a4">SetID</a> </dl>
<p>
Definition at line <a class="el" href="frame_8cpp-source.html#l00061">61</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="globals_8h-source.html#l00207">ID3_FrameID</a>. </td>
</tr>
</table>
<a name="a1" doxytag="ID3_Frame::ID3_Frame"></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_Frame::ID3_Frame </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const ID3_Frame & </td>
<td class="mdname1" valign="top" nowrap> <em>frame</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="frame_8cpp-source.html#l00066">66</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>. </td>
</tr>
</table>
<a name="a2" doxytag="ID3_Frame::~ID3_Frame"></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_Frame::~ID3_Frame </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> [virtual]</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="frame_8cpp-source.html#l00071">71</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a3" doxytag="ID3_Frame::Clear"></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"> void ID3_Frame::Clear </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>
Clears the frame of all data and resets the frame such that it can take on the form of any id3v2 frame that id3lib supports.
<p>
<dl compact><dt><b>
See also: </b><dd>
<a class="el" href="class_i_d3___tag.html#a3">ID3_Tag::Clear</a> </dl>
<p>
Definition at line <a class="el" href="frame_8cpp-source.html#l00081">81</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__impl_8cpp-source.html#l00089">ID3_FrameImpl::Clear</a>(). </td>
</tr>
</table>
<a name="a15" doxytag="ID3_Frame::Contains"></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"> bool ID3_Frame::Contains </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="globals_8h.html#a218">ID3_FieldID</a> </td>
<td class="mdname1" valign="top" nowrap> <em>id</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</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="frame_8cpp-source.html#l00208">208</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__impl_8h-source.html#l00070">ID3_FrameImpl::Contains</a>(), and <a class="el" href="globals_8h-source.html#l00175">ID3_FieldID</a>. </td>
</tr>
</table>
<a name="a26" doxytag="ID3_Frame::CreateIterator"></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="class_i_d3___frame_1_1_const_iterator.html">ID3_Frame::ConstIterator</a> * ID3_Frame::CreateIterator </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</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="frame_8cpp-source.html#l00315">315</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>. </td>
</tr>
</table>
<a name="a25" doxytag="ID3_Frame::CreateIterator"></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="class_i_d3___frame_1_1_iterator.html">ID3_Frame::Iterator</a> * ID3_Frame::CreateIterator </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="frame_8cpp-source.html#l00309">309</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
Referenced by <a class="el" href="frame__impl_8cpp-source.html#l00223">ID3_FrameImpl::operator=</a>(). </td>
</tr>
</table>
<a name="a27" doxytag="ID3_Frame::Field"></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="class_i_d3___field.html">ID3_Field</a> & ID3_Frame::Field </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="globals_8h.html#a218">ID3_FieldID</a> </td>
<td class="mdname1" valign="top" nowrap> <em>fieldName</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns a pointer to the frame's internal field indicated by the parameter.
<p>
<div class="fragment"><pre> <a class="code" href="globals_8h.html#a214">ID3_TextEnc</a> enc;
enc = (ID3_TextEnc) myFrame.GetField(ID3FN_TEXTENC)->Get();
</pre></div><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name</em> </td><td>
The name of the field to be retrieved </td></tr>
</table>
</dl><dl compact><dt><b>
Returns: </b><dd>
A reference to the desired field </dl>
<p>
Definition at line <a class="el" href="frame_8cpp-source.html#l00141">141</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame_8cpp-source.html#l00146">GetField</a>(), and <a class="el" href="globals_8h-source.html#l00175">ID3_FieldID</a>. </td>
</tr>
</table>
<a name="a19" doxytag="ID3_Frame::GetCompression"></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"> bool ID3_Frame::GetCompression </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns whether or not the compression flag is set.
<p>
After parsing a tag, this will indicate whether or not the frame was compressed. After rendering a tag, however, it does not actually indicate if the frame is compressed rendering. It only indicates whether or not compression was attempted. A frame will not be compressed, even whent the compression flag is set, if the "compressed" data is no smaller than the "uncompressed" data.
<p>
Definition at line <a class="el" href="frame_8cpp-source.html#l00231">231</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__impl_8h-source.html#l00089">ID3_FrameImpl::GetCompression</a>().
<p>
Referenced by <a class="el" href="frame__impl_8cpp-source.html#l00223">ID3_FrameImpl::operator=</a>(). </td>
</tr>
</table>
<a name="a20" doxytag="ID3_Frame::GetDataSize"></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_Frame::GetDataSize </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</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="frame_8cpp-source.html#l00236">236</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__impl_8h-source.html#l00090">ID3_FrameImpl::GetDataSize</a>(). </td>
</tr>
</table>
<a name="d0" doxytag="ID3_Frame::GetDescription"></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_Frame::GetDescription </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>id</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [static]</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="frame_8cpp-source.html#l00183">183</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__impl_8cpp-source.html#l00258">ID3_FrameImpl::GetDescription</a>(), and <a class="el" href="globals_8h-source.html#l00207">ID3_FrameID</a>. </td>
</tr>
</table>
<a name="a8" doxytag="ID3_Frame::GetDescription"></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_Frame::GetDescription </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</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="frame_8cpp-source.html#l00188">188</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__impl_8cpp-source.html#l00258">ID3_FrameImpl::GetDescription</a>(). </td>
</tr>
</table>
<a name="a22" doxytag="ID3_Frame::GetEncryptionID"></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#a33">uchar</a> ID3_Frame::GetEncryptionID </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</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="frame_8cpp-source.html#l00246">246</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__impl_8h-source.html#l00100">ID3_FrameImpl::GetEncryptionID</a>(), and <a class="el" href="globals_8h-source.html#l00087">uchar</a>.
<p>
Referenced by <a class="el" href="frame__impl_8cpp-source.html#l00223">ID3_FrameImpl::operator=</a>(). </td>
</tr>
</table>
<a name="a6" doxytag="ID3_Frame::GetField"></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="class_i_d3___field.html">ID3_Field</a> * ID3_Frame::GetField </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="globals_8h.html#a218">ID3_FieldID</a> </td>
<td class="mdname1" valign="top" nowrap> <em>fieldName</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</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="frame_8cpp-source.html#l00146">146</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__impl_8cpp-source.html#l00150">ID3_FrameImpl::GetField</a>(), and <a class="el" href="globals_8h-source.html#l00175">ID3_FieldID</a>.
<p>
Referenced by <a class="el" href="frame_8cpp-source.html#l00141">Field</a>(), <a class="el" href="misc__support_8cpp-source.html#l00178">ID3_AddAlbum</a>(), <a class="el" href="misc__support_8cpp-source.html#l00097">ID3_AddArtist</a>(), <a class="el" href="misc__support_8cpp-source.html#l00379">ID3_AddComment</a>(), <a class="el" href="misc__support_8cpp-source.html#l00606">ID3_AddGenre</a>(), <a class="el" href="misc__support_8cpp-source.html#l00741">ID3_AddLyricist</a>(), <a class="el" href="misc__support_8cpp-source.html#l00679">ID3_AddLyrics</a>(), <a class="el" href="misc__support_8cpp-source.html#l00805">ID3_AddSyncLyrics</a>(), <a class="el" href="misc__support_8cpp-source.html#l00237">ID3_AddTitle</a>(), <a class="el" href="misc__support_8cpp-source.html#l00503">ID3_AddTrack</a>(), <a class="el" href="misc__support_8cpp-source.html#l00296">ID3_AddYear</a>(), <a class="el" href="misc__support_8cpp-source.html#l00044">ID3_GetString</a>(), <a class="el" href="misc__support_8cpp-source.html#l00893">ID3_GetSyncLyrics</a>(), and <a class="el" href="misc__support_8cpp-source.html#l00852">ID3_GetSyncLyricsInfo</a>(). </td>
</tr>
</table>
<a name="a24" doxytag="ID3_Frame::GetGroupingID"></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#a33">uchar</a> ID3_Frame::GetGroupingID </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</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="frame_8cpp-source.html#l00256">256</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__impl_8h-source.html#l00042">ID3_FrameImpl::const_iterator</a>, <a class="el" href="frame__impl_8h-source.html#l00109">ID3_FrameImpl::GetGroupingID</a>(), <a class="el" href="frame__impl_8h-source.html#l00041">ID3_FrameImpl::iterator</a>, <a class="el" href="globals_8h-source.html#l00404">NULL</a>, and <a class="el" href="globals_8h-source.html#l00087">uchar</a>.
<p>
Referenced by <a class="el" href="frame__impl_8cpp-source.html#l00223">ID3_FrameImpl::operator=</a>(). </td>
</tr>
</table>
<a name="a5" doxytag="ID3_Frame::GetID"></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#a219">ID3_FrameID</a> ID3_Frame::GetID </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the type of frame that the object represents.
<p>
Useful in conjunction with <a class="el" href="class_i_d3___tag.html#a28">ID3_Tag::Find</a>() method
<p>
<dl compact><dt><b>
Returns: </b><dd>
The type, or id, of the frame </dl><dl compact><dt><b>
See also: </b><dd>
<a class="el" href="class_i_d3___tag.html#a28">ID3_Tag::Find</a> </dl>
<p>
Definition at line <a class="el" href="frame_8cpp-source.html#l00093">93</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__impl_8h-source.html#l00054">ID3_FrameImpl::GetID</a>(), and <a class="el" href="globals_8h-source.html#l00207">ID3_FrameID</a>.
<p>
Referenced by <a class="el" href="misc__support_8cpp-source.html#l00379">ID3_AddComment</a>(), <a class="el" href="misc__support_8cpp-source.html#l00433">ID3_RemoveComments</a>(), and <a class="el" href="frame__impl_8cpp-source.html#l00223">ID3_FrameImpl::operator=</a>(). </td>
</tr>
</table>
<a name="a17" doxytag="ID3_Frame::GetSpec"></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#a216">ID3_V2Spec</a> ID3_Frame::GetSpec </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</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="frame_8cpp-source.html#l00125">125</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__impl_8cpp-source.html#l00145">ID3_FrameImpl::GetSpec</a>(), and <a class="el" href="globals_8h-source.html#l00139">ID3_V2Spec</a>.
<p>
Referenced by <a class="el" href="frame__impl_8cpp-source.html#l00223">ID3_FrameImpl::operator=</a>(). </td>
</tr>
</table>
<a name="a9" doxytag="ID3_Frame::GetTextID"></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_Frame::GetTextID </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</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="frame_8cpp-source.html#l00193">193</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__impl_8h-source.html#l00063">ID3_FrameImpl::GetTextID</a>(). </td>
</tr>
</table>
<a name="a11" doxytag="ID3_Frame::HasChanged"></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"> bool ID3_Frame::HasChanged </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</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="frame_8cpp-source.html#l00169">169</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__impl_8cpp-source.html#l00207">ID3_FrameImpl::HasChanged</a>(). </td>
</tr>
</table>
<a name="a7" doxytag="ID3_Frame::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"> size_t ID3_Frame::NumFields </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</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="frame_8cpp-source.html#l00151">151</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__impl_8cpp-source.html#l00167">ID3_FrameImpl::NumFields</a>(). </td>
</tr>
</table>
<a name="a10" doxytag="ID3_Frame::operator="></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_Frame & ID3_Frame::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const ID3_Frame & </td>
<td class="mdname1" valign="top" nowrap> <em>rFrame</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="frame_8cpp-source.html#l00174">174</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>. </td>
</tr>
</table>
<a name="a12" doxytag="ID3_Frame::Parse"></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"> bool ID3_Frame::Parse </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="class_i_d3___reader.html">ID3_Reader</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>reader</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="frame_8cpp-source.html#l00198">198</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__parse_8cpp-source.html#l00108">ID3_FrameImpl::Parse</a>(). </td>
</tr>
</table>
<a name="a13" doxytag="ID3_Frame::Render"></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"> void ID3_Frame::Render </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="class_i_d3___writer.html">ID3_Writer</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>writer</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const</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="frame_8cpp-source.html#l00203">203</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__render_8cpp-source.html#l00071">ID3_FrameImpl::Render</a>(). </td>
</tr>
</table>
<a name="a18" doxytag="ID3_Frame::SetCompression"></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"> bool ID3_Frame::SetCompression </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>b</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>
Sets the compression flag within the frame.
<p>
When the compression flag is is set, compression will be attempted. However, the frame might not actually be compressed after it is rendered if the "compressed" data is no smaller than the "uncompressed" data.
<p>
Definition at line <a class="el" href="frame_8cpp-source.html#l00218">218</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__impl_8h-source.html#l00080">ID3_FrameImpl::SetCompression</a>(). </td>
</tr>
</table>
<a name="a21" doxytag="ID3_Frame::SetEncryptionID"></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"> bool ID3_Frame::SetEncryptionID </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="globals_8h.html#a33">uchar</a> </td>
<td class="mdname1" valign="top" nowrap> <em>id</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="frame_8cpp-source.html#l00241">241</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__impl_8h-source.html#l00092">ID3_FrameImpl::SetEncryptionID</a>(), and <a class="el" href="globals_8h-source.html#l00087">uchar</a>. </td>
</tr>
</table>
<a name="a23" doxytag="ID3_Frame::SetGroupingID"></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"> bool ID3_Frame::SetGroupingID </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="globals_8h.html#a33">uchar</a> </td>
<td class="mdname1" valign="top" nowrap> <em>id</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="frame_8cpp-source.html#l00251">251</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__impl_8h-source.html#l00101">ID3_FrameImpl::SetGroupingID</a>(), and <a class="el" href="globals_8h-source.html#l00087">uchar</a>. </td>
</tr>
</table>
<a name="a4" doxytag="ID3_Frame::SetID"></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"> bool ID3_Frame::SetID </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>id</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>
Establishes the internal structure of an <a class="el" href="class_i_d3___frame_impl.html">ID3_FrameImpl</a> object so that it represents the id3v2 frame indicated by the parameter.
<p>
Given an ID3_FrameID (a list of which is found in <<a class="el" href="field_8h.html">id3/field.h</a>>), <a class="el" href="class_i_d3___frame.html#a4">SetID</a>() will structure the object according to the frame you wish to implement.
<p>
Either using this call or via the constructor, this must be the first command performed on an <a class="el" href="class_i_d3___frame_impl.html">ID3_FrameImpl</a> object.
<p>
<div class="fragment"><pre> myFrame.SetID(<a class="code" href="globals_8h.html#a219a131">ID3FID_TITLE</a>);
</pre></div><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>id</em> </td><td>
The type of frame this frame should be set to </td></tr>
</table>
</dl><dl compact><dt><b>
See also: </b><dd>
<a class="el" href="globals_8h.html#a219">ID3_FrameID</a> </dl>
<p>
Definition at line <a class="el" href="frame_8cpp-source.html#l00115">115</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="globals_8h-source.html#l00207">ID3_FrameID</a>, and <a class="el" href="frame__impl_8cpp-source.html#l00121">ID3_FrameImpl::SetID</a>(). </td>
</tr>
</table>
<a name="a16" doxytag="ID3_Frame::SetSpec"></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"> bool ID3_Frame::SetSpec </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="globals_8h.html#a216">ID3_V2Spec</a> </td>
<td class="mdname1" valign="top" nowrap> <em>spec</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="frame_8cpp-source.html#l00120">120</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="globals_8h-source.html#l00139">ID3_V2Spec</a>, and <a class="el" href="frame__impl_8cpp-source.html#l00140">ID3_FrameImpl::SetSpec</a>(). </td>
</tr>
</table>
<a name="a14" doxytag="ID3_Frame::Size"></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_Frame::Size </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="frame_8cpp-source.html#l00163">163</a> of file <a class="el" href="frame_8cpp-source.html">frame.cpp</a>.
<p>
References <a class="el" href="frame__impl_8cpp-source.html#l00172">ID3_FrameImpl::Size</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li>src/<a class="el" href="frame_8cpp-source.html">frame.cpp</a><li>include/id3/<a class="el" href="frame_8h-source.html">frame.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
>
35
