~ubuntu-branches/ubuntu/karmic/flac/karmic

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Matt Zimmerman
  • Date: 2005-01-08 15:08:22 UTC
  • mto: (8.1.1 lenny)
  • mto: This revision was merged to the branch mainline in revision 4.
  • Revision ID: james.westby@ubuntu.com-20050108150822-yvinilrafylazcyv
Tags: upstream-1.1.1
ImportĀ upstreamĀ versionĀ 1.1.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
9
9
<hr><h1>FLAC/metadata.h: metadata level 0 interface<br>
10
10
<small>
11
11
[<a class="el" href="group__flac__metadata.html">FLAC/metadata.h: metadata interfaces</a>]</small>
12
 
</h1>The level 0 interface consists of a single routine to read the STREAMINFO block. 
 
12
</h1>The level 0 interface consists of individual routines to read the STREAMINFO and VORBIS_COMMENT blocks, requiring only a filename. 
13
13
<a href="#_details">More...</a><table border=0 cellpadding=0 cellspacing=0>
14
14
<tr><td colspan=2><br><h2>Functions</h2></td></tr>
15
15
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__metadata__level0.html#a0">FLAC__metadata_get_streaminfo</a> (const char *filename, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> *streaminfo)</td></tr>
 
16
<tr><td nowrap align=right valign=top>FLAC__bool&nbsp;</td><td valign=bottom><a class="el" href="group__flac__metadata__level0.html#a1">FLAC__metadata_get_tags</a> (const char *filename, <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> **tags)</td></tr>
16
17
</table>
17
18
<hr><a name="_details"></a><h2>Detailed Description</h2>
18
 
The level 0 interface consists of a single routine to read the STREAMINFO block.
 
19
The level 0 interface consists of individual routines to read the STREAMINFO and VORBIS_COMMENT blocks, requiring only a filename.
19
20
<p>
20
21
 
21
22
<p>
61
62
<tr><td valign=top><em>filename</em>&nbsp;</td><td>
62
63
The path to the FLAC file to read. </td></tr>
63
64
<tr><td valign=top><em>streaminfo</em>&nbsp;</td><td>
64
 
A pointer to space for the STREAMINFO block. </td></tr>
65
 
</table>
66
 
</dl><dl compact><dt><b>
67
 
Assertions:</b><dd>
68
 
 <div class="fragment"><pre>filename != NULL 
69
 
</pre></div> <div class="fragment"><pre>streaminfo != NULL 
70
 
</pre></div> </dl><dl compact><dt><b>
71
 
Return values: </b><dd>
72
 
<table border=0 cellspacing=2 cellpadding=0>
73
 
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
74
 
<code>true</code> if a valid STREAMINFO block was read from <em>filename</em>. Returns <code>false</code> if there was a memory allocation error, a file decoder error, or the file contained no STREAMINFO block. </td></tr>
75
 
</table>
76
 
</dl>    </td>
77
 
  </tr>
78
 
</table>
79
 
<hr><address><small>Generated on Sat Jan 25 10:44:53 2003 for FLAC by
 
65
A pointer to space for the STREAMINFO block. Since <a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> is a simple structure with no memory allocation involved, you pass the address of an existing structure. It need not be initialized. </td></tr>
 
66
</table>
 
67
</dl><dl compact><dt><b>
 
68
Assertions:</b><dd>
 
69
 <div class="fragment"><pre>filename != NULL 
 
70
</pre></div> <div class="fragment"><pre>streaminfo != NULL 
 
71
</pre></div> </dl><dl compact><dt><b>
 
72
Return values: </b><dd>
 
73
<table border=0 cellspacing=2 cellpadding=0>
 
74
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
75
<code>true</code> if a valid STREAMINFO block was read from <em>filename</em>. Returns <code>false</code> if there was a memory allocation error, a file decoder error, or the file contained no STREAMINFO block. (A memory allocation error is possible because this function must set up a file decoder.) </td></tr>
 
76
</table>
 
77
</dl>    </td>
 
78
  </tr>
 
79
</table>
 
80
<a name="a1" doxytag="metadata.h::FLAC__metadata_get_tags"></a><p>
 
81
<table width="100%" cellpadding="2" cellspacing="0" border="0">
 
82
  <tr>
 
83
    <td class="md">
 
84
      <table cellpadding="0" cellspacing="0" border="0">
 
85
        <tr>
 
86
          <td class="md" nowrap valign="top"> FLAC__bool FLAC__metadata_get_tags </td>
 
87
          <td class="md" valign="top">(&nbsp;</td>
 
88
          <td class="md" nowrap valign="top">const char *&nbsp;</td>
 
89
          <td class="mdname" nowrap>&nbsp; <em>filename</em>, </td>
 
90
        </tr>
 
91
        <tr>
 
92
          <td></td>
 
93
          <td></td>
 
94
          <td class="md" nowrap><a class="el" href="structFLAC____StreamMetadata.html">FLAC__StreamMetadata</a> **&nbsp;</td>
 
95
          <td class="mdname" nowrap>&nbsp; <em>tags</em></td>
 
96
        </tr>
 
97
        <tr>
 
98
          <td></td>
 
99
          <td class="md">)&nbsp;</td>
 
100
          <td class="md" colspan="2"></td>
 
101
        </tr>
 
102
 
 
103
      </table>
 
104
    </td>
 
105
  </tr>
 
106
</table>
 
107
<table cellspacing=5 cellpadding=0 border=0>
 
108
  <tr>
 
109
    <td>
 
110
      &nbsp;
 
111
    </td>
 
112
    <td>
 
113
 
 
114
<p>
 
115
Read the VORBIS_COMMENT metadata block of the given FLAC file. This function will skip any ID3v2 tag at the head of the file.<dl compact><dt><b>
 
116
Parameters: </b><dd>
 
117
<table border=0 cellspacing=2 cellpadding=0>
 
118
<tr><td valign=top><em>filename</em>&nbsp;</td><td>
 
119
The path to the FLAC file to read. </td></tr>
 
120
<tr><td valign=top><em>tags</em>&nbsp;</td><td>
 
121
The address where the returned pointer will be stored. The <em>tags</em> object must be deleted by the caller using <a class="el" href="group__flac__metadata__object.html#a2">FLAC__metadata_object_delete</a>(). </td></tr>
 
122
</table>
 
123
</dl><dl compact><dt><b>
 
124
Assertions:</b><dd>
 
125
 <div class="fragment"><pre>filename != NULL 
 
126
</pre></div> <div class="fragment"><pre>streaminfo != NULL 
 
127
</pre></div> </dl><dl compact><dt><b>
 
128
Return values: </b><dd>
 
129
<table border=0 cellspacing=2 cellpadding=0>
 
130
<tr><td valign=top><em>FLAC__bool</em>&nbsp;</td><td>
 
131
<code>true</code> if a valid VORBIS_COMMENT block was read from <em>filename</em>, and <em>*tags</em> will be set to the address of the tag structure. Returns <code>false</code> if there was a memory allocation error, a file decoder error, or the file contained no VORBIS_COMMENT block, and <em>*tags</em> will be set to <code>NULL</code>. </td></tr>
 
132
</table>
 
133
</dl>    </td>
 
134
  </tr>
 
135
</table>
 
136
<hr><address><small>Generated on Tue Sep 28 21:19:43 2004 for FLAC by
80
137
<a href="http://www.doxygen.org/index.html">
81
138
<img src="doxygen.gif" alt="doxygen" align="middle" border=0 
82
139
width=110 height=53></a>1.2.14 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,