← Back to branch summary

~ubuntu-branches/ubuntu/raring/flac/raring

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Joshua Kwan
  • Date: 2007-05-29 22:56:36 UTC
  • mto: (8.1.1 lenny)
  • mto: This revision was merged to the branch mainline in revision 9.
  • Revision ID: james.westby@ubuntu.com-20070529225636-p8lkii0r0kp50pns
Tags: upstream-1.1.4
Import upstream version 1.1.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/api/group__flac__metadata__level1.html
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 1 interface</title>
 
3
<title>FLAC: FLAC/metadata.h: metadata level 1 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 1 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 1 interface<br>
10
9
<small>
11
10
[<a class="el" href="group__flac__metadata.html">FLAC/metadata.h: metadata interfaces</a>]</small>
12
 
</h1>The level 1 interface provides read-write access to FLAC file metadata and operates directly on the FLAC file. 
13
 
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
14
 
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
15
 
<tr><td nowrap align=right valign=top>typedef FLAC__Metadata_SimpleIterator&nbsp;</td><td valign=bottom><a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a></td></tr>
16
 
<tr><td colspan=2><br><h2>Enumerations</h2></td></tr>
17
 
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="group__flac__metadata__level1.html#a14">FLAC__Metadata_SimpleIteratorStatus</a> { <br>
18
 
&nbsp;&nbsp;<a class="el" href="group__flac__metadata__level1.html#a14a5">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK</a> =  0, 
19
 
<a class="el" href="group__flac__metadata__level1.html#a14a6">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT</a>, 
20
 
<a class="el" href="group__flac__metadata__level1.html#a14a7">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ERROR_OPENING_FILE</a>, 
21
 
<a class="el" href="group__flac__metadata__level1.html#a14a8">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_A_FLAC_FILE</a>, 
22
 
<br>
23
 
&nbsp;&nbsp;<a class="el" href="group__flac__metadata__level1.html#a14a9">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_WRITABLE</a>, 
24
 
<a class="el" href="group__flac__metadata__level1.html#a14a10">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_BAD_METADATA</a>, 
25
 
<a class="el" href="group__flac__metadata__level1.html#a14a11">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR</a>, 
26
 
<a class="el" href="group__flac__metadata__level1.html#a14a12">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR</a>, 
27
 
<br>
28
 
&nbsp;&nbsp;<a class="el" href="group__flac__metadata__level1.html#a14a13">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR</a>, 
29
 
<a class="el" href="group__flac__metadata__level1.html#a14a14">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_RENAME_ERROR</a>, 
30
 
<a class="el" href="group__flac__metadata__level1.html#a14a15">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_UNLINK_ERROR</a>, 
31
 
<a class="el" href="group__flac__metadata__level1.html#a14a16">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR</a>, 
32
 
<br>
33
 
&nbsp;&nbsp;<a class="el" href="group__flac__metadata__level1.html#a14a17">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_INTERNAL_ERROR</a>
 
11
</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
 
12
The level 1 interface provides read-write access to FLAC file metadata and operates directly on the FLAC file. 
 
13
<p>
 
14
The general usage of this interface is:<p>
 
15
<ul>
 
16
<li>Create an iterator using <a class="el" href="group__flac__metadata__level1.html#ga2">FLAC__metadata_simple_iterator_new()</a></li><li>Attach it to a file using <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> and check the exit code. Call <a class="el" href="group__flac__metadata__level1.html#ga6">FLAC__metadata_simple_iterator_is_writable()</a> to see if the file is writable, or only read access is allowed.</li><li>Use <a class="el" href="group__flac__metadata__level1.html#ga7">FLAC__metadata_simple_iterator_next()</a> and <a class="el" href="group__flac__metadata__level1.html#ga8">FLAC__metadata_simple_iterator_prev()</a> to traverse the blocks. This is does not read the actual blocks themselves. <a class="el" href="group__flac__metadata__level1.html#ga7">FLAC__metadata_simple_iterator_next()</a> is relatively fast. <a class="el" href="group__flac__metadata__level1.html#ga8">FLAC__metadata_simple_iterator_prev()</a> is slower since it needs to search forward from the front of the file.</li><li>Use <a class="el" href="group__flac__metadata__level1.html#ga9">FLAC__metadata_simple_iterator_get_block_type()</a> or <a class="el" href="group__flac__metadata__level1.html#ga10">FLAC__metadata_simple_iterator_get_block()</a> to access the actual data at the current iterator position. The returned object is yours to modify and free.</li><li>Use <a class="el" href="group__flac__metadata__level1.html#ga11">FLAC__metadata_simple_iterator_set_block()</a> to write a modified block back. You must have write permission to the original file. Make sure to read the whole comment to <a class="el" href="group__flac__metadata__level1.html#ga11">FLAC__metadata_simple_iterator_set_block()</a> below.</li><li>Use <a class="el" href="group__flac__metadata__level1.html#ga12">FLAC__metadata_simple_iterator_insert_block_after()</a> to add new blocks. Use the object creation functions from <a class="el" href="group__flac__metadata__object.html">here </a> to generate new objects.</li><li>Use <a class="el" href="group__flac__metadata__level1.html#ga13">FLAC__metadata_simple_iterator_delete_block()</a> to remove the block currently referred to by the iterator, or replace it with padding.</li><li>Destroy the iterator with <a class="el" href="group__flac__metadata__level1.html#ga3">FLAC__metadata_simple_iterator_delete()</a> when finished.</li></ul>
 
17
<p>
 
18
<dl compact><dt><b>Note:</b></dt><dd>The FLAC file remains open the whole time between <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> and <a class="el" href="group__flac__metadata__level1.html#ga3">FLAC__metadata_simple_iterator_delete()</a>, so make sure you are not altering the file during this time.<p>
 
19
Do not modify the <em>is_last</em>, <em>length</em>, or <em>type</em> fields of returned <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> objects. These are managed automatically.<p>
 
20
If any of the modification functions (<a class="el" href="group__flac__metadata__level1.html#ga11">FLAC__metadata_simple_iterator_set_block()</a>, <a class="el" href="group__flac__metadata__level1.html#ga13">FLAC__metadata_simple_iterator_delete_block()</a>, <a class="el" href="group__flac__metadata__level1.html#ga12">FLAC__metadata_simple_iterator_insert_block_after()</a>, etc.) return <code>false</code>, you should delete the iterator as it may no longer be valid. </dd></dl>
 
21
 
 
22
<p>
 
23
<table border="0" cellpadding="0" cellspacing="0">
 
24
<tr><td></td></tr>
 
25
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
 
26
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a></td></tr>
 
27
 
 
28
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
 
29
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga14">FLAC__Metadata_SimpleIteratorStatus</a> { <br>
 
30
&nbsp;&nbsp;<a class="el" href="group__flac__metadata__level1.html#gga14a5">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK</a> =  0, 
 
31
<a class="el" href="group__flac__metadata__level1.html#gga14a6">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT</a>, 
 
32
<a class="el" href="group__flac__metadata__level1.html#gga14a7">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ERROR_OPENING_FILE</a>, 
 
33
<a class="el" href="group__flac__metadata__level1.html#gga14a8">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_A_FLAC_FILE</a>, 
 
34
<br>
 
35
&nbsp;&nbsp;<a class="el" href="group__flac__metadata__level1.html#gga14a9">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_WRITABLE</a>, 
 
36
<a class="el" href="group__flac__metadata__level1.html#gga14a10">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_BAD_METADATA</a>, 
 
37
<a class="el" href="group__flac__metadata__level1.html#gga14a11">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR</a>, 
 
38
<a class="el" href="group__flac__metadata__level1.html#gga14a12">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR</a>, 
 
39
<br>
 
40
&nbsp;&nbsp;<a class="el" href="group__flac__metadata__level1.html#gga14a13">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR</a>, 
 
41
<a class="el" href="group__flac__metadata__level1.html#gga14a14">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_RENAME_ERROR</a>, 
 
42
<a class="el" href="group__flac__metadata__level1.html#gga14a15">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_UNLINK_ERROR</a>, 
 
43
<a class="el" href="group__flac__metadata__level1.html#gga14a16">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR</a>, 
 
44
<br>
 
45
&nbsp;&nbsp;<a class="el" href="group__flac__metadata__level1.html#gga14a17">FLAC__METADATA_SIMPLE_ITERATOR_STATUS_INTERNAL_ERROR</a>
34
46
<br>
35
47
 }</td></tr>
36
 
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
37
 
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td><td valign=bottom><a class="el" href="group__flac__metadata__level1.html#a2">FLAC__metadata_simple_iterator_new</a> ()</td></tr>
38
 
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="group__flac__metadata__level1.html#a3">FLAC__metadata_simple_iterator_delete</a> (<a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr>
39
 
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__metadata__level1.html#a14">FLAC__Metadata_SimpleIteratorStatus</a>&nbsp;</td><td valign=bottom><a class="el" href="group__flac__metadata__level1.html#a4">FLAC__metadata_simple_iterator_status</a> (<a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr>
40
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__metadata__level1.html#a5">FLAC__metadata_simple_iterator_init</a> (<a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *iterator, const char *filename, FLAC__bool read_only, FLAC__bool preserve_file_stats)</td></tr>
41
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__metadata__level1.html#a6">FLAC__metadata_simple_iterator_is_writable</a> (const <a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr>
42
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__metadata__level1.html#a7">FLAC__metadata_simple_iterator_next</a> (<a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr>
43
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__metadata__level1.html#a8">FLAC__metadata_simple_iterator_prev</a> (<a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr>
44
 
<tr><td nowrap align=right valign=top><a class="el" href="group__flac__format.html#a97">FLAC__MetadataType</a>&nbsp;</td><td valign=bottom><a class="el" href="group__flac__metadata__level1.html#a9">FLAC__metadata_simple_iterator_get_block_type</a> (const <a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr>
45
 
<tr><td nowrap align=right valign=top><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *&nbsp;</td><td valign=bottom><a class="el" href="group__flac__metadata__level1.html#a10">FLAC__metadata_simple_iterator_get_block</a> (<a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr>
46
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__metadata__level1.html#a11">FLAC__metadata_simple_iterator_set_block</a> (<a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *iterator, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *block, FLAC__bool use_padding)</td></tr>
47
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__metadata__level1.html#a12">FLAC__metadata_simple_iterator_insert_block_after</a> (<a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *iterator, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *block, FLAC__bool use_padding)</td></tr>
48
 
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__metadata__level1.html#a13">FLAC__metadata_simple_iterator_delete_block</a> (<a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *iterator, FLAC__bool use_padding)</td></tr>
49
 
<tr><td colspan=2><br><h2>Variables</h2></td></tr>
50
 
<tr><td nowrap align=right valign=top>const char *const&nbsp;</td><td valign=bottom><a class="el" href="group__flac__metadata__level1.html#a1">FLAC__Metadata_SimpleIteratorStatusString</a> []</td></tr>
 
48
 
 
49
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
 
50
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga2">FLAC__metadata_simple_iterator_new</a> (void)</td></tr>
 
51
 
 
52
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga3">FLAC__metadata_simple_iterator_delete</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr>
 
53
 
 
54
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__flac__metadata__level1.html#ga14">FLAC__Metadata_SimpleIteratorStatus</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga4">FLAC__metadata_simple_iterator_status</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr>
 
55
 
 
56
<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator, const char *filename, FLAC__bool read_only, FLAC__bool preserve_file_stats)</td></tr>
 
57
 
 
58
<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga6">FLAC__metadata_simple_iterator_is_writable</a> (const <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr>
 
59
 
 
60
<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga7">FLAC__metadata_simple_iterator_next</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr>
 
61
 
 
62
<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga8">FLAC__metadata_simple_iterator_prev</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr>
 
63
 
 
64
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__flac__format.html#ga109">FLAC__MetadataType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga9">FLAC__metadata_simple_iterator_get_block_type</a> (const <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr>
 
65
 
 
66
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga10">FLAC__metadata_simple_iterator_get_block</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator)</td></tr>
 
67
 
 
68
<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga11">FLAC__metadata_simple_iterator_set_block</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *block, FLAC__bool use_padding)</td></tr>
 
69
 
 
70
<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga12">FLAC__metadata_simple_iterator_insert_block_after</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *block, FLAC__bool use_padding)</td></tr>
 
71
 
 
72
<tr><td class="memItemLeft" nowrap align="right" valign="top">FLAC__bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga13">FLAC__metadata_simple_iterator_delete_block</a> (<a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *iterator, FLAC__bool use_padding)</td></tr>
 
73
 
 
74
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
 
75
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *const&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level1.html#ga1">FLAC__Metadata_SimpleIteratorStatusString</a> []</td></tr>
 
76
 
51
77
</table>
52
 
<hr><a name="_details"></a><h2>Detailed Description</h2>
53
 
The level 1 interface provides read-write access to FLAC file metadata and operates directly on the FLAC file.
54
 
<p>
55
 
 
56
 
<p>
57
 
 The general usage of this interface is:
58
 
<p>
59
 
<ul>
60
 
<li>Create an iterator using <a class="el" href="group__flac__metadata__level1.html#a2">FLAC__metadata_simple_iterator_new</a>()<li>Attach it to a file using <a class="el" href="group__flac__metadata__level1.html#a5">FLAC__metadata_simple_iterator_init</a>() and check the exit code. Call <a class="el" href="group__flac__metadata__level1.html#a6">FLAC__metadata_simple_iterator_is_writable</a>() to see if the file is writable, or read-only access is allowed.<li>Use <a class="el" href="group__flac__metadata__level1.html#a7">FLAC__metadata_simple_iterator_next</a>() and <a class="el" href="group__flac__metadata__level1.html#a8">FLAC__metadata_simple_iterator_prev</a>() to move around the blocks. This is does not read the actual blocks themselves. <a class="el" href="group__flac__metadata__level1.html#a7">FLAC__metadata_simple_iterator_next</a>() is relatively fast. <a class="el" href="group__flac__metadata__level1.html#a8">FLAC__metadata_simple_iterator_prev</a>() is slower since it needs to search forward from the front of the file.<li>Use <a class="el" href="group__flac__metadata__level1.html#a9">FLAC__metadata_simple_iterator_get_block_type</a>() or <a class="el" href="group__flac__metadata__level1.html#a10">FLAC__metadata_simple_iterator_get_block</a>() to access the actual data at the current iterator position. The returned object is yours to modify and free.<li>Use <a class="el" href="group__flac__metadata__level1.html#a11">FLAC__metadata_simple_iterator_set_block</a>() to write a modified block back. You must have write permission to the original file. Make sure to read the whole comment to <a class="el" href="group__flac__metadata__level1.html#a11">FLAC__metadata_simple_iterator_set_block</a>() below.<li>Use <a class="el" href="group__flac__metadata__level1.html#a12">FLAC__metadata_simple_iterator_insert_block_after</a>() to add new blocks. Use the object creation functions from <a class="el" href="group__flac__metadata__object.html">here</a> to generate new objects.<li>Use <a class="el" href="group__flac__metadata__level1.html#a13">FLAC__metadata_simple_iterator_delete_block</a>() to remove the block currently referred to by the iterator, or replace it with padding.<li>Destroy the iterator with <a class="el" href="group__flac__metadata__level1.html#a3">FLAC__metadata_simple_iterator_delete</a>() when finished.</ul>
61
 
<dl compact><dt><b>
62
 
Note: </b><dd>
63
 
 The FLAC file remains open the whole time between <a class="el" href="group__flac__metadata__level1.html#a5">FLAC__metadata_simple_iterator_init</a>() and <a class="el" href="group__flac__metadata__level1.html#a3">FLAC__metadata_simple_iterator_delete</a>(), so make sure you are not altering the file during this time.</dl><dl compact><dt><b>
64
 
Note: </b><dd>
65
 
 Do not modify the <em>is_last</em>, <em>length</em>, or <em>type</em> fields of returned <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> objects. These are managed automatically.</dl><dl compact><dt><b>
66
 
Note: </b><dd>
67
 
 If any of the modification functions (<a class="el" href="group__flac__metadata__level1.html#a11">FLAC__metadata_simple_iterator_set_block</a>(), <a class="el" href="group__flac__metadata__level1.html#a13">FLAC__metadata_simple_iterator_delete_block</a>(), <a class="el" href="group__flac__metadata__level1.html#a12">FLAC__metadata_simple_iterator_insert_block_after</a>(), etc.) return <code>false</code>, you should delete the iterator as it may no longer be valid. </dl><hr><h2>Typedef Documentation</h2>
68
 
<a name="a0" doxytag="metadata.h::FLAC__Metadata_SimpleIterator"></a><p>
69
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
78
<hr><h2>Typedef Documentation</h2>
 
79
<a class="anchor" name="ga0" doxytag="metadata.h::FLAC__Metadata_SimpleIterator"></a><p>
 
80
<table class="mdTable" cellpadding="2" cellspacing="0">
70
81
  <tr>
71
 
    <td class="md">
 
82
    <td class="mdRow">
72
83
      <table cellpadding="0" cellspacing="0" border="0">
73
84
        <tr>
74
 
          <td class="md" nowrap valign="top"> typedef struct FLAC__Metadata_SimpleIterator FLAC__Metadata_SimpleIterator
 
85
          <td class="md" nowrap valign="top">typedef struct <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a>          </td>
 
86
        </tr>
75
87
      </table>
76
88
    </td>
77
89
  </tr>
78
90
</table>
79
 
<table cellspacing=5 cellpadding=0 border=0>
 
91
<table cellspacing="5" cellpadding="0" border="0">
80
92
  <tr>
81
93
    <td>
82
94
      &nbsp;
84
96
    <td>
85
97
 
86
98
<p>
87
 
The opaque structure definition for the level 1 iterator type. See the <a class="el" href="group__flac__metadata__level1.html">metadata level 1 module</a> for a detailed description.     </td>
 
99
The opaque structure definition for the level 1 iterator type. See the <a class="el" href="group__flac__metadata__level1.html">metadata level 1 module </a> for a detailed description.     </td>
88
100
  </tr>
89
101
</table>
90
102
<hr><h2>Enumeration Type Documentation</h2>
91
 
<a name="a14" doxytag="metadata.h::FLAC__Metadata_SimpleIteratorStatus"></a><p>
92
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
103
<a class="anchor" name="ga14" doxytag="metadata.h::FLAC__Metadata_SimpleIteratorStatus"></a><p>
 
104
<table class="mdTable" cellpadding="2" cellspacing="0">
93
105
  <tr>
94
 
    <td class="md">
 
106
    <td class="mdRow">
95
107
      <table cellpadding="0" cellspacing="0" border="0">
96
108
        <tr>
97
 
          <td class="md" nowrap valign="top"> enum FLAC__Metadata_SimpleIteratorStatus
 
109
          <td class="md" nowrap valign="top">enum <a class="el" href="group__flac__metadata__level1.html#ga14">FLAC__Metadata_SimpleIteratorStatus</a>          </td>
 
110
        </tr>
98
111
      </table>
99
112
    </td>
100
113
  </tr>
101
114
</table>
102
 
<table cellspacing=5 cellpadding=0 border=0>
 
115
<table cellspacing="5" cellpadding="0" border="0">
103
116
  <tr>
104
117
    <td>
105
118
      &nbsp;
107
120
    <td>
108
121
 
109
122
<p>
110
 
Status type for FLAC__Metadata_SimpleIterator.
111
 
<p>
112
 
The iterator's current status can be obtained by calling <a class="el" href="group__flac__metadata__level1.html#a4">FLAC__metadata_simple_iterator_status</a>(). <dl compact><dt><b>
113
 
Enumeration values:</b><dd>
114
 
<table border=0 cellspacing=2 cellpadding=0>
115
 
<tr><td valign=top><em><a name="a14a5" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK"></a><em>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK</em></em>&nbsp;</td><td>
 
123
Status type for FLAC__Metadata_SimpleIterator.<p>
 
124
The iterator's current status can be obtained by calling <a class="el" href="group__flac__metadata__level1.html#ga4">FLAC__metadata_simple_iterator_status()</a>. <dl compact><dt><b>Enumeration values: </b></dt><dd>
 
125
<table border="0" cellspacing="2" cellpadding="0">
 
126
<tr><td valign="top"><em><a class="anchor" name="gga14a5" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK</em>&nbsp;</td><td>
116
127
The iterator is in the normal OK state </td></tr>
117
 
<tr><td valign=top><em><a name="a14a6" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT"></a><em>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT</em></em>&nbsp;</td><td>
 
128
<tr><td valign="top"><em><a class="anchor" name="gga14a6" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ILLEGAL_INPUT</em>&nbsp;</td><td>
118
129
The data passed into a function violated the function's usage criteria </td></tr>
119
 
<tr><td valign=top><em><a name="a14a7" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ERROR_OPENING_FILE"></a><em>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ERROR_OPENING_FILE</em></em>&nbsp;</td><td>
 
130
<tr><td valign="top"><em><a class="anchor" name="gga14a7" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ERROR_OPENING_FILE"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_ERROR_OPENING_FILE</em>&nbsp;</td><td>
120
131
The iterator could not open the target file </td></tr>
121
 
<tr><td valign=top><em><a name="a14a8" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_A_FLAC_FILE"></a><em>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_A_FLAC_FILE</em></em>&nbsp;</td><td>
 
132
<tr><td valign="top"><em><a class="anchor" name="gga14a8" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_A_FLAC_FILE"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_A_FLAC_FILE</em>&nbsp;</td><td>
122
133
The iterator could not find the FLAC signature at the start of the file </td></tr>
123
 
<tr><td valign=top><em><a name="a14a9" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_WRITABLE"></a><em>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_WRITABLE</em></em>&nbsp;</td><td>
 
134
<tr><td valign="top"><em><a class="anchor" name="gga14a9" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_WRITABLE"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_NOT_WRITABLE</em>&nbsp;</td><td>
124
135
The iterator tried to write to a file that was not writable </td></tr>
125
 
<tr><td valign=top><em><a name="a14a10" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_BAD_METADATA"></a><em>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_BAD_METADATA</em></em>&nbsp;</td><td>
 
136
<tr><td valign="top"><em><a class="anchor" name="gga14a10" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_BAD_METADATA"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_BAD_METADATA</em>&nbsp;</td><td>
126
137
The iterator encountered input that does not conform to the FLAC metadata specification </td></tr>
127
 
<tr><td valign=top><em><a name="a14a11" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR"></a><em>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR</em></em>&nbsp;</td><td>
 
138
<tr><td valign="top"><em><a class="anchor" name="gga14a11" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_READ_ERROR</em>&nbsp;</td><td>
128
139
The iterator encountered an error while reading the FLAC file </td></tr>
129
 
<tr><td valign=top><em><a name="a14a12" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR"></a><em>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR</em></em>&nbsp;</td><td>
 
140
<tr><td valign="top"><em><a class="anchor" name="gga14a12" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_SEEK_ERROR</em>&nbsp;</td><td>
130
141
The iterator encountered an error while seeking in the FLAC file </td></tr>
131
 
<tr><td valign=top><em><a name="a14a13" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR"></a><em>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR</em></em>&nbsp;</td><td>
 
142
<tr><td valign="top"><em><a class="anchor" name="gga14a13" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_WRITE_ERROR</em>&nbsp;</td><td>
132
143
The iterator encountered an error while writing the FLAC file </td></tr>
133
 
<tr><td valign=top><em><a name="a14a14" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_RENAME_ERROR"></a><em>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_RENAME_ERROR</em></em>&nbsp;</td><td>
 
144
<tr><td valign="top"><em><a class="anchor" name="gga14a14" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_RENAME_ERROR"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_RENAME_ERROR</em>&nbsp;</td><td>
134
145
The iterator encountered an error renaming the FLAC file </td></tr>
135
 
<tr><td valign=top><em><a name="a14a15" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_UNLINK_ERROR"></a><em>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_UNLINK_ERROR</em></em>&nbsp;</td><td>
 
146
<tr><td valign="top"><em><a class="anchor" name="gga14a15" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_UNLINK_ERROR"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_UNLINK_ERROR</em>&nbsp;</td><td>
136
147
The iterator encountered an error removing the temporary file </td></tr>
137
 
<tr><td valign=top><em><a name="a14a16" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR"></a><em>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR</em></em>&nbsp;</td><td>
 
148
<tr><td valign="top"><em><a class="anchor" name="gga14a16" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_MEMORY_ALLOCATION_ERROR</em>&nbsp;</td><td>
138
149
Memory allocation failed </td></tr>
139
 
<tr><td valign=top><em><a name="a14a17" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_INTERNAL_ERROR"></a><em>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_INTERNAL_ERROR</em></em>&nbsp;</td><td>
 
150
<tr><td valign="top"><em><a class="anchor" name="gga14a17" doxytag="FLAC__METADATA_SIMPLE_ITERATOR_STATUS_INTERNAL_ERROR"></a>FLAC__METADATA_SIMPLE_ITERATOR_STATUS_INTERNAL_ERROR</em>&nbsp;</td><td>
140
151
The caller violated an assertion or an unexpected error occurred </td></tr>
141
152
</table>
142
153
</dl>
144
155
  </tr>
145
156
</table>
146
157
<hr><h2>Function Documentation</h2>
147
 
<a name="a2" doxytag="metadata.h::FLAC__metadata_simple_iterator_new"></a><p>
148
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
149
 
  <tr>
150
 
    <td class="md">
151
 
      <table cellpadding="0" cellspacing="0" border="0">
152
 
        <tr>
153
 
          <td class="md" nowrap valign="top"> <a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a>* FLAC__metadata_simple_iterator_new </td>
154
 
          <td class="md" valign="top">(&nbsp;</td>
155
 
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
156
 
          <td class="md" valign="top">)&nbsp;</td>
157
 
          <td class="md" nowrap></td>
158
 
        </tr>
159
 
 
160
 
      </table>
161
 
    </td>
162
 
  </tr>
163
 
</table>
164
 
<table cellspacing=5 cellpadding=0 border=0>
165
 
  <tr>
166
 
    <td>
167
 
      &nbsp;
168
 
    </td>
169
 
    <td>
170
 
 
171
 
<p>
172
 
Create a new iterator instance.<dl compact><dt><b>
173
 
Return values: </b><dd>
174
 
<table border=0 cellspacing=2 cellpadding=0>
175
 
<tr><td valign=top><em>FLAC__Metadata_SimpleIterator</em>&nbsp;</td><td>
176
 
* <code>NULL</code> if there was an error allocating memory, else the new instance. </td></tr>
177
 
</table>
178
 
</dl>    </td>
179
 
  </tr>
180
 
</table>
181
 
<a name="a3" doxytag="metadata.h::FLAC__metadata_simple_iterator_delete"></a><p>
182
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
183
 
  <tr>
184
 
    <td class="md">
185
 
      <table cellpadding="0" cellspacing="0" border="0">
186
 
        <tr>
187
 
          <td class="md" nowrap valign="top"> void FLAC__metadata_simple_iterator_delete </td>
188
 
          <td class="md" valign="top">(&nbsp;</td>
189
 
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
190
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>iterator</em>          </td>
191
 
          <td class="md" valign="top">)&nbsp;</td>
192
 
          <td class="md" nowrap></td>
193
 
        </tr>
194
 
 
195
 
      </table>
196
 
    </td>
197
 
  </tr>
198
 
</table>
199
 
<table cellspacing=5 cellpadding=0 border=0>
200
 
  <tr>
201
 
    <td>
202
 
      &nbsp;
203
 
    </td>
204
 
    <td>
205
 
 
206
 
<p>
207
 
Free an iterator instance. Deletes the object pointed to by <em>iterator</em>.<dl compact><dt><b>
208
 
Parameters: </b><dd>
209
 
<table border=0 cellspacing=2 cellpadding=0>
210
 
<tr><td valign=top><em>iterator</em>&nbsp;</td><td>
211
 
A pointer to an existing iterator. </td></tr>
212
 
</table>
213
 
</dl><dl compact><dt><b>
214
 
Assertions:</b><dd>
215
 
 <div class="fragment"><pre>iterator != NULL 
216
 
</pre></div> </dl>    </td>
217
 
  </tr>
218
 
</table>
219
 
<a name="a4" doxytag="metadata.h::FLAC__metadata_simple_iterator_status"></a><p>
220
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
221
 
  <tr>
222
 
    <td class="md">
223
 
      <table cellpadding="0" cellspacing="0" border="0">
224
 
        <tr>
225
 
          <td class="md" nowrap valign="top"> <a class="el" href="group__flac__metadata__level1.html#a14">FLAC__Metadata_SimpleIteratorStatus</a> FLAC__metadata_simple_iterator_status </td>
226
 
          <td class="md" valign="top">(&nbsp;</td>
227
 
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
228
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>iterator</em>          </td>
229
 
          <td class="md" valign="top">)&nbsp;</td>
230
 
          <td class="md" nowrap></td>
231
 
        </tr>
232
 
 
233
 
      </table>
234
 
    </td>
235
 
  </tr>
236
 
</table>
237
 
<table cellspacing=5 cellpadding=0 border=0>
238
 
  <tr>
239
 
    <td>
240
 
      &nbsp;
241
 
    </td>
242
 
    <td>
243
 
 
244
 
<p>
245
 
Get the current status of the iterator. Call this after a function returns <code>false</code> to get the reason for the error. Also resets the status to FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK.<dl compact><dt><b>
246
 
Parameters: </b><dd>
247
 
<table border=0 cellspacing=2 cellpadding=0>
248
 
<tr><td valign=top><em>iterator</em>&nbsp;</td><td>
249
 
A pointer to an existing iterator. </td></tr>
250
 
</table>
251
 
</dl><dl compact><dt><b>
252
 
Assertions:</b><dd>
253
 
 <div class="fragment"><pre>iterator != NULL 
254
 
</pre></div> </dl><dl compact><dt><b>
255
 
Return values: </b><dd>
256
 
<table border=0 cellspacing=2 cellpadding=0>
257
 
<tr><td valign=top><em>FLAC__Metadata_SimpleIteratorStatus</em>&nbsp;</td><td>
258
 
The current status of the iterator. </td></tr>
259
 
</table>
260
 
</dl>    </td>
261
 
  </tr>
262
 
</table>
263
 
<a name="a5" doxytag="metadata.h::FLAC__metadata_simple_iterator_init"></a><p>
264
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
265
 
  <tr>
266
 
    <td class="md">
267
 
      <table cellpadding="0" cellspacing="0" border="0">
268
 
        <tr>
269
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__metadata_simple_iterator_init </td>
270
 
          <td class="md" valign="top">(&nbsp;</td>
271
 
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
272
 
          <td class="mdname" nowrap>&nbsp; <em>iterator</em>, </td>
273
 
        </tr>
274
 
        <tr>
275
 
          <td></td>
276
 
          <td></td>
 
158
<a class="anchor" name="ga2" doxytag="metadata.h::FLAC__metadata_simple_iterator_new"></a><p>
 
159
<table class="mdTable" cellpadding="2" cellspacing="0">
 
160
  <tr>
 
161
    <td class="mdRow">
 
162
      <table cellpadding="0" cellspacing="0" border="0">
 
163
        <tr>
 
164
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a>* FLAC__metadata_simple_iterator_new           </td>
 
165
          <td class="md" valign="top">(&nbsp;</td>
 
166
          <td class="md" nowrap valign="top">void&nbsp;</td>
 
167
          <td class="mdname1" valign="top" nowrap>          </td>
 
168
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
169
          <td class="md" nowrap></td>
 
170
        </tr>
 
171
      </table>
 
172
    </td>
 
173
  </tr>
 
174
</table>
 
175
<table cellspacing="5" cellpadding="0" border="0">
 
176
  <tr>
 
177
    <td>
 
178
      &nbsp;
 
179
    </td>
 
180
    <td>
 
181
 
 
182
<p>
 
183
Create a new iterator instance.<p>
 
184
<dl compact><dt><b>Return values:</b></dt><dd>
 
185
  <table border="0" cellspacing="2" cellpadding="0">
 
186
    <tr><td valign="top"></td><td valign="top"><em>FLAC__Metadata_SimpleIterator*</em>&nbsp;</td><td><code>NULL</code> if there was an error allocating memory, else the new instance. </td></tr>
 
187
  </table>
 
188
</dl>
 
189
    </td>
 
190
  </tr>
 
191
</table>
 
192
<a class="anchor" name="ga3" doxytag="metadata.h::FLAC__metadata_simple_iterator_delete"></a><p>
 
193
<table class="mdTable" cellpadding="2" cellspacing="0">
 
194
  <tr>
 
195
    <td class="mdRow">
 
196
      <table cellpadding="0" cellspacing="0" border="0">
 
197
        <tr>
 
198
          <td class="md" nowrap valign="top">void FLAC__metadata_simple_iterator_delete           </td>
 
199
          <td class="md" valign="top">(&nbsp;</td>
 
200
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
 
201
          <td class="mdname1" valign="top" nowrap> <em>iterator</em>          </td>
 
202
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
203
          <td class="md" nowrap></td>
 
204
        </tr>
 
205
      </table>
 
206
    </td>
 
207
  </tr>
 
208
</table>
 
209
<table cellspacing="5" cellpadding="0" border="0">
 
210
  <tr>
 
211
    <td>
 
212
      &nbsp;
 
213
    </td>
 
214
    <td>
 
215
 
 
216
<p>
 
217
Free an iterator instance. Deletes the object pointed to by <em>iterator</em>.<p>
 
218
<dl compact><dt><b>Parameters:</b></dt><dd>
 
219
  <table border="0" cellspacing="2" cellpadding="0">
 
220
    <tr><td valign="top"></td><td valign="top"><em>iterator</em>&nbsp;</td><td>A pointer to an existing iterator. </td></tr>
 
221
  </table>
 
222
</dl>
 
223
<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 
 
224
</pre></div> </dd></dl>
 
225
    </td>
 
226
  </tr>
 
227
</table>
 
228
<a class="anchor" name="ga4" doxytag="metadata.h::FLAC__metadata_simple_iterator_status"></a><p>
 
229
<table class="mdTable" cellpadding="2" cellspacing="0">
 
230
  <tr>
 
231
    <td class="mdRow">
 
232
      <table cellpadding="0" cellspacing="0" border="0">
 
233
        <tr>
 
234
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga14">FLAC__Metadata_SimpleIteratorStatus</a> FLAC__metadata_simple_iterator_status           </td>
 
235
          <td class="md" valign="top">(&nbsp;</td>
 
236
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
 
237
          <td class="mdname1" valign="top" nowrap> <em>iterator</em>          </td>
 
238
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
239
          <td class="md" nowrap></td>
 
240
        </tr>
 
241
      </table>
 
242
    </td>
 
243
  </tr>
 
244
</table>
 
245
<table cellspacing="5" cellpadding="0" border="0">
 
246
  <tr>
 
247
    <td>
 
248
      &nbsp;
 
249
    </td>
 
250
    <td>
 
251
 
 
252
<p>
 
253
Get the current status of the iterator. Call this after a function returns <code>false</code> to get the reason for the error. Also resets the status to FLAC__METADATA_SIMPLE_ITERATOR_STATUS_OK.<p>
 
254
<dl compact><dt><b>Parameters:</b></dt><dd>
 
255
  <table border="0" cellspacing="2" cellpadding="0">
 
256
    <tr><td valign="top"></td><td valign="top"><em>iterator</em>&nbsp;</td><td>A pointer to an existing iterator. </td></tr>
 
257
  </table>
 
258
</dl>
 
259
<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 
 
260
</pre></div> </dd></dl>
 
261
<dl compact><dt><b>Return values:</b></dt><dd>
 
262
  <table border="0" cellspacing="2" cellpadding="0">
 
263
    <tr><td valign="top"></td><td valign="top"><em>FLAC__Metadata_SimpleIteratorStatus</em>&nbsp;</td><td>The current status of the iterator. </td></tr>
 
264
  </table>
 
265
</dl>
 
266
    </td>
 
267
  </tr>
 
268
</table>
 
269
<a class="anchor" name="ga5" doxytag="metadata.h::FLAC__metadata_simple_iterator_init"></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">FLAC__bool FLAC__metadata_simple_iterator_init           </td>
 
276
          <td class="md" valign="top">(&nbsp;</td>
 
277
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
 
278
          <td class="mdname" nowrap> <em>iterator</em>, </td>
 
279
        </tr>
 
280
        <tr>
 
281
          <td class="md" nowrap align="right"></td>
 
282
          <td class="md"></td>
277
283
          <td class="md" nowrap>const char *&nbsp;</td>
278
 
          <td class="mdname" nowrap>&nbsp; <em>filename</em>, </td>
279
 
        </tr>
280
 
        <tr>
281
 
          <td></td>
282
 
          <td></td>
283
 
          <td class="md" nowrap>FLAC__bool&nbsp;</td>
284
 
          <td class="mdname" nowrap>&nbsp; <em>read_only</em>, </td>
285
 
        </tr>
286
 
        <tr>
287
 
          <td></td>
288
 
          <td></td>
289
 
          <td class="md" nowrap>FLAC__bool&nbsp;</td>
290
 
          <td class="mdname" nowrap>&nbsp; <em>preserve_file_stats</em></td>
291
 
        </tr>
292
 
        <tr>
293
 
          <td></td>
294
 
          <td class="md">)&nbsp;</td>
295
 
          <td class="md" colspan="2"></td>
296
 
        </tr>
297
 
 
298
 
      </table>
299
 
    </td>
300
 
  </tr>
301
 
</table>
302
 
<table cellspacing=5 cellpadding=0 border=0>
303
 
  <tr>
304
 
    <td>
305
 
      &nbsp;
306
 
    </td>
307
 
    <td>
308
 
 
309
 
<p>
310
 
Initialize the iterator to point to the first metadata block in the given FLAC file.<dl compact><dt><b>
311
 
Parameters: </b><dd>
312
 
<table border=0 cellspacing=2 cellpadding=0>
313
 
<tr><td valign=top><em>iterator</em>&nbsp;</td><td>
314
 
A pointer to an existing iterator. </td></tr>
315
 
<tr><td valign=top><em>filename</em>&nbsp;</td><td>
316
 
The path to the FLAC file. </td></tr>
317
 
<tr><td valign=top><em>read_only</em>&nbsp;</td><td>
318
 
If <code>true</code>, the FLAC file will be opened in read-only mode; if <code>false</code>, the FLAC file will be opened for edit even if no edits are performed. </td></tr>
319
 
<tr><td valign=top><em>preserve_file_stats</em>&nbsp;</td><td>
320
 
If <code>true</code>, the owner and modification time will be preserved even if the FLAC file is written to. </td></tr>
321
 
</table>
322
 
</dl><dl compact><dt><b>
323
 
Assertions:</b><dd>
324
 
 <div class="fragment"><pre>iterator != NULL 
325
 
</pre></div> <div class="fragment"><pre>filename != NULL 
326
 
</pre></div> </dl><dl compact><dt><b>
327
 
Return values: </b><dd>
328
 
<table border=0 cellspacing=2 cellpadding=0>
329
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
330
 
<code>false</code> if a memory allocation error occurs, the file can't be opened, or another error occurs, else <code>true</code>. </td></tr>
331
 
</table>
332
 
</dl>    </td>
333
 
  </tr>
334
 
</table>
335
 
<a name="a6" doxytag="metadata.h::FLAC__metadata_simple_iterator_is_writable"></a><p>
336
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
337
 
  <tr>
338
 
    <td class="md">
339
 
      <table cellpadding="0" cellspacing="0" border="0">
340
 
        <tr>
341
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__metadata_simple_iterator_is_writable </td>
342
 
          <td class="md" valign="top">(&nbsp;</td>
343
 
          <td class="md" nowrap valign="top">const <a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
344
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>iterator</em>          </td>
345
 
          <td class="md" valign="top">)&nbsp;</td>
346
 
          <td class="md" nowrap></td>
347
 
        </tr>
348
 
 
349
 
      </table>
350
 
    </td>
351
 
  </tr>
352
 
</table>
353
 
<table cellspacing=5 cellpadding=0 border=0>
354
 
  <tr>
355
 
    <td>
356
 
      &nbsp;
357
 
    </td>
358
 
    <td>
359
 
 
360
 
<p>
361
 
Returns <code>true</code> if the FLAC file is writable. If <code>false</code>, calls to <a class="el" href="group__flac__metadata__level1.html#a11">FLAC__metadata_simple_iterator_set_block</a>() and <a class="el" href="group__flac__metadata__level1.html#a12">FLAC__metadata_simple_iterator_insert_block_after</a>() will fail.<dl compact><dt><b>
362
 
Parameters: </b><dd>
363
 
<table border=0 cellspacing=2 cellpadding=0>
364
 
<tr><td valign=top><em>iterator</em>&nbsp;</td><td>
365
 
A pointer to an existing iterator. </td></tr>
366
 
</table>
367
 
</dl><dl compact><dt><b>
368
 
Assertions:</b><dd>
369
 
 <div class="fragment"><pre>iterator != NULL 
370
 
</pre></div> </dl><dl compact><dt><b>
371
 
Return values: </b><dd>
372
 
<table border=0 cellspacing=2 cellpadding=0>
373
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
374
 
See above. </td></tr>
375
 
</table>
376
 
</dl>    </td>
377
 
  </tr>
378
 
</table>
379
 
<a name="a7" doxytag="metadata.h::FLAC__metadata_simple_iterator_next"></a><p>
380
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
381
 
  <tr>
382
 
    <td class="md">
383
 
      <table cellpadding="0" cellspacing="0" border="0">
384
 
        <tr>
385
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__metadata_simple_iterator_next </td>
386
 
          <td class="md" valign="top">(&nbsp;</td>
387
 
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
388
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>iterator</em>          </td>
389
 
          <td class="md" valign="top">)&nbsp;</td>
390
 
          <td class="md" nowrap></td>
391
 
        </tr>
392
 
 
393
 
      </table>
394
 
    </td>
395
 
  </tr>
396
 
</table>
397
 
<table cellspacing=5 cellpadding=0 border=0>
398
 
  <tr>
399
 
    <td>
400
 
      &nbsp;
401
 
    </td>
402
 
    <td>
403
 
 
404
 
<p>
405
 
Moves the iterator forward one metadata block, returning <code>false</code> if already at the end.<dl compact><dt><b>
406
 
Parameters: </b><dd>
407
 
<table border=0 cellspacing=2 cellpadding=0>
408
 
<tr><td valign=top><em>iterator</em>&nbsp;</td><td>
409
 
A pointer to an existing initialized iterator. </td></tr>
410
 
</table>
411
 
</dl><dl compact><dt><b>
412
 
Assertions:</b><dd>
413
 
 <div class="fragment"><pre>iterator != NULL 
414
 
</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#a5">FLAC__metadata_simple_iterator_init</a>() </dl><dl compact><dt><b>
415
 
Return values: </b><dd>
416
 
<table border=0 cellspacing=2 cellpadding=0>
417
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
418
 
<code>false</code> if already at the last metadata block of the chain, else <code>true</code>. </td></tr>
419
 
</table>
420
 
</dl>    </td>
421
 
  </tr>
422
 
</table>
423
 
<a name="a8" doxytag="metadata.h::FLAC__metadata_simple_iterator_prev"></a><p>
424
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
425
 
  <tr>
426
 
    <td class="md">
427
 
      <table cellpadding="0" cellspacing="0" border="0">
428
 
        <tr>
429
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__metadata_simple_iterator_prev </td>
430
 
          <td class="md" valign="top">(&nbsp;</td>
431
 
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
432
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>iterator</em>          </td>
433
 
          <td class="md" valign="top">)&nbsp;</td>
434
 
          <td class="md" nowrap></td>
435
 
        </tr>
436
 
 
437
 
      </table>
438
 
    </td>
439
 
  </tr>
440
 
</table>
441
 
<table cellspacing=5 cellpadding=0 border=0>
442
 
  <tr>
443
 
    <td>
444
 
      &nbsp;
445
 
    </td>
446
 
    <td>
447
 
 
448
 
<p>
449
 
Moves the iterator backward one metadata block, returning <code>false</code> if already at the beginning.<dl compact><dt><b>
450
 
Parameters: </b><dd>
451
 
<table border=0 cellspacing=2 cellpadding=0>
452
 
<tr><td valign=top><em>iterator</em>&nbsp;</td><td>
453
 
A pointer to an existing initialized iterator. </td></tr>
454
 
</table>
455
 
</dl><dl compact><dt><b>
456
 
Assertions:</b><dd>
457
 
 <div class="fragment"><pre>iterator != NULL 
458
 
</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#a5">FLAC__metadata_simple_iterator_init</a>() </dl><dl compact><dt><b>
459
 
Return values: </b><dd>
460
 
<table border=0 cellspacing=2 cellpadding=0>
461
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
462
 
<code>false</code> if already at the first metadata block of the chain, else <code>true</code>. </td></tr>
463
 
</table>
464
 
</dl>    </td>
465
 
  </tr>
466
 
</table>
467
 
<a name="a9" doxytag="metadata.h::FLAC__metadata_simple_iterator_get_block_type"></a><p>
468
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
469
 
  <tr>
470
 
    <td class="md">
471
 
      <table cellpadding="0" cellspacing="0" border="0">
472
 
        <tr>
473
 
          <td class="md" nowrap valign="top"> <a class="el" href="group__flac__format.html#a97">FLAC__MetadataType</a> FLAC__metadata_simple_iterator_get_block_type </td>
474
 
          <td class="md" valign="top">(&nbsp;</td>
475
 
          <td class="md" nowrap valign="top">const <a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
476
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>iterator</em>          </td>
477
 
          <td class="md" valign="top">)&nbsp;</td>
478
 
          <td class="md" nowrap></td>
479
 
        </tr>
480
 
 
481
 
      </table>
482
 
    </td>
483
 
  </tr>
484
 
</table>
485
 
<table cellspacing=5 cellpadding=0 border=0>
486
 
  <tr>
487
 
    <td>
488
 
      &nbsp;
489
 
    </td>
490
 
    <td>
491
 
 
492
 
<p>
493
 
Get the type of the metadata block at the current position. This avoids reading the actual block data which can save time for large blocks.<dl compact><dt><b>
494
 
Parameters: </b><dd>
495
 
<table border=0 cellspacing=2 cellpadding=0>
496
 
<tr><td valign=top><em>iterator</em>&nbsp;</td><td>
497
 
A pointer to an existing initialized iterator. </td></tr>
498
 
</table>
499
 
</dl><dl compact><dt><b>
500
 
Assertions:</b><dd>
501
 
 <div class="fragment"><pre>iterator != NULL 
502
 
</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#a5">FLAC__metadata_simple_iterator_init</a>() </dl><dl compact><dt><b>
503
 
Return values: </b><dd>
504
 
<table border=0 cellspacing=2 cellpadding=0>
505
 
<tr><td valign=top><em>FLAC__MetadataType</em>&nbsp;</td><td>
506
 
The type of the metadata block at the current iterator position. </td></tr>
507
 
</table>
508
 
</dl>    </td>
509
 
  </tr>
510
 
</table>
511
 
<a name="a10" doxytag="metadata.h::FLAC__metadata_simple_iterator_get_block"></a><p>
512
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
513
 
  <tr>
514
 
    <td class="md">
515
 
      <table cellpadding="0" cellspacing="0" border="0">
516
 
        <tr>
517
 
          <td class="md" nowrap valign="top"> <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a>* FLAC__metadata_simple_iterator_get_block </td>
518
 
          <td class="md" valign="top">(&nbsp;</td>
519
 
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
520
 
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>iterator</em>          </td>
521
 
          <td class="md" valign="top">)&nbsp;</td>
522
 
          <td class="md" nowrap></td>
523
 
        </tr>
524
 
 
525
 
      </table>
526
 
    </td>
527
 
  </tr>
528
 
</table>
529
 
<table cellspacing=5 cellpadding=0 border=0>
530
 
  <tr>
531
 
    <td>
532
 
      &nbsp;
533
 
    </td>
534
 
    <td>
535
 
 
536
 
<p>
537
 
Get the metadata block at the current position. You can modify the block but must use <a class="el" href="group__flac__metadata__level1.html#a11">FLAC__metadata_simple_iterator_set_block</a>() to write it back to the FLAC file.
538
 
<p>
539
 
You must call <a class="el" href="group__flac__metadata__object.html#a2">FLAC__metadata_object_delete</a>() on the returned object when you are finished with it.<dl compact><dt><b>
540
 
Parameters: </b><dd>
541
 
<table border=0 cellspacing=2 cellpadding=0>
542
 
<tr><td valign=top><em>iterator</em>&nbsp;</td><td>
543
 
A pointer to an existing initialized iterator. </td></tr>
544
 
</table>
545
 
</dl><dl compact><dt><b>
546
 
Assertions:</b><dd>
547
 
 <div class="fragment"><pre>iterator != NULL 
548
 
</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#a5">FLAC__metadata_simple_iterator_init</a>() </dl><dl compact><dt><b>
549
 
Return values: </b><dd>
550
 
<table border=0 cellspacing=2 cellpadding=0>
551
 
<tr><td valign=top><em><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a></em>&nbsp;</td><td>
552
 
* The current metadata block. </td></tr>
553
 
</table>
554
 
</dl>    </td>
555
 
  </tr>
556
 
</table>
557
 
<a name="a11" doxytag="metadata.h::FLAC__metadata_simple_iterator_set_block"></a><p>
558
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
559
 
  <tr>
560
 
    <td class="md">
561
 
      <table cellpadding="0" cellspacing="0" border="0">
562
 
        <tr>
563
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__metadata_simple_iterator_set_block </td>
564
 
          <td class="md" valign="top">(&nbsp;</td>
565
 
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
566
 
          <td class="mdname" nowrap>&nbsp; <em>iterator</em>, </td>
567
 
        </tr>
568
 
        <tr>
569
 
          <td></td>
570
 
          <td></td>
571
 
          <td class="md" nowrap><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *&nbsp;</td>
572
 
          <td class="mdname" nowrap>&nbsp; <em>block</em>, </td>
573
 
        </tr>
574
 
        <tr>
575
 
          <td></td>
576
 
          <td></td>
577
 
          <td class="md" nowrap>FLAC__bool&nbsp;</td>
578
 
          <td class="mdname" nowrap>&nbsp; <em>use_padding</em></td>
579
 
        </tr>
580
 
        <tr>
581
 
          <td></td>
582
 
          <td class="md">)&nbsp;</td>
583
 
          <td class="md" colspan="2"></td>
584
 
        </tr>
585
 
 
586
 
      </table>
587
 
    </td>
588
 
  </tr>
589
 
</table>
590
 
<table cellspacing=5 cellpadding=0 border=0>
591
 
  <tr>
592
 
    <td>
593
 
      &nbsp;
594
 
    </td>
595
 
    <td>
596
 
 
597
 
<p>
598
 
Write a block back to the FLAC file. This function tries to be as efficient as possible; how the block is actually written is shown by the following:
599
 
<p>
600
 
Existing block is a STREAMINFO block and the new block is a STREAMINFO block: the new block is written in place. Make sure you know what you're doing when changing the values of a STREAMINFO block.
601
 
<p>
602
 
Existing block is a STREAMINFO block and the new block is a not a STREAMINFO block: this is an error since the first block must be a STREAMINFO block. Returns <code>false</code> without altering the file.
603
 
<p>
604
 
Existing block is not a STREAMINFO block and the new block is a STREAMINFO block: this is an error since there may be only one STREAMINFO block. Returns <code>false</code> without altering the file.
605
 
<p>
606
 
Existing block and new block are the same length: the existing block will be replaced by the new block, written in place.
607
 
<p>
608
 
Existing block is longer than new block: if use_padding is <code>true</code>, the existing block will be overwritten in place with the new block followed by a PADDING block, if possible, to make the total size the same as the existing block. Remember that a padding block requires at least four bytes so if the difference in size between the new block and existing block is less than that, the entire file will have to be rewritten, using the new block's exact size. If use_padding is <code>false</code>, the entire file will be rewritten, replacing the existing block by the new block.
609
 
<p>
610
 
Existing block is shorter than new block: if use_padding is <code>true</code>, the function will try and expand the new block into the following PADDING block, if it exists and doing so won't shrink the PADDING block to less than 4 bytes. If there is no following PADDING block, or it will shrink to less than 4 bytes, or use_padding is <code>false</code>, the entire file is rewritten, replacing the existing block with the new block. Note that in this case any following PADDING block is preserved as is.
611
 
<p>
612
 
After writing the block, the iterator will remain in the same place, i.e. pointing to the new block.<dl compact><dt><b>
613
 
Parameters: </b><dd>
614
 
<table border=0 cellspacing=2 cellpadding=0>
615
 
<tr><td valign=top><em>iterator</em>&nbsp;</td><td>
616
 
A pointer to an existing initialized iterator. </td></tr>
617
 
<tr><td valign=top><em>block</em>&nbsp;</td><td>
618
 
The block to set. </td></tr>
619
 
<tr><td valign=top><em>use_padding</em>&nbsp;</td><td>
620
 
See above. </td></tr>
621
 
</table>
622
 
</dl><dl compact><dt><b>
623
 
Assertions:</b><dd>
624
 
 <div class="fragment"><pre>iterator != NULL 
625
 
</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#a5">FLAC__metadata_simple_iterator_init</a>() <div class="fragment"><pre>block != NULL 
626
 
</pre></div> </dl><dl compact><dt><b>
627
 
Return values: </b><dd>
628
 
<table border=0 cellspacing=2 cellpadding=0>
629
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
630
 
<code>true</code> if successful, else <code>false</code>. </td></tr>
631
 
</table>
632
 
</dl>    </td>
633
 
  </tr>
634
 
</table>
635
 
<a name="a12" doxytag="metadata.h::FLAC__metadata_simple_iterator_insert_block_after"></a><p>
636
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
637
 
  <tr>
638
 
    <td class="md">
639
 
      <table cellpadding="0" cellspacing="0" border="0">
640
 
        <tr>
641
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__metadata_simple_iterator_insert_block_after </td>
642
 
          <td class="md" valign="top">(&nbsp;</td>
643
 
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
644
 
          <td class="mdname" nowrap>&nbsp; <em>iterator</em>, </td>
645
 
        </tr>
646
 
        <tr>
647
 
          <td></td>
648
 
          <td></td>
649
 
          <td class="md" nowrap><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *&nbsp;</td>
650
 
          <td class="mdname" nowrap>&nbsp; <em>block</em>, </td>
651
 
        </tr>
652
 
        <tr>
653
 
          <td></td>
654
 
          <td></td>
655
 
          <td class="md" nowrap>FLAC__bool&nbsp;</td>
656
 
          <td class="mdname" nowrap>&nbsp; <em>use_padding</em></td>
657
 
        </tr>
658
 
        <tr>
659
 
          <td></td>
660
 
          <td class="md">)&nbsp;</td>
661
 
          <td class="md" colspan="2"></td>
662
 
        </tr>
663
 
 
664
 
      </table>
665
 
    </td>
666
 
  </tr>
667
 
</table>
668
 
<table cellspacing=5 cellpadding=0 border=0>
669
 
  <tr>
670
 
    <td>
671
 
      &nbsp;
672
 
    </td>
673
 
    <td>
674
 
 
675
 
<p>
676
 
This is similar to <a class="el" href="group__flac__metadata__level1.html#a11">FLAC__metadata_simple_iterator_set_block</a>() except that instead of writing over an existing block, it appends a block after the existing block. <em>use_padding</em> is again used to tell the function to try an expand into following padding in an attempt to avoid rewriting the entire file.
677
 
<p>
678
 
This function will fail and return <code>false</code> if given a STREAMINFO block.
679
 
<p>
680
 
After writing the block, the iterator will be pointing to the new block.<dl compact><dt><b>
681
 
Parameters: </b><dd>
682
 
<table border=0 cellspacing=2 cellpadding=0>
683
 
<tr><td valign=top><em>iterator</em>&nbsp;</td><td>
684
 
A pointer to an existing initialized iterator. </td></tr>
685
 
<tr><td valign=top><em>block</em>&nbsp;</td><td>
686
 
The block to set. </td></tr>
687
 
<tr><td valign=top><em>use_padding</em>&nbsp;</td><td>
688
 
See above. </td></tr>
689
 
</table>
690
 
</dl><dl compact><dt><b>
691
 
Assertions:</b><dd>
692
 
 <div class="fragment"><pre>iterator != NULL 
693
 
</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#a5">FLAC__metadata_simple_iterator_init</a>() <div class="fragment"><pre>block != NULL 
694
 
</pre></div> </dl><dl compact><dt><b>
695
 
Return values: </b><dd>
696
 
<table border=0 cellspacing=2 cellpadding=0>
697
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
698
 
<code>true</code> if successful, else <code>false</code>. </td></tr>
699
 
</table>
700
 
</dl>    </td>
701
 
  </tr>
702
 
</table>
703
 
<a name="a13" doxytag="metadata.h::FLAC__metadata_simple_iterator_delete_block"></a><p>
704
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
705
 
  <tr>
706
 
    <td class="md">
707
 
      <table cellpadding="0" cellspacing="0" border="0">
708
 
        <tr>
709
 
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__metadata_simple_iterator_delete_block </td>
710
 
          <td class="md" valign="top">(&nbsp;</td>
711
 
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#a0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
712
 
          <td class="mdname" nowrap>&nbsp; <em>iterator</em>, </td>
713
 
        </tr>
714
 
        <tr>
715
 
          <td></td>
716
 
          <td></td>
717
 
          <td class="md" nowrap>FLAC__bool&nbsp;</td>
718
 
          <td class="mdname" nowrap>&nbsp; <em>use_padding</em></td>
719
 
        </tr>
720
 
        <tr>
721
 
          <td></td>
722
 
          <td class="md">)&nbsp;</td>
723
 
          <td class="md" colspan="2"></td>
724
 
        </tr>
725
 
 
726
 
      </table>
727
 
    </td>
728
 
  </tr>
729
 
</table>
730
 
<table cellspacing=5 cellpadding=0 border=0>
731
 
  <tr>
732
 
    <td>
733
 
      &nbsp;
734
 
    </td>
735
 
    <td>
736
 
 
737
 
<p>
738
 
Deletes the block at the current position. This will cause the entire FLAC file to be rewritten, unless <em>use_padding</em> is <code>true</code>, in which case the block will be replaced by an equal-sized PADDING block. The iterator will be left pointing to the block before the one just deleted.
739
 
<p>
740
 
You may not delete the STREAMINFO block.<dl compact><dt><b>
741
 
Parameters: </b><dd>
742
 
<table border=0 cellspacing=2 cellpadding=0>
743
 
<tr><td valign=top><em>iterator</em>&nbsp;</td><td>
744
 
A pointer to an existing initialized iterator. </td></tr>
745
 
<tr><td valign=top><em>use_padding</em>&nbsp;</td><td>
746
 
See above. </td></tr>
747
 
</table>
748
 
</dl><dl compact><dt><b>
749
 
Assertions:</b><dd>
750
 
 <div class="fragment"><pre>iterator != NULL 
751
 
</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#a5">FLAC__metadata_simple_iterator_init</a>() </dl><dl compact><dt><b>
752
 
Return values: </b><dd>
753
 
<table border=0 cellspacing=2 cellpadding=0>
754
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
755
 
<code>true</code> if successful, else <code>false</code>. </td></tr>
756
 
</table>
757
 
</dl>    </td>
 
284
          <td class="mdname" nowrap> <em>filename</em>, </td>
 
285
        </tr>
 
286
        <tr>
 
287
          <td class="md" nowrap align="right"></td>
 
288
          <td class="md"></td>
 
289
          <td class="md" nowrap>FLAC__bool&nbsp;</td>
 
290
          <td class="mdname" nowrap> <em>read_only</em>, </td>
 
291
        </tr>
 
292
        <tr>
 
293
          <td class="md" nowrap align="right"></td>
 
294
          <td class="md"></td>
 
295
          <td class="md" nowrap>FLAC__bool&nbsp;</td>
 
296
          <td class="mdname" nowrap> <em>preserve_file_stats</em></td>
 
297
        </tr>
 
298
        <tr>
 
299
          <td class="md"></td>
 
300
          <td class="md">)&nbsp;</td>
 
301
          <td class="md" colspan="2"></td>
 
302
        </tr>
 
303
      </table>
 
304
    </td>
 
305
  </tr>
 
306
</table>
 
307
<table cellspacing="5" cellpadding="0" border="0">
 
308
  <tr>
 
309
    <td>
 
310
      &nbsp;
 
311
    </td>
 
312
    <td>
 
313
 
 
314
<p>
 
315
Initialize the iterator to point to the first metadata block in the given FLAC file.<p>
 
316
<dl compact><dt><b>Parameters:</b></dt><dd>
 
317
  <table border="0" cellspacing="2" cellpadding="0">
 
318
    <tr><td valign="top"></td><td valign="top"><em>iterator</em>&nbsp;</td><td>A pointer to an existing iterator. </td></tr>
 
319
    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>The path to the FLAC file. </td></tr>
 
320
    <tr><td valign="top"></td><td valign="top"><em>read_only</em>&nbsp;</td><td>If <code>true</code>, the FLAC file will be opened in read-only mode; if <code>false</code>, the FLAC file will be opened for edit even if no edits are performed. </td></tr>
 
321
    <tr><td valign="top"></td><td valign="top"><em>preserve_file_stats</em>&nbsp;</td><td>If <code>true</code>, the owner and modification time will be preserved even if the FLAC file is written to. </td></tr>
 
322
  </table>
 
323
</dl>
 
324
<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 
 
325
</pre></div> <div class="fragment"><pre class="fragment"> filename != NULL 
 
326
</pre></div> </dd></dl>
 
327
<dl compact><dt><b>Return values:</b></dt><dd>
 
328
  <table border="0" cellspacing="2" cellpadding="0">
 
329
    <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em>&nbsp;</td><td><code>false</code> if a memory allocation error occurs, the file can't be opened, or another error occurs, else <code>true</code>. </td></tr>
 
330
  </table>
 
331
</dl>
 
332
    </td>
 
333
  </tr>
 
334
</table>
 
335
<a class="anchor" name="ga6" doxytag="metadata.h::FLAC__metadata_simple_iterator_is_writable"></a><p>
 
336
<table class="mdTable" cellpadding="2" cellspacing="0">
 
337
  <tr>
 
338
    <td class="mdRow">
 
339
      <table cellpadding="0" cellspacing="0" border="0">
 
340
        <tr>
 
341
          <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_simple_iterator_is_writable           </td>
 
342
          <td class="md" valign="top">(&nbsp;</td>
 
343
          <td class="md" nowrap valign="top">const <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
 
344
          <td class="mdname1" valign="top" nowrap> <em>iterator</em>          </td>
 
345
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
346
          <td class="md" nowrap></td>
 
347
        </tr>
 
348
      </table>
 
349
    </td>
 
350
  </tr>
 
351
</table>
 
352
<table cellspacing="5" cellpadding="0" border="0">
 
353
  <tr>
 
354
    <td>
 
355
      &nbsp;
 
356
    </td>
 
357
    <td>
 
358
 
 
359
<p>
 
360
Returns <code>true</code> if the FLAC file is writable. If <code>false</code>, calls to <a class="el" href="group__flac__metadata__level1.html#ga11">FLAC__metadata_simple_iterator_set_block()</a> and <a class="el" href="group__flac__metadata__level1.html#ga12">FLAC__metadata_simple_iterator_insert_block_after()</a> will fail.<p>
 
361
<dl compact><dt><b>Parameters:</b></dt><dd>
 
362
  <table border="0" cellspacing="2" cellpadding="0">
 
363
    <tr><td valign="top"></td><td valign="top"><em>iterator</em>&nbsp;</td><td>A pointer to an existing iterator. </td></tr>
 
364
  </table>
 
365
</dl>
 
366
<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 
 
367
</pre></div> </dd></dl>
 
368
<dl compact><dt><b>Return values:</b></dt><dd>
 
369
  <table border="0" cellspacing="2" cellpadding="0">
 
370
    <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em>&nbsp;</td><td>See above. </td></tr>
 
371
  </table>
 
372
</dl>
 
373
    </td>
 
374
  </tr>
 
375
</table>
 
376
<a class="anchor" name="ga7" doxytag="metadata.h::FLAC__metadata_simple_iterator_next"></a><p>
 
377
<table class="mdTable" cellpadding="2" cellspacing="0">
 
378
  <tr>
 
379
    <td class="mdRow">
 
380
      <table cellpadding="0" cellspacing="0" border="0">
 
381
        <tr>
 
382
          <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_simple_iterator_next           </td>
 
383
          <td class="md" valign="top">(&nbsp;</td>
 
384
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
 
385
          <td class="mdname1" valign="top" nowrap> <em>iterator</em>          </td>
 
386
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
387
          <td class="md" nowrap></td>
 
388
        </tr>
 
389
      </table>
 
390
    </td>
 
391
  </tr>
 
392
</table>
 
393
<table cellspacing="5" cellpadding="0" border="0">
 
394
  <tr>
 
395
    <td>
 
396
      &nbsp;
 
397
    </td>
 
398
    <td>
 
399
 
 
400
<p>
 
401
Moves the iterator forward one metadata block, returning <code>false</code> if already at the end.<p>
 
402
<dl compact><dt><b>Parameters:</b></dt><dd>
 
403
  <table border="0" cellspacing="2" cellpadding="0">
 
404
    <tr><td valign="top"></td><td valign="top"><em>iterator</em>&nbsp;</td><td>A pointer to an existing initialized iterator. </td></tr>
 
405
  </table>
 
406
</dl>
 
407
<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 
 
408
</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> </dd></dl>
 
409
<dl compact><dt><b>Return values:</b></dt><dd>
 
410
  <table border="0" cellspacing="2" cellpadding="0">
 
411
    <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em>&nbsp;</td><td><code>false</code> if already at the last metadata block of the chain, else <code>true</code>. </td></tr>
 
412
  </table>
 
413
</dl>
 
414
    </td>
 
415
  </tr>
 
416
</table>
 
417
<a class="anchor" name="ga8" doxytag="metadata.h::FLAC__metadata_simple_iterator_prev"></a><p>
 
418
<table class="mdTable" cellpadding="2" cellspacing="0">
 
419
  <tr>
 
420
    <td class="mdRow">
 
421
      <table cellpadding="0" cellspacing="0" border="0">
 
422
        <tr>
 
423
          <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_simple_iterator_prev           </td>
 
424
          <td class="md" valign="top">(&nbsp;</td>
 
425
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
 
426
          <td class="mdname1" valign="top" nowrap> <em>iterator</em>          </td>
 
427
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
428
          <td class="md" nowrap></td>
 
429
        </tr>
 
430
      </table>
 
431
    </td>
 
432
  </tr>
 
433
</table>
 
434
<table cellspacing="5" cellpadding="0" border="0">
 
435
  <tr>
 
436
    <td>
 
437
      &nbsp;
 
438
    </td>
 
439
    <td>
 
440
 
 
441
<p>
 
442
Moves the iterator backward one metadata block, returning <code>false</code> if already at the beginning.<p>
 
443
<dl compact><dt><b>Parameters:</b></dt><dd>
 
444
  <table border="0" cellspacing="2" cellpadding="0">
 
445
    <tr><td valign="top"></td><td valign="top"><em>iterator</em>&nbsp;</td><td>A pointer to an existing initialized iterator. </td></tr>
 
446
  </table>
 
447
</dl>
 
448
<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 
 
449
</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> </dd></dl>
 
450
<dl compact><dt><b>Return values:</b></dt><dd>
 
451
  <table border="0" cellspacing="2" cellpadding="0">
 
452
    <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em>&nbsp;</td><td><code>false</code> if already at the first metadata block of the chain, else <code>true</code>. </td></tr>
 
453
  </table>
 
454
</dl>
 
455
    </td>
 
456
  </tr>
 
457
</table>
 
458
<a class="anchor" name="ga9" doxytag="metadata.h::FLAC__metadata_simple_iterator_get_block_type"></a><p>
 
459
<table class="mdTable" cellpadding="2" cellspacing="0">
 
460
  <tr>
 
461
    <td class="mdRow">
 
462
      <table cellpadding="0" cellspacing="0" border="0">
 
463
        <tr>
 
464
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__format.html#ga109">FLAC__MetadataType</a> FLAC__metadata_simple_iterator_get_block_type           </td>
 
465
          <td class="md" valign="top">(&nbsp;</td>
 
466
          <td class="md" nowrap valign="top">const <a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
 
467
          <td class="mdname1" valign="top" nowrap> <em>iterator</em>          </td>
 
468
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
469
          <td class="md" nowrap></td>
 
470
        </tr>
 
471
      </table>
 
472
    </td>
 
473
  </tr>
 
474
</table>
 
475
<table cellspacing="5" cellpadding="0" border="0">
 
476
  <tr>
 
477
    <td>
 
478
      &nbsp;
 
479
    </td>
 
480
    <td>
 
481
 
 
482
<p>
 
483
Get the type of the metadata block at the current position. This avoids reading the actual block data which can save time for large blocks.<p>
 
484
<dl compact><dt><b>Parameters:</b></dt><dd>
 
485
  <table border="0" cellspacing="2" cellpadding="0">
 
486
    <tr><td valign="top"></td><td valign="top"><em>iterator</em>&nbsp;</td><td>A pointer to an existing initialized iterator. </td></tr>
 
487
  </table>
 
488
</dl>
 
489
<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 
 
490
</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> </dd></dl>
 
491
<dl compact><dt><b>Return values:</b></dt><dd>
 
492
  <table border="0" cellspacing="2" cellpadding="0">
 
493
    <tr><td valign="top"></td><td valign="top"><em>FLAC__MetadataType</em>&nbsp;</td><td>The type of the metadata block at the current iterator position. </td></tr>
 
494
  </table>
 
495
</dl>
 
496
    </td>
 
497
  </tr>
 
498
</table>
 
499
<a class="anchor" name="ga10" doxytag="metadata.h::FLAC__metadata_simple_iterator_get_block"></a><p>
 
500
<table class="mdTable" cellpadding="2" cellspacing="0">
 
501
  <tr>
 
502
    <td class="mdRow">
 
503
      <table cellpadding="0" cellspacing="0" border="0">
 
504
        <tr>
 
505
          <td class="md" nowrap valign="top"><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a>* FLAC__metadata_simple_iterator_get_block           </td>
 
506
          <td class="md" valign="top">(&nbsp;</td>
 
507
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
 
508
          <td class="mdname1" valign="top" nowrap> <em>iterator</em>          </td>
 
509
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
 
510
          <td class="md" nowrap></td>
 
511
        </tr>
 
512
      </table>
 
513
    </td>
 
514
  </tr>
 
515
</table>
 
516
<table cellspacing="5" cellpadding="0" border="0">
 
517
  <tr>
 
518
    <td>
 
519
      &nbsp;
 
520
    </td>
 
521
    <td>
 
522
 
 
523
<p>
 
524
Get the metadata block at the current position. You can modify the block but must use <a class="el" href="group__flac__metadata__level1.html#ga11">FLAC__metadata_simple_iterator_set_block()</a> to write it back to the FLAC file.<p>
 
525
You must call <a class="el" href="group__flac__metadata__object.html#ga2">FLAC__metadata_object_delete()</a> on the returned object when you are finished with it.<p>
 
526
<dl compact><dt><b>Parameters:</b></dt><dd>
 
527
  <table border="0" cellspacing="2" cellpadding="0">
 
528
    <tr><td valign="top"></td><td valign="top"><em>iterator</em>&nbsp;</td><td>A pointer to an existing initialized iterator. </td></tr>
 
529
  </table>
 
530
</dl>
 
531
<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 
 
532
</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> </dd></dl>
 
533
<dl compact><dt><b>Return values:</b></dt><dd>
 
534
  <table border="0" cellspacing="2" cellpadding="0">
 
535
    <tr><td valign="top"></td><td valign="top"><em>FLAC__StreamMetadata*</em>&nbsp;</td><td>The current metadata block. </td></tr>
 
536
  </table>
 
537
</dl>
 
538
    </td>
 
539
  </tr>
 
540
</table>
 
541
<a class="anchor" name="ga11" doxytag="metadata.h::FLAC__metadata_simple_iterator_set_block"></a><p>
 
542
<table class="mdTable" cellpadding="2" cellspacing="0">
 
543
  <tr>
 
544
    <td class="mdRow">
 
545
      <table cellpadding="0" cellspacing="0" border="0">
 
546
        <tr>
 
547
          <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_simple_iterator_set_block           </td>
 
548
          <td class="md" valign="top">(&nbsp;</td>
 
549
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
 
550
          <td class="mdname" nowrap> <em>iterator</em>, </td>
 
551
        </tr>
 
552
        <tr>
 
553
          <td class="md" nowrap align="right"></td>
 
554
          <td class="md"></td>
 
555
          <td class="md" nowrap><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *&nbsp;</td>
 
556
          <td class="mdname" nowrap> <em>block</em>, </td>
 
557
        </tr>
 
558
        <tr>
 
559
          <td class="md" nowrap align="right"></td>
 
560
          <td class="md"></td>
 
561
          <td class="md" nowrap>FLAC__bool&nbsp;</td>
 
562
          <td class="mdname" nowrap> <em>use_padding</em></td>
 
563
        </tr>
 
564
        <tr>
 
565
          <td class="md"></td>
 
566
          <td class="md">)&nbsp;</td>
 
567
          <td class="md" colspan="2"></td>
 
568
        </tr>
 
569
      </table>
 
570
    </td>
 
571
  </tr>
 
572
</table>
 
573
<table cellspacing="5" cellpadding="0" border="0">
 
574
  <tr>
 
575
    <td>
 
576
      &nbsp;
 
577
    </td>
 
578
    <td>
 
579
 
 
580
<p>
 
581
Write a block back to the FLAC file. This function tries to be as efficient as possible; how the block is actually written is shown by the following:<p>
 
582
Existing block is a STREAMINFO block and the new block is a STREAMINFO block: the new block is written in place. Make sure you know what you're doing when changing the values of a STREAMINFO block.<p>
 
583
Existing block is a STREAMINFO block and the new block is a not a STREAMINFO block: this is an error since the first block must be a STREAMINFO block. Returns <code>false</code> without altering the file.<p>
 
584
Existing block is not a STREAMINFO block and the new block is a STREAMINFO block: this is an error since there may be only one STREAMINFO block. Returns <code>false</code> without altering the file.<p>
 
585
Existing block and new block are the same length: the existing block will be replaced by the new block, written in place.<p>
 
586
Existing block is longer than new block: if use_padding is <code>true</code>, the existing block will be overwritten in place with the new block followed by a PADDING block, if possible, to make the total size the same as the existing block. Remember that a padding block requires at least four bytes so if the difference in size between the new block and existing block is less than that, the entire file will have to be rewritten, using the new block's exact size. If use_padding is <code>false</code>, the entire file will be rewritten, replacing the existing block by the new block.<p>
 
587
Existing block is shorter than new block: if use_padding is <code>true</code>, the function will try and expand the new block into the following PADDING block, if it exists and doing so won't shrink the PADDING block to less than 4 bytes. If there is no following PADDING block, or it will shrink to less than 4 bytes, or use_padding is <code>false</code>, the entire file is rewritten, replacing the existing block with the new block. Note that in this case any following PADDING block is preserved as is.<p>
 
588
After writing the block, the iterator will remain in the same place, i.e. pointing to the new block.<p>
 
589
<dl compact><dt><b>Parameters:</b></dt><dd>
 
590
  <table border="0" cellspacing="2" cellpadding="0">
 
591
    <tr><td valign="top"></td><td valign="top"><em>iterator</em>&nbsp;</td><td>A pointer to an existing initialized iterator. </td></tr>
 
592
    <tr><td valign="top"></td><td valign="top"><em>block</em>&nbsp;</td><td>The block to set. </td></tr>
 
593
    <tr><td valign="top"></td><td valign="top"><em>use_padding</em>&nbsp;</td><td>See above. </td></tr>
 
594
  </table>
 
595
</dl>
 
596
<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 
 
597
</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> <div class="fragment"><pre class="fragment"> block != NULL 
 
598
</pre></div> </dd></dl>
 
599
<dl compact><dt><b>Return values:</b></dt><dd>
 
600
  <table border="0" cellspacing="2" cellpadding="0">
 
601
    <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em>&nbsp;</td><td><code>true</code> if successful, else <code>false</code>. </td></tr>
 
602
  </table>
 
603
</dl>
 
604
    </td>
 
605
  </tr>
 
606
</table>
 
607
<a class="anchor" name="ga12" doxytag="metadata.h::FLAC__metadata_simple_iterator_insert_block_after"></a><p>
 
608
<table class="mdTable" cellpadding="2" cellspacing="0">
 
609
  <tr>
 
610
    <td class="mdRow">
 
611
      <table cellpadding="0" cellspacing="0" border="0">
 
612
        <tr>
 
613
          <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_simple_iterator_insert_block_after           </td>
 
614
          <td class="md" valign="top">(&nbsp;</td>
 
615
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
 
616
          <td class="mdname" nowrap> <em>iterator</em>, </td>
 
617
        </tr>
 
618
        <tr>
 
619
          <td class="md" nowrap align="right"></td>
 
620
          <td class="md"></td>
 
621
          <td class="md" nowrap><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *&nbsp;</td>
 
622
          <td class="mdname" nowrap> <em>block</em>, </td>
 
623
        </tr>
 
624
        <tr>
 
625
          <td class="md" nowrap align="right"></td>
 
626
          <td class="md"></td>
 
627
          <td class="md" nowrap>FLAC__bool&nbsp;</td>
 
628
          <td class="mdname" nowrap> <em>use_padding</em></td>
 
629
        </tr>
 
630
        <tr>
 
631
          <td class="md"></td>
 
632
          <td class="md">)&nbsp;</td>
 
633
          <td class="md" colspan="2"></td>
 
634
        </tr>
 
635
      </table>
 
636
    </td>
 
637
  </tr>
 
638
</table>
 
639
<table cellspacing="5" cellpadding="0" border="0">
 
640
  <tr>
 
641
    <td>
 
642
      &nbsp;
 
643
    </td>
 
644
    <td>
 
645
 
 
646
<p>
 
647
This is similar to <a class="el" href="group__flac__metadata__level1.html#ga11">FLAC__metadata_simple_iterator_set_block()</a> except that instead of writing over an existing block, it appends a block after the existing block. <em>use_padding</em> is again used to tell the function to try an expand into following padding in an attempt to avoid rewriting the entire file.<p>
 
648
This function will fail and return <code>false</code> if given a STREAMINFO block.<p>
 
649
After writing the block, the iterator will be pointing to the new block.<p>
 
650
<dl compact><dt><b>Parameters:</b></dt><dd>
 
651
  <table border="0" cellspacing="2" cellpadding="0">
 
652
    <tr><td valign="top"></td><td valign="top"><em>iterator</em>&nbsp;</td><td>A pointer to an existing initialized iterator. </td></tr>
 
653
    <tr><td valign="top"></td><td valign="top"><em>block</em>&nbsp;</td><td>The block to set. </td></tr>
 
654
    <tr><td valign="top"></td><td valign="top"><em>use_padding</em>&nbsp;</td><td>See above. </td></tr>
 
655
  </table>
 
656
</dl>
 
657
<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 
 
658
</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> <div class="fragment"><pre class="fragment"> block != NULL 
 
659
</pre></div> </dd></dl>
 
660
<dl compact><dt><b>Return values:</b></dt><dd>
 
661
  <table border="0" cellspacing="2" cellpadding="0">
 
662
    <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em>&nbsp;</td><td><code>true</code> if successful, else <code>false</code>. </td></tr>
 
663
  </table>
 
664
</dl>
 
665
    </td>
 
666
  </tr>
 
667
</table>
 
668
<a class="anchor" name="ga13" doxytag="metadata.h::FLAC__metadata_simple_iterator_delete_block"></a><p>
 
669
<table class="mdTable" cellpadding="2" cellspacing="0">
 
670
  <tr>
 
671
    <td class="mdRow">
 
672
      <table cellpadding="0" cellspacing="0" border="0">
 
673
        <tr>
 
674
          <td class="md" nowrap valign="top">FLAC__bool FLAC__metadata_simple_iterator_delete_block           </td>
 
675
          <td class="md" valign="top">(&nbsp;</td>
 
676
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__metadata__level1.html#ga0">FLAC__Metadata_SimpleIterator</a> *&nbsp;</td>
 
677
          <td class="mdname" nowrap> <em>iterator</em>, </td>
 
678
        </tr>
 
679
        <tr>
 
680
          <td class="md" nowrap align="right"></td>
 
681
          <td class="md"></td>
 
682
          <td class="md" nowrap>FLAC__bool&nbsp;</td>
 
683
          <td class="mdname" nowrap> <em>use_padding</em></td>
 
684
        </tr>
 
685
        <tr>
 
686
          <td class="md"></td>
 
687
          <td class="md">)&nbsp;</td>
 
688
          <td class="md" colspan="2"></td>
 
689
        </tr>
 
690
      </table>
 
691
    </td>
 
692
  </tr>
 
693
</table>
 
694
<table cellspacing="5" cellpadding="0" border="0">
 
695
  <tr>
 
696
    <td>
 
697
      &nbsp;
 
698
    </td>
 
699
    <td>
 
700
 
 
701
<p>
 
702
Deletes the block at the current position. This will cause the entire FLAC file to be rewritten, unless <em>use_padding</em> is <code>true</code>, in which case the block will be replaced by an equal-sized PADDING block. The iterator will be left pointing to the block before the one just deleted.<p>
 
703
You may not delete the STREAMINFO block.<p>
 
704
<dl compact><dt><b>Parameters:</b></dt><dd>
 
705
  <table border="0" cellspacing="2" cellpadding="0">
 
706
    <tr><td valign="top"></td><td valign="top"><em>iterator</em>&nbsp;</td><td>A pointer to an existing initialized iterator. </td></tr>
 
707
    <tr><td valign="top"></td><td valign="top"><em>use_padding</em>&nbsp;</td><td>See above. </td></tr>
 
708
  </table>
 
709
</dl>
 
710
<dl compact><dt><b>Assertions: </b></dt><dd><div class="fragment"><pre class="fragment"> iterator != NULL 
 
711
</pre></div> <em>iterator</em> has been successfully initialized with <a class="el" href="group__flac__metadata__level1.html#ga5">FLAC__metadata_simple_iterator_init()</a> </dd></dl>
 
712
<dl compact><dt><b>Return values:</b></dt><dd>
 
713
  <table border="0" cellspacing="2" cellpadding="0">
 
714
    <tr><td valign="top"></td><td valign="top"><em>FLAC__bool</em>&nbsp;</td><td><code>true</code> if successful, else <code>false</code>. </td></tr>
 
715
  </table>
 
716
</dl>
 
717
    </td>
758
718
  </tr>
759
719
</table>
760
720
<hr><h2>Variable Documentation</h2>
761
 
<a name="a1" doxytag="metadata.h::FLAC__Metadata_SimpleIteratorStatusString"></a><p>
762
 
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
721
<a class="anchor" name="ga1" doxytag="metadata.h::FLAC__Metadata_SimpleIteratorStatusString"></a><p>
 
722
<table class="mdTable" cellpadding="2" cellspacing="0">
763
723
  <tr>
764
 
    <td class="md">
 
724
    <td class="mdRow">
765
725
      <table cellpadding="0" cellspacing="0" border="0">
766
726
        <tr>
767
 
          <td class="md" nowrap valign="top"> const char* const FLAC__Metadata_SimpleIteratorStatusString[]
 
727
          <td class="md" nowrap valign="top">const char* const <a class="el" href="group__flac__metadata__level1.html#ga1">FLAC__Metadata_SimpleIteratorStatusString</a>[]          </td>
 
728
        </tr>
768
729
      </table>
769
730
    </td>
770
731
  </tr>
771
732
</table>
772
 
<table cellspacing=5 cellpadding=0 border=0>
 
733
<table cellspacing="5" cellpadding="0" border="0">
773
734
  <tr>
774
735
    <td>
775
736
      &nbsp;
777
738
    <td>
778
739
 
779
740
<p>
780
 
Maps a FLAC__Metadata_SimpleIteratorStatus to a C string.
781
 
<p>
 
741
Maps a FLAC__Metadata_SimpleIteratorStatus to a C string.<p>
782
742
Using a FLAC__Metadata_SimpleIteratorStatus as the index to this array will give the string equivalent. The contents should not be modified.     </td>
783
743
  </tr>
784
744
</table>
785
 
<hr><address><small>Generated on Fri Feb 4 18:39:15 2005 for FLAC by
786
 
<a href="http://www.doxygen.org/index.html">
787
 
<img src="doxygen.gif" alt="doxygen" align="middle" border=0 
788
 
width=110 height=53></a>1.2.14 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
789
 
 &copy;&nbsp;1997-2002</small></address>
 
745
 
 
746
<hr size="1">
 
747
<div class="copyright">
 
748
        <!-- @@@ oh so hacky -->
 
749
        <table>
 
750
                <tr>
 
751
                        <td align="left">
 
752
                                Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007  Josh Coalson
 
753
                        </td>
 
754
                        <td width="1%" align="right">
 
755
                                <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>
 
756
                        </td>
 
757
                </tr>
 
758
        </table>
 
759
</div>
 
760
<!-- Copyright (c)  2000,2001,2002,2003,2004,2005,2006,2007  Josh Coalson -->
 
761
<!-- Permission is granted to copy, distribute and/or modify this document -->
 
762
<!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
 
763
<!-- or any later version published by the Free Software Foundation; -->
 
764
<!-- with no invariant sections. -->
 
765
<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
790
766
</body>
791
767
</html>