~ubuntu-branches/ubuntu/precise/flac/precise-updates

« back to all changes in this revision

Viewing changes to doc/html/api/group__flacpp__metadata__level2.html

  • Committer: Bazaar Package Importer
  • Author(s): Joshua Kwan
  • Date: 2007-05-29 22:56:36 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070529225636-ljeff8xxip09qaap
Tags: 1.1.4-1
* New upstream release. closes: #405167, #411311
  - libOggFLAC and libOggFLAC++ have been merged into libFLAC, so
    remove their corresponding packages.
  - Because of the API changes required to effect the above, there has
    been yet another soname bump. libflac7 -> libflac8 and
    libflac++5 -> libflac++6. Emails have been dispatched to the
    maintainers of dependent packages.
* Some notes on patches that were removed:
  - 02_stdin_stdout, 06_manpage_mention_utf8_convert: merged upstream
  - 08_manpage_warnings: Upstream has changed the manpage so it defintely
    can't fit in in 80 cols, so just forget about it. We'll live.
  - 05_eof_warnings_are_errors: Upstream decided to add a -w option to
    flac to treat all warnings as errors. I am going to defer to that
    for now, but if people think it's stupid let me know and I'll port
    the patch forward.
  - 04_stack_smasher: was a backport from 1.1.3, so it's obsolete.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3
 
<title>FLAC++/metadata.h: metadata level 2 interface</title>
 
3
<title>FLAC: FLAC++/metadata.h: metadata level 2 interface</title>
4
4
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
5
</head><body>
6
 
<!-- Generated by Doxygen 1.2.14 -->
7
 
<center>
8
 
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="modules.html">Modules</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
9
 
<hr><h1>FLAC++/metadata.h: metadata level 2 interface<br>
 
6
<!-- Generated by Doxygen 1.4.2 -->
 
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>
 
8
<h1>FLAC++/metadata.h: metadata level 2 interface<br>
10
9
<small>
11
10
[<a class="el" href="group__flacpp__metadata.html">FLAC++/metadata.h: metadata interfaces</a>]</small>
12
 
</h1>Level 2 metadata iterator. 
13
 
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
14
 
<tr><td colspan=2><br><h2>Compounds</h2></td></tr>
15
 
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classFLAC_1_1Metadata_1_1Chain.html">FLAC::Metadata::Chain</a></td></tr>
16
 
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classFLAC_1_1Metadata_1_1Iterator.html">FLAC::Metadata::Iterator</a></td></tr>
 
11
</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
 
12
Level 2 metadata iterator. 
 
13
<p>
 
14
The flow through the iterator in the C++ layer is similar to the C layer:<ul>
 
15
<li>Create a Chain instance</li><li>Check Chain::is_valid()</li><li>Call Chain::read() and check the return</li><li>Traverse and/or edit with an Iterator or with Chain::merge_padding() or Chain::sort_padding()</li><li>Write changes back to FLAC file with Chain::write()</li><li>Destroy the Chain instance</li></ul>
 
16
<p>
 
17
The ownership of pointers in the C++ layer is slightly different than in the C layer, i.e.<ul>
 
18
<li>The objects returned by Iterator::get_block() 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 Iterator::set_block(). However the changes will not be reflected in the FLAC file until the chain is written with Chain::write().</li><li>When you pass an object to Iterator::set_block(), Iterator::insert_block_before(), or Iterator::insert_block_after(), the iterator takes ownership of the block and it will be deleted by the chain.</li></ul>
 
19
<p>
 
20
See the <a class="el" href="group__flac__metadata__level2.html">C layer equivalent </a> for more. 
 
21
<p>
 
22
<table border="0" cellpadding="0" cellspacing="0">
 
23
<tr><td></td></tr>
 
24
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
 
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_1Chain.html">FLAC::Metadata::Chain</a></td></tr>
 
26
 
 
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_1Iterator.html">FLAC::Metadata::Iterator</a></td></tr>
 
28
 
17
29
</table>
18
 
<hr><a name="_details"></a><h2>Detailed Description</h2>
19
 
Level 2 metadata iterator.
20
 
<p>
21
30
 
22
 
<p>
23
 
 The flow through the iterator in the C++ layer is similar to the C layer:<ul>
24
 
<li>Create a Chain instance<li>Check Chain::is_valid()<li>Call Chain::read() and check the return<li>Traverse and/or edit with an Iterator or with Chain::merge_padding() or Chain::sort_padding()<li>Write changes back to FLAC file with Chain::write()<li>Destroy the Chain instance</ul>
25
 
The ownership of pointers in the C++ layer is slightly different than in the C layer, i.e.<ul>
26
 
<li>The objects returned by Iterator::get_block() 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 Iterator::set_block(). However the changes will not be reflected in the FLAC file until the chain is written with Chain::write().<li>When you pass an object to Iterator::set_block(), Iterator::insert_block_before(), or Iterator::insert_block_after(), the iterator takes ownership of the block and it will be deleted by the chain.</ul>
27
 
See the <a class="el" href="group__flac__metadata__level2.html">C layer equivalent</a> for more. <hr><address><small>Generated on Fri Feb 4 18:39:18 2005 for FLAC by
28
 
<a href="http://www.doxygen.org/index.html">
29
 
<img src="doxygen.gif" alt="doxygen" align="middle" border=0 
30
 
width=110 height=53></a>1.2.14 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
31
 
 &copy;&nbsp;1997-2002</small></address>
 
31
<hr size="1">
 
32
<div class="copyright">
 
33
        <!-- @@@ oh so hacky -->
 
34
        <table>
 
35
                <tr>
 
36
                        <td align="left">
 
37
                                Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007  Josh Coalson
 
38
                        </td>
 
39
                        <td width="1%" align="right">
 
40
                                <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>
 
41
                        </td>
 
42
                </tr>
 
43
        </table>
 
44
</div>
 
45
<!-- Copyright (c)  2000,2001,2002,2003,2004,2005,2006,2007  Josh Coalson -->
 
46
<!-- Permission is granted to copy, distribute and/or modify this document -->
 
47
<!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
 
48
<!-- or any later version published by the Free Software Foundation; -->
 
49
<!-- with no invariant sections. -->
 
50
<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
32
51
</body>
33
52
</html>