furnace/extern/flac/doc/api/group__flacpp__metadata__level1.html
2025-10-22 16:16:07 -05:00

86 lines
5.1 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FLAC: FLAC++/metadata.h: metadata level 1 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 id="projectrow">
<td id="projectalign">
<div id="projectname">FLAC<span id="projectnumber">&#160;1.5.0</span>
</div>
<div id="projectbrief">Free Lossless Audio Codec</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> &#124;
<a href="#nested-classes">Classes</a> </div>
<div class="headertitle"><div class="title">FLAC++/metadata.h: metadata level 1 interface<div class="ingroups"><a class="el" href="group__flacpp.html">FLAC C++ API</a> &raquo; <a class="el" href="group__flacpp__metadata.html">FLAC++/metadata.h: metadata interfaces</a> &raquo; <a class="el" href="group__flacpp__metadata__object.html">FLAC++/metadata.h: metadata object classes</a> &raquo; <a class="el" href="group__flacpp__metadata__level0.html">FLAC++/metadata.h: metadata level 0 interface</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="groups" name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__flacpp__metadata__level2" id="r_group__flacpp__metadata__level2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flacpp__metadata__level2.html">FLAC++/metadata.h: metadata level 2 interface</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFLAC_1_1Metadata_1_1SimpleIterator.html">FLAC::Metadata::SimpleIterator</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Level 1 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_1SimpleIterator.html">SimpleIterator</a> instance</li>
<li>Check <a class="el" href="group__flacpp__metadata__level2.html#ga5d528419f9c71d92b71d1d79cff52207" title="Returns true iff object was properly constructed.">SimpleIterator::is_valid()</a></li>
<li>Call <a class="el" href="group__flacpp__metadata__level2.html#ga67dc75f18d282f41696467f1fbf5c3e8" title="See FLAC__metadata_simple_iterator_init().">SimpleIterator::init()</a> and check the return</li>
<li>Traverse and/or edit. Edits are written to file immediately.</li>
<li>Destroy the <a class="el" href="classFLAC_1_1Metadata_1_1SimpleIterator.html">SimpleIterator</a> instance</li>
</ul>
<p>The ownership of pointers in the C++ layer follows that in the C layer, i.e.</p><ul>
<li>The objects returned by get_block() are yours to modify, but changes are not reflected in the FLAC file until you call set_block(). The objects are also yours to delete; they are not automatically deleted when passed to set_block() or insert_block_after().</li>
</ul>
<p>See the <a class="el" href="group__flac__metadata__level1.html">C layer equivalent </a> for more. </p>
</div><!-- contents -->
<hr size="1"/>
Copyright (c) 2000-2009 Josh Coalson
Copyright (c) 2011-2025 Xiph.Org Foundation
<!-- Copyright (c) 2000-2009 Josh Coalson -->
<!-- Copyright (c) 2011-2025 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.3 -->
<!-- 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>