← 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__level2.html

  • Committer: Bazaar Package Importer
  • Author(s): Kees Cook
  • Date: 2007-12-06 16:57:20 UTC
  • mto: (8.1.1 lenny)
  • mto: This revision was merged to the branch mainline in revision 12.
  • Revision ID: james.westby@ubuntu.com-20071206165720-4przr8grn6ha3e3a
Tags: upstream-1.2.1
Import upstream version 1.2.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/api/group__flac__metadata__level2.html
89
89
 
90
90
<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__level2.html#ga20">FLAC__metadata_iterator_prev</a> (<a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> *iterator)</td></tr>
91
91
 
92
 
<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__level2.html#ga21">FLAC__metadata_iterator_get_block_type</a> (const <a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> *iterator)</td></tr>
 
92
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__flac__format.html#ga113">FLAC__MetadataType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__flac__metadata__level2.html#ga21">FLAC__metadata_iterator_get_block_type</a> (const <a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> *iterator)</td></tr>
93
93
 
94
94
<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__level2.html#ga22">FLAC__metadata_iterator_get_block</a> (<a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> *iterator)</td></tr>
95
95
 
643
643
Write all metadata out to the FLAC file. This function tries to be as efficient as possible; how the metadata is actually written is shown by the following:<p>
644
644
If the current chain is the same size as the existing metadata, the new data is written in place.<p>
645
645
If the current chain is longer than the existing metadata, and <em>use_padding</em> is <code>true</code>, and the last block is a PADDING block of sufficient length, the function will truncate the final padding block so that the overall size of the metadata is the same as the existing metadata, and then just rewrite the metadata. Otherwise, if not all of the above conditions are met, the entire FLAC file must be rewritten. If you want to use padding this way it is a good idea to call <a class="el" href="group__flac__metadata__level2.html#ga15">FLAC__metadata_chain_sort_padding()</a> first so that you have the maximum amount of padding to work with, unless you need to preserve ordering of the PADDING blocks for some reason.<p>
646
 
If the current chain is shorter than the existing metadata, and <em>use_padding</em> is <code>true</code>, and the final block is a PADDING block, the padding is extended to make the overall size the same as the existing data. If <em>use_padding</em> is <code>true</code> and the last block is not a PADDING block, a new PADDING block is added to the end of the new data to make it the same size as the existing data (if possible, see the note to <a class="el" href="group__flac__metadata__level1.html#ga11">FLAC__metadata_simple_iterator_set_block()</a> about the four byte limit) and the new data is written in place. If none of the above apply or <em>use_padding</em> is <code>false</code>, the entire FLAC file is rewritten.<p>
 
646
If the current chain is shorter than the existing metadata, and <em>use_padding</em> is <code>true</code>, and the final block is a PADDING block, the padding is extended to make the overall size the same as the existing data. If <em>use_padding</em> is <code>true</code> and the last block is not a PADDING block, a new PADDING block is added to the end of the new data to make it the same size as the existing data (if possible, see the note to <a class="el" href="group__flac__metadata__level1.html#ga15">FLAC__metadata_simple_iterator_set_block()</a> about the four byte limit) and the new data is written in place. If none of the above apply or <em>use_padding</em> is <code>false</code>, the entire FLAC file is rewritten.<p>
647
647
If <em>preserve_file_stats</em> is <code>true</code>, the owner and modification time will be preserved even if the FLAC file is written.<p>
648
648
For this write function to be used, the chain must have been read with <a class="el" href="group__flac__metadata__level2.html#ga6">FLAC__metadata_chain_read()</a>/FLAC__metadata_chain_read_ogg(), not <a class="el" href="group__flac__metadata__level2.html#ga8">FLAC__metadata_chain_read_with_callbacks()</a>/FLAC__metadata_chain_read_ogg_with_callbacks().<p>
649
649
<dl compact><dt><b>Parameters:</b></dt><dd>
1096
1096
    <td class="mdRow">
1097
1097
      <table cellpadding="0" cellspacing="0" border="0">
1098
1098
        <tr>
1099
 
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__format.html#ga109">FLAC__MetadataType</a> FLAC__metadata_iterator_get_block_type           </td>
 
1099
          <td class="md" nowrap valign="top"><a class="el" href="group__flac__format.html#ga113">FLAC__MetadataType</a> FLAC__metadata_iterator_get_block_type           </td>
1100
1100
          <td class="md" valign="top">(&nbsp;</td>
1101
1101
          <td class="md" nowrap valign="top">const <a class="el" href="group__flac__metadata__level2.html#ga1">FLAC__Metadata_Iterator</a> *&nbsp;</td>
1102
1102
          <td class="mdname1" valign="top" nowrap> <em>iterator</em>          </td>