group__flacpp__metadata__level1.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
<!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.13"/>
<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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">FLAC
 <span id="projectnumber">1.3.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
<div class="summary">
<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> » <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_1SimpleIterator.html">FLAC::Metadata::SimpleIterator</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </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="classFLAC_1_1Metadata_1_1SimpleIterator.html#a5d528419f9c71d92b71d1d79cff52207" title="Returns true iff object was properly constructed. ">SimpleIterator::is_valid()</a></li>
<li>Call <a class="el" href="classFLAC_1_1Metadata_1_1SimpleIterator.html#a67dc75f18d282f41696467f1fbf5c3e8" 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"/>
<div class="copyright">
<!-- @@@ oh so hacky -->
<table>
<tr>
<td align="left">
Copyright (c) 2000-2009 Josh Coalson
Copyright (c) 2011-2016 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-2016 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>