1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3<title>FLAC: FLAC::Metadata::Chain Class Reference</title> 4<link href="doxygen.css" rel="stylesheet" type="text/css"> 5</head><body> 6<!-- Generated by Doxygen 1.4.2 --> 7<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div> 8<div class="nav"> 9<b>FLAC</b>::<b>Metadata</b>::<a class="el" href="classFLAC_1_1Metadata_1_1Chain.html">Chain</a></div> 10<h1>FLAC::Metadata::Chain Class Reference<br> 11<small> 12[<a class="el" href="group__flacpp__metadata__level2.html">FLAC++/metadata.h: metadata level 2 interface</a>]</small> 13</h1><code>#include <<a class="el" href="+_2metadata_8h-source.html">metadata.h</a>></code> 14<p> 15<a href="classFLAC_1_1Metadata_1_1Chain-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> 16This class is a wrapper around the FLAC__metadata_chain structures and methods; see the <a class="el" href="group__flacpp__metadata__level2.html">usage guide </a> and <a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a>. 17<p> 18<table border="0" cellpadding="0" cellspacing="0"> 19<tr><td></td></tr> 20<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> 21<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Chain.html#FLAC_1_1Metadata_1_1Chaina2">is_valid</a> () const </td></tr> 22 23<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classFLAC_1_1Metadata_1_1Chain_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Chain.html#FLAC_1_1Metadata_1_1Chaina3">status</a> ()</td></tr> 24 25<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Chain.html#FLAC_1_1Metadata_1_1Chaina4">read</a> (const char *filename, bool is_ogg=false)</td></tr> 26 27<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Chain.html#FLAC_1_1Metadata_1_1Chaina5">read</a> (<a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle, <a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a> callbacks, bool is_ogg=false)</td></tr> 28 29<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Chain.html#FLAC_1_1Metadata_1_1Chaina6">check_if_tempfile_needed</a> (bool use_padding)</td></tr> 30 31<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Chain.html#FLAC_1_1Metadata_1_1Chaina7">write</a> (bool use_padding=true, bool preserve_file_stats=false)</td></tr> 32 33<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Chain.html#FLAC_1_1Metadata_1_1Chaina8">write</a> (bool use_padding,::<a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle,::<a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a> callbacks)</td></tr> 34 35<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Chain.html#FLAC_1_1Metadata_1_1Chaina9">write</a> (bool use_padding,::<a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> handle,::<a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a> callbacks,::<a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> temp_handle,::<a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a> temp_callbacks)</td></tr> 36 37<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Chain.html#FLAC_1_1Metadata_1_1Chaina10">merge_padding</a> ()</td></tr> 38 39<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Chain.html#FLAC_1_1Metadata_1_1Chaina11">sort_padding</a> ()</td></tr> 40 41<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> 42<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="FLAC_1_1Metadata_1_1Chainb0" doxytag="FLAC::Metadata::Chain::clear"></a> 43virtual void </td><td class="memItemRight" valign="bottom"><b>clear</b> ()</td></tr> 44 45<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> 46<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="FLAC_1_1Metadata_1_1Chainp0" doxytag="FLAC::Metadata::Chain::chain_"></a> 47::<a class="el" href="group__flac__metadata__level2.html#ga0">FLAC__Metadata_Chain</a> * </td><td class="memItemRight" valign="bottom"><b>chain_</b></td></tr> 48 49<tr><td colspan="2"><br><h2>Friends</h2></td></tr> 50<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="FLAC_1_1Metadata_1_1Chainn0" doxytag="FLAC::Metadata::Chain::Iterator"></a> 51class </td><td class="memItemRight" valign="bottom"><b>Iterator</b></td></tr> 52 53<tr><td colspan="2"><br><h2>Classes</h2></td></tr> 54<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Chain_1_1Status.html">Status</a></td></tr> 55 56</table> 57<hr><h2>Member Function Documentation</h2> 58<a class="anchor" name="FLAC_1_1Metadata_1_1Chaina2" doxytag="FLAC::Metadata::Chain::is_valid"></a><p> 59<table class="mdTable" cellpadding="2" cellspacing="0"> 60 <tr> 61 <td class="mdRow"> 62 <table cellpadding="0" cellspacing="0" border="0"> 63 <tr> 64 <td class="md" nowrap valign="top">bool FLAC::Metadata::Chain::is_valid </td> 65 <td class="md" valign="top">( </td> 66 <td class="mdname1" valign="top" nowrap> </td> 67 <td class="md" valign="top"> ) </td> 68 <td class="md" nowrap> const</td> 69 </tr> 70 </table> 71 </td> 72 </tr> 73</table> 74<table cellspacing="5" cellpadding="0" border="0"> 75 <tr> 76 <td> 77 78 </td> 79 <td> 80 81<p> 82Returns <code>true</code> iff object was properly constructed. 83<p> 84 </td> 85 </tr> 86</table> 87<a class="anchor" name="FLAC_1_1Metadata_1_1Chaina3" doxytag="FLAC::Metadata::Chain::status"></a><p> 88<table class="mdTable" cellpadding="2" cellspacing="0"> 89 <tr> 90 <td class="mdRow"> 91 <table cellpadding="0" cellspacing="0" border="0"> 92 <tr> 93 <td class="md" nowrap valign="top"><a class="el" href="classFLAC_1_1Metadata_1_1Chain_1_1Status.html">Status</a> FLAC::Metadata::Chain::status </td> 94 <td class="md" valign="top">( </td> 95 <td class="mdname1" valign="top" nowrap> </td> 96 <td class="md" valign="top"> ) </td> 97 <td class="md" nowrap></td> 98 </tr> 99 </table> 100 </td> 101 </tr> 102</table> 103<table cellspacing="5" cellpadding="0" border="0"> 104 <tr> 105 <td> 106 107 </td> 108 <td> 109 110<p> 111See <a class="el" href="group__flac__metadata__level2.html#ga5">FLAC__metadata_chain_status()</a>. 112<p> 113 </td> 114 </tr> 115</table> 116<a class="anchor" name="FLAC_1_1Metadata_1_1Chaina4" doxytag="FLAC::Metadata::Chain::read"></a><p> 117<table class="mdTable" cellpadding="2" cellspacing="0"> 118 <tr> 119 <td class="mdRow"> 120 <table cellpadding="0" cellspacing="0" border="0"> 121 <tr> 122 <td class="md" nowrap valign="top">bool FLAC::Metadata::Chain::read </td> 123 <td class="md" valign="top">( </td> 124 <td class="md" nowrap valign="top">const char * </td> 125 <td class="mdname" nowrap> <em>filename</em>, </td> 126 </tr> 127 <tr> 128 <td class="md" nowrap align="right"></td> 129 <td class="md"></td> 130 <td class="md" nowrap>bool </td> 131 <td class="mdname" nowrap> <em>is_ogg</em> = <code>false</code></td> 132 </tr> 133 <tr> 134 <td class="md"></td> 135 <td class="md">) </td> 136 <td class="md" colspan="2"></td> 137 </tr> 138 </table> 139 </td> 140 </tr> 141</table> 142<table cellspacing="5" cellpadding="0" border="0"> 143 <tr> 144 <td> 145 146 </td> 147 <td> 148 149<p> 150See <a class="el" href="group__flac__metadata__level2.html#ga6">FLAC__metadata_chain_read()</a>, <a class="el" href="group__flac__metadata__level2.html#ga7">FLAC__metadata_chain_read_ogg()</a>. 151<p> 152 </td> 153 </tr> 154</table> 155<a class="anchor" name="FLAC_1_1Metadata_1_1Chaina5" doxytag="FLAC::Metadata::Chain::read"></a><p> 156<table class="mdTable" cellpadding="2" cellspacing="0"> 157 <tr> 158 <td class="mdRow"> 159 <table cellpadding="0" cellspacing="0" border="0"> 160 <tr> 161 <td class="md" nowrap valign="top">bool FLAC::Metadata::Chain::read </td> 162 <td class="md" valign="top">( </td> 163 <td class="md" nowrap valign="top"><a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> </td> 164 <td class="mdname" nowrap> <em>handle</em>, </td> 165 </tr> 166 <tr> 167 <td class="md" nowrap align="right"></td> 168 <td class="md"></td> 169 <td class="md" nowrap><a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a> </td> 170 <td class="mdname" nowrap> <em>callbacks</em>, </td> 171 </tr> 172 <tr> 173 <td class="md" nowrap align="right"></td> 174 <td class="md"></td> 175 <td class="md" nowrap>bool </td> 176 <td class="mdname" nowrap> <em>is_ogg</em> = <code>false</code></td> 177 </tr> 178 <tr> 179 <td class="md"></td> 180 <td class="md">) </td> 181 <td class="md" colspan="2"></td> 182 </tr> 183 </table> 184 </td> 185 </tr> 186</table> 187<table cellspacing="5" cellpadding="0" border="0"> 188 <tr> 189 <td> 190 191 </td> 192 <td> 193 194<p> 195See <a class="el" href="group__flac__metadata__level2.html#ga8">FLAC__metadata_chain_read_with_callbacks()</a>, <a class="el" href="group__flac__metadata__level2.html#ga9">FLAC__metadata_chain_read_ogg_with_callbacks()</a>. 196<p> 197 </td> 198 </tr> 199</table> 200<a class="anchor" name="FLAC_1_1Metadata_1_1Chaina6" doxytag="FLAC::Metadata::Chain::check_if_tempfile_needed"></a><p> 201<table class="mdTable" cellpadding="2" cellspacing="0"> 202 <tr> 203 <td class="mdRow"> 204 <table cellpadding="0" cellspacing="0" border="0"> 205 <tr> 206 <td class="md" nowrap valign="top">bool FLAC::Metadata::Chain::check_if_tempfile_needed </td> 207 <td class="md" valign="top">( </td> 208 <td class="md" nowrap valign="top">bool </td> 209 <td class="mdname1" valign="top" nowrap> <em>use_padding</em> </td> 210 <td class="md" valign="top"> ) </td> 211 <td class="md" nowrap></td> 212 </tr> 213 </table> 214 </td> 215 </tr> 216</table> 217<table cellspacing="5" cellpadding="0" border="0"> 218 <tr> 219 <td> 220 221 </td> 222 <td> 223 224<p> 225See <a class="el" href="group__flac__metadata__level2.html#ga10">FLAC__metadata_chain_check_if_tempfile_needed()</a>. 226<p> 227 </td> 228 </tr> 229</table> 230<a class="anchor" name="FLAC_1_1Metadata_1_1Chaina7" doxytag="FLAC::Metadata::Chain::write"></a><p> 231<table class="mdTable" cellpadding="2" cellspacing="0"> 232 <tr> 233 <td class="mdRow"> 234 <table cellpadding="0" cellspacing="0" border="0"> 235 <tr> 236 <td class="md" nowrap valign="top">bool FLAC::Metadata::Chain::write </td> 237 <td class="md" valign="top">( </td> 238 <td class="md" nowrap valign="top">bool </td> 239 <td class="mdname" nowrap> <em>use_padding</em> = <code>true</code>, </td> 240 </tr> 241 <tr> 242 <td class="md" nowrap align="right"></td> 243 <td class="md"></td> 244 <td class="md" nowrap>bool </td> 245 <td class="mdname" nowrap> <em>preserve_file_stats</em> = <code>false</code></td> 246 </tr> 247 <tr> 248 <td class="md"></td> 249 <td class="md">) </td> 250 <td class="md" colspan="2"></td> 251 </tr> 252 </table> 253 </td> 254 </tr> 255</table> 256<table cellspacing="5" cellpadding="0" border="0"> 257 <tr> 258 <td> 259 260 </td> 261 <td> 262 263<p> 264See <a class="el" href="group__flac__metadata__level2.html#ga11">FLAC__metadata_chain_write()</a>. 265<p> 266 </td> 267 </tr> 268</table> 269<a class="anchor" name="FLAC_1_1Metadata_1_1Chaina8" doxytag="FLAC::Metadata::Chain::write"></a><p> 270<table class="mdTable" cellpadding="2" cellspacing="0"> 271 <tr> 272 <td class="mdRow"> 273 <table cellpadding="0" cellspacing="0" border="0"> 274 <tr> 275 <td class="md" nowrap valign="top">bool FLAC::Metadata::Chain::write </td> 276 <td class="md" valign="top">( </td> 277 <td class="md" nowrap valign="top">bool </td> 278 <td class="mdname" nowrap> <em>use_padding</em>, </td> 279 </tr> 280 <tr> 281 <td class="md" nowrap align="right"></td> 282 <td class="md"></td> 283 <td class="md" nowrap>::<a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> </td> 284 <td class="mdname" nowrap> <em>handle</em>, </td> 285 </tr> 286 <tr> 287 <td class="md" nowrap align="right"></td> 288 <td class="md"></td> 289 <td class="md" nowrap>::<a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a> </td> 290 <td class="mdname" nowrap> <em>callbacks</em></td> 291 </tr> 292 <tr> 293 <td class="md"></td> 294 <td class="md">) </td> 295 <td class="md" colspan="2"></td> 296 </tr> 297 </table> 298 </td> 299 </tr> 300</table> 301<table cellspacing="5" cellpadding="0" border="0"> 302 <tr> 303 <td> 304 305 </td> 306 <td> 307 308<p> 309See <a class="el" href="group__flac__metadata__level2.html#ga12">FLAC__metadata_chain_write_with_callbacks()</a>. 310<p> 311 </td> 312 </tr> 313</table> 314<a class="anchor" name="FLAC_1_1Metadata_1_1Chaina9" doxytag="FLAC::Metadata::Chain::write"></a><p> 315<table class="mdTable" cellpadding="2" cellspacing="0"> 316 <tr> 317 <td class="mdRow"> 318 <table cellpadding="0" cellspacing="0" border="0"> 319 <tr> 320 <td class="md" nowrap valign="top">bool FLAC::Metadata::Chain::write </td> 321 <td class="md" valign="top">( </td> 322 <td class="md" nowrap valign="top">bool </td> 323 <td class="mdname" nowrap> <em>use_padding</em>, </td> 324 </tr> 325 <tr> 326 <td class="md" nowrap align="right"></td> 327 <td class="md"></td> 328 <td class="md" nowrap>::<a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> </td> 329 <td class="mdname" nowrap> <em>handle</em>, </td> 330 </tr> 331 <tr> 332 <td class="md" nowrap align="right"></td> 333 <td class="md"></td> 334 <td class="md" nowrap>::<a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a> </td> 335 <td class="mdname" nowrap> <em>callbacks</em>, </td> 336 </tr> 337 <tr> 338 <td class="md" nowrap align="right"></td> 339 <td class="md"></td> 340 <td class="md" nowrap>::<a class="el" href="group__flac__callbacks.html#ga0">FLAC__IOHandle</a> </td> 341 <td class="mdname" nowrap> <em>temp_handle</em>, </td> 342 </tr> 343 <tr> 344 <td class="md" nowrap align="right"></td> 345 <td class="md"></td> 346 <td class="md" nowrap>::<a class="el" href="structFLAC____IOCallbacks.html">FLAC__IOCallbacks</a> </td> 347 <td class="mdname" nowrap> <em>temp_callbacks</em></td> 348 </tr> 349 <tr> 350 <td class="md"></td> 351 <td class="md">) </td> 352 <td class="md" colspan="2"></td> 353 </tr> 354 </table> 355 </td> 356 </tr> 357</table> 358<table cellspacing="5" cellpadding="0" border="0"> 359 <tr> 360 <td> 361 362 </td> 363 <td> 364 365<p> 366See <a class="el" href="group__flac__metadata__level2.html#ga13">FLAC__metadata_chain_write_with_callbacks_and_tempfile()</a>. 367<p> 368 </td> 369 </tr> 370</table> 371<a class="anchor" name="FLAC_1_1Metadata_1_1Chaina10" doxytag="FLAC::Metadata::Chain::merge_padding"></a><p> 372<table class="mdTable" cellpadding="2" cellspacing="0"> 373 <tr> 374 <td class="mdRow"> 375 <table cellpadding="0" cellspacing="0" border="0"> 376 <tr> 377 <td class="md" nowrap valign="top">void FLAC::Metadata::Chain::merge_padding </td> 378 <td class="md" valign="top">( </td> 379 <td class="mdname1" valign="top" nowrap> </td> 380 <td class="md" valign="top"> ) </td> 381 <td class="md" nowrap></td> 382 </tr> 383 </table> 384 </td> 385 </tr> 386</table> 387<table cellspacing="5" cellpadding="0" border="0"> 388 <tr> 389 <td> 390 391 </td> 392 <td> 393 394<p> 395See <a class="el" href="group__flac__metadata__level2.html#ga14">FLAC__metadata_chain_merge_padding()</a>. 396<p> 397 </td> 398 </tr> 399</table> 400<a class="anchor" name="FLAC_1_1Metadata_1_1Chaina11" doxytag="FLAC::Metadata::Chain::sort_padding"></a><p> 401<table class="mdTable" cellpadding="2" cellspacing="0"> 402 <tr> 403 <td class="mdRow"> 404 <table cellpadding="0" cellspacing="0" border="0"> 405 <tr> 406 <td class="md" nowrap valign="top">void FLAC::Metadata::Chain::sort_padding </td> 407 <td class="md" valign="top">( </td> 408 <td class="mdname1" valign="top" nowrap> </td> 409 <td class="md" valign="top"> ) </td> 410 <td class="md" nowrap></td> 411 </tr> 412 </table> 413 </td> 414 </tr> 415</table> 416<table cellspacing="5" cellpadding="0" border="0"> 417 <tr> 418 <td> 419 420 </td> 421 <td> 422 423<p> 424See <a class="el" href="group__flac__metadata__level2.html#ga15">FLAC__metadata_chain_sort_padding()</a>. 425<p> 426 </td> 427 </tr> 428</table> 429<hr>The documentation for this class was generated from the following file:<ul> 430<li>include/FLAC++/<a class="el" href="+_2metadata_8h-source.html">metadata.h</a></ul> 431 432<hr size="1"> 433<div class="copyright"> 434 <!-- @@@ oh so hacky --> 435 <table> 436 <tr> 437 <td align="left"> 438 Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson 439 </td> 440 <td width="1%" align="right"> 441 <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a> 442 </td> 443 </tr> 444 </table> 445</div> 446<!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson --> 447<!-- Permission is granted to copy, distribute and/or modify this document --> 448<!-- under the terms of the GNU Free Documentation License, Version 1.1 --> 449<!-- or any later version published by the Free Software Foundation; --> 450<!-- with no invariant sections. --> 451<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html --> 452</body> 453</html> 454