Mercurial > hg > sv-dependency-builds

annotate src/flac-1.2.1/doc/html/api/group__flacpp__metadata__object.html @ 86:98c1576536ae

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Bring in flac, ogg, vorbis
author Chris Cannam <cannam@all-day-breakfast.com>
date Tue, 19 Mar 2013 17:37:49 +0000
parents
children
rev   line source
cannam@86 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
cannam@86 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
cannam@86 3 <title>FLAC: FLAC++/metadata.h: metadata object classes</title>
cannam@86 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
cannam@86 5 </head><body>
cannam@86 6 <!-- Generated by Doxygen 1.4.2 -->
cannam@86 7 <div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
cannam@86 8 <h1>FLAC++/metadata.h: metadata object classes<br>
cannam@86 9 <small>
cannam@86 10 [<a class="el" href="group__flacpp__metadata.html">FLAC++/metadata.h: metadata interfaces</a>]</small>
cannam@86 11 </h1><hr><a name="_details"></a><h2>Detailed Description</h2>
cannam@86 12 This module contains classes representing FLAC metadata blocks in memory.<p>
cannam@86 13 The behavior closely mimics the C layer interface; be sure to read the detailed description of the <a class="el" href="group__flac__metadata__object.html">C metadata object module </a>.<p>
cannam@86 14 Any time a metadata object is constructed or assigned, you should check is_valid() to make sure the underlying <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> object was able to be created.<p>
cannam@86 15 <dl compact><dt><b>Warning:</b></dt><dd>When the get_*() methods of any metadata object method return you a const pointer, DO NOT disobey and write into it. Always use the set_*() methods. </dd></dl>
cannam@86 16
cannam@86 17 <p>
cannam@86 18 <table border="0" cellpadding="0" cellspacing="0">
cannam@86 19 <tr><td></td></tr>
cannam@86 20 <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
cannam@86 21 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Prototype.html">FLAC::Metadata::Prototype</a></td></tr>
cannam@86 22
cannam@86 23 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1StreamInfo.html">FLAC::Metadata::StreamInfo</a></td></tr>
cannam@86 24
cannam@86 25 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Padding.html">FLAC::Metadata::Padding</a></td></tr>
cannam@86 26
cannam@86 27 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Application.html">FLAC::Metadata::Application</a></td></tr>
cannam@86 28
cannam@86 29 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1SeekTable.html">FLAC::Metadata::SeekTable</a></td></tr>
cannam@86 30
cannam@86 31 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1VorbisComment.html">FLAC::Metadata::VorbisComment</a></td></tr>
cannam@86 32
cannam@86 33 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1CueSheet.html">FLAC::Metadata::CueSheet</a></td></tr>
cannam@86 34
cannam@86 35 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Picture.html">FLAC::Metadata::Picture</a></td></tr>
cannam@86 36
cannam@86 37 <tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Unknown.html">FLAC::Metadata::Unknown</a></td></tr>
cannam@86 38
cannam@86 39 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
cannam@86 40 <tr><td class="memItemLeft" nowrap align="right" valign="top">Prototype *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flacpp__metadata__object.html#ga0">FLAC::Metadata::clone</a> (const Prototype *)</td></tr>
cannam@86 41
cannam@86 42 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flacpp__metadata__object.html#ga1">FLAC::Metadata::Prototype::operator==</a> (const Prototype &amp;) const </td></tr>
cannam@86 43
cannam@86 44 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga2" doxytag="flacpp_metadata_object::operator=="></a>
cannam@86 45 bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const ::<a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> &amp;) const </td></tr>
cannam@86 46
cannam@86 47 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga3" doxytag="flacpp_metadata_object::operator=="></a>
cannam@86 48 bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const ::<a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *) const </td></tr>
cannam@86 49
cannam@86 50 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flacpp__metadata__object.html#ga4">FLAC::Metadata::Prototype::operator!=</a> (const Prototype &amp;) const </td></tr>
cannam@86 51
cannam@86 52 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga5" doxytag="flacpp_metadata_object::operator!="></a>
cannam@86 53 bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const ::<a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> &amp;) const </td></tr>
cannam@86 54
cannam@86 55 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga6" doxytag="flacpp_metadata_object::operator!="></a>
cannam@86 56 bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const ::<a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *) const </td></tr>
cannam@86 57
cannam@86 58 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flacpp__metadata__object.html#ga7">FLAC::Metadata::Prototype::is_valid</a> () const </td></tr>
cannam@86 59
cannam@86 60 <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flacpp__metadata__object.html#ga8">FLAC::Metadata::Prototype::operator const ::FLAC__StreamMetadata *</a> () const </td></tr>
cannam@86 61
cannam@86 62 </table>
cannam@86 63 <hr><h2>Function Documentation</h2>
cannam@86 64 <a class="anchor" name="ga0" doxytag="FLAC::Metadata::clone"></a><p>
cannam@86 65 <table class="mdTable" cellpadding="2" cellspacing="0">
cannam@86 66 <tr>
cannam@86 67 <td class="mdRow">
cannam@86 68 <table cellpadding="0" cellspacing="0" border="0">
cannam@86 69 <tr>
cannam@86 70 <td class="md" nowrap valign="top">Prototype* FLAC::Metadata::clone </td>
cannam@86 71 <td class="md" valign="top">(&nbsp;</td>
cannam@86 72 <td class="md" nowrap valign="top">const Prototype *&nbsp;</td>
cannam@86 73 <td class="mdname1" valign="top" nowrap> </td>
cannam@86 74 <td class="md" valign="top">&nbsp;)&nbsp;</td>
cannam@86 75 <td class="md" nowrap></td>
cannam@86 76 </tr>
cannam@86 77 </table>
cannam@86 78 </td>
cannam@86 79 </tr>
cannam@86 80 </table>
cannam@86 81 <table cellspacing="5" cellpadding="0" border="0">
cannam@86 82 <tr>
cannam@86 83 <td>
cannam@86 84 &nbsp;
cannam@86 85 </td>
cannam@86 86 <td>
cannam@86 87
cannam@86 88 <p>
cannam@86 89 Create a deep copy of an object and return it. </td>
cannam@86 90 </tr>
cannam@86 91 </table>
cannam@86 92 <a class="anchor" name="ga1" doxytag="FLAC::Metadata::Prototype::operator=="></a><p>
cannam@86 93 <table class="mdTable" cellpadding="2" cellspacing="0">
cannam@86 94 <tr>
cannam@86 95 <td class="mdRow">
cannam@86 96 <table cellpadding="0" cellspacing="0" border="0">
cannam@86 97 <tr>
cannam@86 98 <td class="md" nowrap valign="top">bool FLAC::Metadata::Prototype::operator== </td>
cannam@86 99 <td class="md" valign="top">(&nbsp;</td>
cannam@86 100 <td class="md" nowrap valign="top">const <a class="el" href="classFLAC_1_1Metadata_1_1Prototype.html">Prototype</a> &amp;&nbsp;</td>
cannam@86 101 <td class="mdname1" valign="top" nowrap> </td>
cannam@86 102 <td class="md" valign="top">&nbsp;)&nbsp;</td>
cannam@86 103 <td class="md" nowrap> const<code> [inline, inherited]</code></td>
cannam@86 104 </tr>
cannam@86 105 </table>
cannam@86 106 </td>
cannam@86 107 </tr>
cannam@86 108 </table>
cannam@86 109 <table cellspacing="5" cellpadding="0" border="0">
cannam@86 110 <tr>
cannam@86 111 <td>
cannam@86 112 &nbsp;
cannam@86 113 </td>
cannam@86 114 <td>
cannam@86 115
cannam@86 116 <p>
cannam@86 117 Check for equality, performing a deep compare by following pointers. </td>
cannam@86 118 </tr>
cannam@86 119 </table>
cannam@86 120 <a class="anchor" name="ga4" doxytag="FLAC::Metadata::Prototype::operator!="></a><p>
cannam@86 121 <table class="mdTable" cellpadding="2" cellspacing="0">
cannam@86 122 <tr>
cannam@86 123 <td class="mdRow">
cannam@86 124 <table cellpadding="0" cellspacing="0" border="0">
cannam@86 125 <tr>
cannam@86 126 <td class="md" nowrap valign="top">bool FLAC::Metadata::Prototype::operator!= </td>
cannam@86 127 <td class="md" valign="top">(&nbsp;</td>
cannam@86 128 <td class="md" nowrap valign="top">const <a class="el" href="classFLAC_1_1Metadata_1_1Prototype.html">Prototype</a> &amp;&nbsp;</td>
cannam@86 129 <td class="mdname1" valign="top" nowrap> </td>
cannam@86 130 <td class="md" valign="top">&nbsp;)&nbsp;</td>
cannam@86 131 <td class="md" nowrap> const<code> [inline, inherited]</code></td>
cannam@86 132 </tr>
cannam@86 133 </table>
cannam@86 134 </td>
cannam@86 135 </tr>
cannam@86 136 </table>
cannam@86 137 <table cellspacing="5" cellpadding="0" border="0">
cannam@86 138 <tr>
cannam@86 139 <td>
cannam@86 140 &nbsp;
cannam@86 141 </td>
cannam@86 142 <td>
cannam@86 143
cannam@86 144 <p>
cannam@86 145 Check for inequality, performing a deep compare by following pointers. </td>
cannam@86 146 </tr>
cannam@86 147 </table>
cannam@86 148 <a class="anchor" name="ga7" doxytag="FLAC::Metadata::Prototype::is_valid"></a><p>
cannam@86 149 <table class="mdTable" cellpadding="2" cellspacing="0">
cannam@86 150 <tr>
cannam@86 151 <td class="mdRow">
cannam@86 152 <table cellpadding="0" cellspacing="0" border="0">
cannam@86 153 <tr>
cannam@86 154 <td class="md" nowrap valign="top">bool FLAC::Metadata::Prototype::is_valid </td>
cannam@86 155 <td class="md" valign="top">(&nbsp;</td>
cannam@86 156 <td class="mdname1" valign="top" nowrap> </td>
cannam@86 157 <td class="md" valign="top">&nbsp;)&nbsp;</td>
cannam@86 158 <td class="md" nowrap> const<code> [inline, inherited]</code></td>
cannam@86 159 </tr>
cannam@86 160 </table>
cannam@86 161 </td>
cannam@86 162 </tr>
cannam@86 163 </table>
cannam@86 164 <table cellspacing="5" cellpadding="0" border="0">
cannam@86 165 <tr>
cannam@86 166 <td>
cannam@86 167 &nbsp;
cannam@86 168 </td>
cannam@86 169 <td>
cannam@86 170
cannam@86 171 <p>
cannam@86 172 Returns <code>true</code> if the object was correctly constructed (i.e. the underlying <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> object was properly allocated), else <code>false</code>. </td>
cannam@86 173 </tr>
cannam@86 174 </table>
cannam@86 175 <a class="anchor" name="ga8" doxytag="FLAC::Metadata::Prototype::operator const ::FLAC__StreamMetadata *"></a><p>
cannam@86 176 <table class="mdTable" cellpadding="2" cellspacing="0">
cannam@86 177 <tr>
cannam@86 178 <td class="mdRow">
cannam@86 179 <table cellpadding="0" cellspacing="0" border="0">
cannam@86 180 <tr>
cannam@86 181 <td class="md" nowrap valign="top">FLAC::Metadata::Prototype::operator const ::<a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> * </td>
cannam@86 182 <td class="md" valign="top">(&nbsp;</td>
cannam@86 183 <td class="mdname1" valign="top" nowrap> </td>
cannam@86 184 <td class="md" valign="top">&nbsp;)&nbsp;</td>
cannam@86 185 <td class="md" nowrap> const<code> [inline, inherited]</code></td>
cannam@86 186 </tr>
cannam@86 187 </table>
cannam@86 188 </td>
cannam@86 189 </tr>
cannam@86 190 </table>
cannam@86 191 <table cellspacing="5" cellpadding="0" border="0">
cannam@86 192 <tr>
cannam@86 193 <td>
cannam@86 194 &nbsp;
cannam@86 195 </td>
cannam@86 196 <td>
cannam@86 197
cannam@86 198 <p>
cannam@86 199 Returns a pointer to the underlying <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> object. This can be useful for plugging any holes between the C++ and C interfaces.<p>
cannam@86 200 <dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> <a class="code" href="group__flacpp__metadata__object.html#ga7">is_valid</a>()
cannam@86 201 </pre></div> </dd></dl>
cannam@86 202 </td>
cannam@86 203 </tr>
cannam@86 204 </table>
cannam@86 205
cannam@86 206 <hr size="1">
cannam@86 207 <div class="copyright">
cannam@86 208 <!-- @@@ oh so hacky -->
cannam@86 209 <table>
cannam@86 210 <tr>
cannam@86 211 <td align="left">
cannam@86 212 Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson
cannam@86 213 </td>
cannam@86 214 <td width="1%" align="right">
cannam@86 215 <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&amp;type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a>
cannam@86 216 </td>
cannam@86 217 </tr>
cannam@86 218 </table>
cannam@86 219 </div>
cannam@86 220 <!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson -->
cannam@86 221 <!-- Permission is granted to copy, distribute and/or modify this document -->
cannam@86 222 <!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
cannam@86 223 <!-- or any later version published by the Free Software Foundation; -->
cannam@86 224 <!-- with no invariant sections. -->
cannam@86 225 <!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
cannam@86 226 </body>
cannam@86 227 </html>