mirror of
https://github.com/cookiengineer/audacity
synced 2025-06-19 17:40:15 +02:00
135 lines
9.2 KiB
HTML
135 lines
9.2 KiB
HTML
<!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"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.8"/>
|
|
<title>FLAC: FLAC++/metadata.h: metadata level 2 interface</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">FLAC
|
|
 <span id="projectnumber">1.3.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.8 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">FLAC++/metadata.h: metadata level 2 interface<div class="ingroups"><a class="el" href="group__flacpp.html">FLAC C++ API</a> » <a class="el" href="group__flacpp__metadata.html">FLAC++/metadata.h: metadata interfaces</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Chain.html">FLAC::Metadata::Chain</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Chain_1_1Status.html">FLAC::Metadata::Chain::Status</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1Iterator.html">FLAC::Metadata::Iterator</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:gae49fa399a6273ccad7cb0e6f787a3f5c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__flacpp__metadata__level2.html#gae49fa399a6273ccad7cb0e6f787a3f5c">FLAC::Metadata::Prototype::Prototype</a> (const Prototype &)</td></tr>
|
|
<tr class="separator:gae49fa399a6273ccad7cb0e6f787a3f5c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga3d03bfec2cd09578f166fcd463b56d4f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3d03bfec2cd09578f166fcd463b56d4f"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>FLAC::Metadata::Prototype::Prototype</b> (const ::<a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> &)</td></tr>
|
|
<tr class="separator:ga3d03bfec2cd09578f166fcd463b56d4f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1b39c0561f84c3529302dc68b1ba8a2e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1b39c0561f84c3529302dc68b1ba8a2e"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>FLAC::Metadata::Prototype::Prototype</b> (const ::<a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *)</td></tr>
|
|
<tr class="separator:ga1b39c0561f84c3529302dc68b1ba8a2e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<p>Level 2 metadata iterator. </p>
|
|
<p>The flow through the iterator in the C++ layer is similar to the C layer:</p><ul>
|
|
<li>Create a <a class="el" href="classFLAC_1_1Metadata_1_1Chain.html">Chain</a> instance</li>
|
|
<li>Check <a class="el" href="classFLAC_1_1Metadata_1_1Chain.html#a7c7799a4ed676ac334381af9e3888549" title="Returns true iff object was properly constructed. ">Chain::is_valid()</a></li>
|
|
<li>Call <a class="el" href="classFLAC_1_1Metadata_1_1Chain.html#a509bf6a75a12df65bc77947a4765d9c1" title="See FLAC__metadata_chain_read(), FLAC__metadata_chain_read_ogg(). ">Chain::read()</a> and check the return</li>
|
|
<li>Traverse and/or edit with an <a class="el" href="classFLAC_1_1Metadata_1_1Iterator.html">Iterator</a> or with <a class="el" href="classFLAC_1_1Metadata_1_1Chain.html#aef51a0414284f468a2d73c07b540641d" title="See FLAC__metadata_chain_merge_padding(). ">Chain::merge_padding()</a> or <a class="el" href="classFLAC_1_1Metadata_1_1Chain.html#a779eaac12da7e7edac67089053e5907f" title="See FLAC__metadata_chain_sort_padding(). ">Chain::sort_padding()</a></li>
|
|
<li>Write changes back to FLAC file with <a class="el" href="classFLAC_1_1Metadata_1_1Chain.html#a2341690885e2312013afc561e6fafd81" title="See FLAC__metadata_chain_write(). ">Chain::write()</a></li>
|
|
<li>Destroy the <a class="el" href="classFLAC_1_1Metadata_1_1Chain.html">Chain</a> instance</li>
|
|
</ul>
|
|
<p>The ownership of pointers in the C++ layer is slightly different than in the C layer, i.e.</p><ul>
|
|
<li>The objects returned by <a class="el" href="classFLAC_1_1Metadata_1_1Iterator.html#a3693233f592b9cb333c437413c6be2a6" title="See FLAC__metadata_iterator_get_block(). ">Iterator::get_block()</a> are NOT owned by the iterator and should be deleted by the caller when finished, BUT, when you modify the block, it will directly edit what's in the chain and you do not need to call <a class="el" href="classFLAC_1_1Metadata_1_1Iterator.html#a3123daf89fca2a8981c9f361f466a418" title="See FLAC__metadata_iterator_set_block(). ">Iterator::set_block()</a>. However the changes will not be reflected in the FLAC file until the chain is written with <a class="el" href="classFLAC_1_1Metadata_1_1Chain.html#a2341690885e2312013afc561e6fafd81" title="See FLAC__metadata_chain_write(). ">Chain::write()</a>.</li>
|
|
<li>When you pass an object to <a class="el" href="classFLAC_1_1Metadata_1_1Iterator.html#a3123daf89fca2a8981c9f361f466a418" title="See FLAC__metadata_iterator_set_block(). ">Iterator::set_block()</a>, <a class="el" href="classFLAC_1_1Metadata_1_1Iterator.html#a86de6d0b21ac08b74a2ea8c1a9adce36" title="See FLAC__metadata_iterator_insert_block_before(). ">Iterator::insert_block_before()</a>, or <a class="el" href="classFLAC_1_1Metadata_1_1Iterator.html#a73e7a3f7192f369cb3a19d078da504ab" title="See FLAC__metadata_iterator_insert_block_after(). ">Iterator::insert_block_after()</a>, the iterator takes ownership of the block and it will be deleted by the chain.</li>
|
|
</ul>
|
|
<p>See the <a class="el" href="group__flac__metadata__level2.html">C layer equivalent </a> for more. </p>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a class="anchor" id="gae49fa399a6273ccad7cb0e6f787a3f5c"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">FLAC::Metadata::Prototype::Prototype </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classFLAC_1_1Metadata_1_1Prototype.html">Prototype</a> & </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Constructs a copy of the given object. This form always performs a deep copy. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
|
|
<hr size="1">
|
|
<div class="copyright">
|
|
<!-- @@@ oh so hacky -->
|
|
<table>
|
|
<tr>
|
|
<td align="left">
|
|
Copyright (c) 2000-2009 Josh Coalson
|
|
Copyright (c) 2011-2014 Xiph.Org Foundation
|
|
</td>
|
|
<td width="1%" align="right">
|
|
<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>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<!-- Copyright (c) 2000-2009 Josh Coalson -->
|
|
<!-- Copyright (c) 2011-2014 Xiph.Org Foundation -->
|
|
<!-- Permission is granted to copy, distribute and/or modify this document -->
|
|
<!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
|
|
<!-- or any later version published by the Free Software Foundation; -->
|
|
<!-- with no invariant sections. -->
|
|
<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
|
|
</body>
|
|
</html>
|