Mercurial > hg > sv-dependency-builds

annotate src/flac-1.2.1/doc/html/api/group__flacpp__metadata__object.html @ 1:05aa0afa9217

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Bring in flac, ogg, vorbis
author Chris Cannam
date Tue, 19 Mar 2013 17:37:49 +0000
parents
children
rev   line source
Chris@1 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
Chris@1 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
Chris@1 3 <title>FLAC: FLAC++/metadata.h: metadata object classes</title>
Chris@1 4 <link href="doxygen.css" rel="stylesheet" type="text/css">
Chris@1 5 </head><body>
Chris@1 6 <!-- Generated by Doxygen 1.4.2 -->
Chris@1 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>
Chris@1 8 <h1>FLAC++/metadata.h: metadata object classes<br>
Chris@1 9 <small>
Chris@1 10 [<a class="el" href="group__flacpp__metadata.html">FLAC++/metadata.h: metadata interfaces</a>]</small>
Chris@1 11 </h1><hr><a name="_details"></a><h2>Detailed Description</h2>
Chris@1 12 This module contains classes representing FLAC metadata blocks in memory.<p>
Chris@1 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>
Chris@1 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>
Chris@1 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>
Chris@1 16
Chris@1 17 <p>
Chris@1 18 <table border="0" cellpadding="0" cellspacing="0">
Chris@1 19 <tr><td></td></tr>
Chris@1 20 <tr><td colspan="2"><br><h2>Classes</h2></td></tr>
Chris@1 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>
Chris@1 22
Chris@1 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>
Chris@1 24
Chris@1 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>
Chris@1 26
Chris@1 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>
Chris@1 28
Chris@1 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>
Chris@1 30
Chris@1 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>
Chris@1 32
Chris@1 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>
Chris@1 34
Chris@1 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>
Chris@1 36
Chris@1 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>
Chris@1 38
Chris@1 39 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
Chris@1 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>
Chris@1 41
Chris@1 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>
Chris@1 43
Chris@1 44 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga2" doxytag="flacpp_metadata_object::operator=="></a>
Chris@1 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>
Chris@1 46
Chris@1 47 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga3" doxytag="flacpp_metadata_object::operator=="></a>
Chris@1 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>
Chris@1 49
Chris@1 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>
Chris@1 51
Chris@1 52 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga5" doxytag="flacpp_metadata_object::operator!="></a>
Chris@1 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>
Chris@1 54
Chris@1 55 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga6" doxytag="flacpp_metadata_object::operator!="></a>
Chris@1 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>
Chris@1 57
Chris@1 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>
Chris@1 59
Chris@1 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>
Chris@1 61
Chris@1 62 </table>
Chris@1 63 <hr><h2>Function Documentation</h2>
Chris@1 64 <a class="anchor" name="ga0" doxytag="FLAC::Metadata::clone"></a><p>
Chris@1 65 <table class="mdTable" cellpadding="2" cellspacing="0">
Chris@1 66 <tr>
Chris@1 67 <td class="mdRow">
Chris@1 68 <table cellpadding="0" cellspacing="0" border="0">
Chris@1 69 <tr>
Chris@1 70 <td class="md" nowrap valign="top">Prototype* FLAC::Metadata::clone </td>
Chris@1 71 <td class="md" valign="top">(&nbsp;</td>
Chris@1 72 <td class="md" nowrap valign="top">const Prototype *&nbsp;</td>
Chris@1 73 <td class="mdname1" valign="top" nowrap> </td>
Chris@1 74 <td class="md" valign="top">&nbsp;)&nbsp;</td>
Chris@1 75 <td class="md" nowrap></td>
Chris@1 76 </tr>
Chris@1 77 </table>
Chris@1 78 </td>
Chris@1 79 </tr>
Chris@1 80 </table>
Chris@1 81 <table cellspacing="5" cellpadding="0" border="0">
Chris@1 82 <tr>
Chris@1 83 <td>
Chris@1 84 &nbsp;
Chris@1 85 </td>
Chris@1 86 <td>
Chris@1 87
Chris@1 88 <p>
Chris@1 89 Create a deep copy of an object and return it. </td>
Chris@1 90 </tr>
Chris@1 91 </table>
Chris@1 92 <a class="anchor" name="ga1" doxytag="FLAC::Metadata::Prototype::operator=="></a><p>
Chris@1 93 <table class="mdTable" cellpadding="2" cellspacing="0">
Chris@1 94 <tr>
Chris@1 95 <td class="mdRow">
Chris@1 96 <table cellpadding="0" cellspacing="0" border="0">
Chris@1 97 <tr>
Chris@1 98 <td class="md" nowrap valign="top">bool FLAC::Metadata::Prototype::operator== </td>
Chris@1 99 <td class="md" valign="top">(&nbsp;</td>
Chris@1 100 <td class="md" nowrap valign="top">const <a class="el" href="classFLAC_1_1Metadata_1_1Prototype.html">Prototype</a> &amp;&nbsp;</td>
Chris@1 101 <td class="mdname1" valign="top" nowrap> </td>
Chris@1 102 <td class="md" valign="top">&nbsp;)&nbsp;</td>
Chris@1 103 <td class="md" nowrap> const<code> [inline, inherited]</code></td>
Chris@1 104 </tr>
Chris@1 105 </table>
Chris@1 106 </td>
Chris@1 107 </tr>
Chris@1 108 </table>
Chris@1 109 <table cellspacing="5" cellpadding="0" border="0">
Chris@1 110 <tr>
Chris@1 111 <td>
Chris@1 112 &nbsp;
Chris@1 113 </td>
Chris@1 114 <td>
Chris@1 115
Chris@1 116 <p>
Chris@1 117 Check for equality, performing a deep compare by following pointers. </td>
Chris@1 118 </tr>
Chris@1 119 </table>
Chris@1 120 <a class="anchor" name="ga4" doxytag="FLAC::Metadata::Prototype::operator!="></a><p>
Chris@1 121 <table class="mdTable" cellpadding="2" cellspacing="0">
Chris@1 122 <tr>
Chris@1 123 <td class="mdRow">
Chris@1 124 <table cellpadding="0" cellspacing="0" border="0">
Chris@1 125 <tr>
Chris@1 126 <td class="md" nowrap valign="top">bool FLAC::Metadata::Prototype::operator!= </td>
Chris@1 127 <td class="md" valign="top">(&nbsp;</td>
Chris@1 128 <td class="md" nowrap valign="top">const <a class="el" href="classFLAC_1_1Metadata_1_1Prototype.html">Prototype</a> &amp;&nbsp;</td>
Chris@1 129 <td class="mdname1" valign="top" nowrap> </td>
Chris@1 130 <td class="md" valign="top">&nbsp;)&nbsp;</td>
Chris@1 131 <td class="md" nowrap> const<code> [inline, inherited]</code></td>
Chris@1 132 </tr>
Chris@1 133 </table>
Chris@1 134 </td>
Chris@1 135 </tr>
Chris@1 136 </table>
Chris@1 137 <table cellspacing="5" cellpadding="0" border="0">
Chris@1 138 <tr>
Chris@1 139 <td>
Chris@1 140 &nbsp;
Chris@1 141 </td>
Chris@1 142 <td>
Chris@1 143
Chris@1 144 <p>
Chris@1 145 Check for inequality, performing a deep compare by following pointers. </td>
Chris@1 146 </tr>
Chris@1 147 </table>
Chris@1 148 <a class="anchor" name="ga7" doxytag="FLAC::Metadata::Prototype::is_valid"></a><p>
Chris@1 149 <table class="mdTable" cellpadding="2" cellspacing="0">
Chris@1 150 <tr>
Chris@1 151 <td class="mdRow">
Chris@1 152 <table cellpadding="0" cellspacing="0" border="0">
Chris@1 153 <tr>
Chris@1 154 <td class="md" nowrap valign="top">bool FLAC::Metadata::Prototype::is_valid </td>
Chris@1 155 <td class="md" valign="top">(&nbsp;</td>
Chris@1 156 <td class="mdname1" valign="top" nowrap> </td>
Chris@1 157 <td class="md" valign="top">&nbsp;)&nbsp;</td>
Chris@1 158 <td class="md" nowrap> const<code> [inline, inherited]</code></td>
Chris@1 159 </tr>
Chris@1 160 </table>
Chris@1 161 </td>
Chris@1 162 </tr>
Chris@1 163 </table>
Chris@1 164 <table cellspacing="5" cellpadding="0" border="0">
Chris@1 165 <tr>
Chris@1 166 <td>
Chris@1 167 &nbsp;
Chris@1 168 </td>
Chris@1 169 <td>
Chris@1 170
Chris@1 171 <p>
Chris@1 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>
Chris@1 173 </tr>
Chris@1 174 </table>
Chris@1 175 <a class="anchor" name="ga8" doxytag="FLAC::Metadata::Prototype::operator const ::FLAC__StreamMetadata *"></a><p>
Chris@1 176 <table class="mdTable" cellpadding="2" cellspacing="0">
Chris@1 177 <tr>
Chris@1 178 <td class="mdRow">
Chris@1 179 <table cellpadding="0" cellspacing="0" border="0">
Chris@1 180 <tr>
Chris@1 181 <td class="md" nowrap valign="top">FLAC::Metadata::Prototype::operator const ::<a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> * </td>
Chris@1 182 <td class="md" valign="top">(&nbsp;</td>
Chris@1 183 <td class="mdname1" valign="top" nowrap> </td>
Chris@1 184 <td class="md" valign="top">&nbsp;)&nbsp;</td>
Chris@1 185 <td class="md" nowrap> const<code> [inline, inherited]</code></td>
Chris@1 186 </tr>
Chris@1 187 </table>
Chris@1 188 </td>
Chris@1 189 </tr>
Chris@1 190 </table>
Chris@1 191 <table cellspacing="5" cellpadding="0" border="0">
Chris@1 192 <tr>
Chris@1 193 <td>
Chris@1 194 &nbsp;
Chris@1 195 </td>
Chris@1 196 <td>
Chris@1 197
Chris@1 198 <p>
Chris@1 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>
Chris@1 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>()
Chris@1 201 </pre></div> </dd></dl>
Chris@1 202 </td>
Chris@1 203 </tr>
Chris@1 204 </table>
Chris@1 205
Chris@1 206 <hr size="1">
Chris@1 207 <div class="copyright">
Chris@1 208 <!-- @@@ oh so hacky -->
Chris@1 209 <table>
Chris@1 210 <tr>
Chris@1 211 <td align="left">
Chris@1 212 Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson
Chris@1 213 </td>
Chris@1 214 <td width="1%" align="right">
Chris@1 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>
Chris@1 216 </td>
Chris@1 217 </tr>
Chris@1 218 </table>
Chris@1 219 </div>
Chris@1 220 <!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson -->
Chris@1 221 <!-- Permission is granted to copy, distribute and/or modify this document -->
Chris@1 222 <!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
Chris@1 223 <!-- or any later version published by the Free Software Foundation; -->
Chris@1 224 <!-- with no invariant sections. -->
Chris@1 225 <!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
Chris@1 226 </body>
Chris@1 227 </html>