This file is indexed.

/usr/share/doc/libucommon-dev/a00027.html is in libucommon-doc 3.2.0-0ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>UCommon: ucc::audiofile Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00027.html">audiofile</a>
  </div>
</div>
<div class="contents">
<h1>ucc::audiofile Class Reference</h1><!-- doxytag: class="ucc::audiofile" --><!-- doxytag: inherits="ucc::audiobuffer" -->
<p>Basic audio file access class.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00187_source.html">audio.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ucc::audiofile:</div>
<div class="dynsection">
<div class="center"><img src="a00355.png" border="0" usemap="#ucc_1_1audiofile_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1audiofile_inherit__map" id="ucc_1_1audiofile_inherit__map">
<area shape="rect" id="node2" href="a00025.html" title="Generic audio buffering and transcoding for audio sources and sinks." alt="" coords="81,83,204,112"/><area shape="rect" id="node4" href="a00024.html" title="Common access to audio frames." alt="" coords="5,5,144,35"/><area shape="rect" id="node6" href="a00023.html" title="Common audio class for GNU telephonic audio." alt="" coords="168,5,253,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::audiofile:</div>
<div class="dynsection">
<div class="center"><img src="a00356.png" border="0" usemap="#ucc_1_1audiofile_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1audiofile_coll__map" id="ucc_1_1audiofile_coll__map">
<area shape="rect" id="node2" href="a00025.html" title="Generic audio buffering and transcoding for audio sources and sinks." alt="" coords="120,317,243,347"/><area shape="rect" id="node4" href="a00024.html" title="Common access to audio frames." alt="" coords="5,187,144,216"/><area shape="rect" id="node6" href="a00023.html" title="Common audio class for GNU telephonic audio." alt="" coords="139,96,224,125"/><area shape="rect" id="node8" href="a00026.html" title="Convert audio media." alt="" coords="219,187,344,216"/><area shape="rect" id="node10" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="248,96,381,125"/><area shape="rect" id="node12" href="a00093.html" title="A common base class for all managed objects." alt="" coords="268,5,361,35"/><area shape="rect" id="node16" href="a00056.html" title="A container for generic and o/s portable threadsafe file system functions." alt="" coords="267,317,344,347"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00027.html#a54f8669b60d5481f42e3376af831a628">access</a> (<a class="el" href="a00025.html">audiobuffer</a> *buffer, char *path, <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> preferred=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Access an existing audio file to play.  <a href="#a54f8669b60d5481f42e3376af831a628"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00027.html#a2f10e3b2713efe378c238d5e215abd46">append</a> (<a class="el" href="a00025.html">audiobuffer</a> *buffer, char *path, <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> preferred=0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Append audio to an existing file.  <a href="#a2f10e3b2713efe378c238d5e215abd46"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00027.html#a5c396fed274f66724266f59c69683b34">create</a> (<a class="el" href="a00025.html">audiobuffer</a> *buffer, char *path, <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> preferred=0, char *note=((void *) 0), <a class="el" href="a00026.html">audiocodec</a> *encoding=((void *) 0), unsigned mode=0640)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a new file to record audio into.  <a href="#a5c396fed274f66724266f59c69683b34"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2b4ca390ea1e394850fdeaca82b1c8a5"></a><!-- doxytag: member="ucc::audiofile::info" ref="a2b4ca390ea1e394850fdeaca82b1c8a5" args="(audiobuffer *buffer, char *path, timeout_t framing=0)" -->
static bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>info</b> (<a class="el" href="a00025.html">audiobuffer</a> *buffer, char *path, <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> framing=0)</td></tr>
<tr><td colspan="2"><h2>Protected Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <b>RAW</b>, 
<b>AU</b>, 
<b>RIFF</b>, 
<b>WAV</b>
 }</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8377235ae5e90e4b97f789e3754bd68"></a><!-- doxytag: member="ucc::audiofile::append" ref="af8377235ae5e90e4b97f789e3754bd68" args="(void)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>append</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4f090dd7250cf6e1ee750c7375ba4b91"></a><!-- doxytag: member="ucc::audiofile::flush" ref="a4f090dd7250cf6e1ee750c7375ba4b91" args="(void)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>flush</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d7a5261657ecbd0e5eaf6a66911fd4e"></a><!-- doxytag: member="ucc::audiofile::handle" ref="a8d7a5261657ecbd0e5eaf6a66911fd4e" args="(void)" -->
fd_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>handle</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba14c72f57a737d2b6867ccd4aba4bc3"></a><!-- doxytag: member="ucc::audiofile::length" ref="aba14c72f57a737d2b6867ccd4aba4bc3" args="(void)" -->
<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>length</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a82eb3d4350ece538f63cf0d4c0deb463"></a><!-- doxytag: member="ucc::audiofile::locate" ref="a82eb3d4350ece538f63cf0d4c0deb463" args="(void)" -->
<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>locate</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac25ee3197596107149deb65701eaae40"></a><!-- doxytag: member="ucc::audiofile::open" ref="ac25ee3197596107149deb65701eaae40" args="(char *path, fsys::access_t access, size_t objsize, timeout_t framing)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>open</b> (char *path, <a class="el" href="a00056.html#a5e886a4f005b2a2948d2a3fb4e9f0deb">fsys::access_t</a> access, size_t objsize, <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> framing)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a98c72b78dcf4d637c3c005cf493e92f4"></a><!-- doxytag: member="ucc::audiofile::operator bool" ref="a98c72b78dcf4d637c3c005cf493e92f4" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>operator bool</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a264892ef6e7f547d7596062be09ecadd"></a><!-- doxytag: member="ucc::audiofile::rewind" ref="a264892ef6e7f547d7596062be09ecadd" args="(void)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>rewind</b> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5242500278f0b75e3d22d6575f67de9"></a><!-- doxytag: member="ucc::audiofile::seek" ref="af5242500278f0b75e3d22d6575f67de9" args="(timeout_t position)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>seek</b> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> position)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a662f92c02b151fd12e882aa4a6a68427"></a><!-- doxytag: member="ucc::audiofile::skip" ref="a662f92c02b151fd12e882aa4a6a68427" args="(timeout_t offset)" -->
<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>skip</b> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> offset)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a122a4dc7dac4dc5e73baf801dc93d446"></a><!-- doxytag: member="ucc::audiofile::trim" ref="a122a4dc7dac4dc5e73baf801dc93d446" args="(timeout_t backup)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>trim</b> (<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> backup)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae09bb6c86f4b4dc1cff292367853c5d2"></a><!-- doxytag: member="ucc::audiofile::bufend" ref="ae09bb6c86f4b4dc1cff292367853c5d2" args="" -->
unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><b>bufend</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a813bd82bd3c8e517ef187688af112815"></a><!-- doxytag: member="ucc::audiofile::bufio" ref="a813bd82bd3c8e517ef187688af112815" args="" -->
size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>bufio</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae8c0cf35d17afacecdaa8f557f176101"></a><!-- doxytag: member="ucc::audiofile::bufpos" ref="ae8c0cf35d17afacecdaa8f557f176101" args="" -->
unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><b>bufpos</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2f7968c0f9e8ba49990ddb8b5c15476b"></a><!-- doxytag: member="ucc::audiofile::current" ref="a2f7968c0f9e8ba49990ddb8b5c15476b" args="" -->
<a class="el" href="a00056.html#acd8d82ddbf77b2c44371f3bf19746f60">fsys::offset_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>current</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7d89df63d413255fc9257e4941432c93"></a><!-- doxytag: member="ucc::audiofile::filetype" ref="a7d89df63d413255fc9257e4941432c93" args="" -->
enum ucc::audiofile:: { ... } &nbsp;</td><td class="memItemRight" valign="bottom"><b>filetype</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a568d1f90ca811e52a0a2cd70172ddeb7"></a><!-- doxytag: member="ucc::audiofile::fs" ref="a568d1f90ca811e52a0a2cd70172ddeb7" args="" -->
<a class="el" href="a00056.html">fsys</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>fs</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6bb803906031e2e9fd62fb9db09870d"></a><!-- doxytag: member="ucc::audiofile::header" ref="af6bb803906031e2e9fd62fb9db09870d" args="[40]" -->
uint8_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>header</b> [40]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6db6363134b763c8c0407741b875d37"></a><!-- doxytag: member="ucc::audiofile::headersize" ref="aa6db6363134b763c8c0407741b875d37" args="" -->
<a class="el" href="a00056.html#acd8d82ddbf77b2c44371f3bf19746f60">fsys::offset_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>headersize</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae7722ad536cdba77dba2fa36e4f74cca"></a><!-- doxytag: member="ucc::audiofile::hiwater" ref="ae7722ad536cdba77dba2fa36e4f74cca" args="" -->
<a class="el" href="a00056.html#acd8d82ddbf77b2c44371f3bf19746f60">fsys::offset_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>hiwater</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a808f7b6b7be1a1d39ce1a2baf1813356"></a><!-- doxytag: member="ucc::audiofile::maxio" ref="a808f7b6b7be1a1d39ce1a2baf1813356" args="" -->
size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>maxio</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acab02e00c05736ee5d5633082b9365c9"></a><!-- doxytag: member="ucc::audiofile::minio" ref="acab02e00c05736ee5d5633082b9365c9" args="" -->
size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>minio</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Basic audio file access class. </p>
<p>This holds common methods used for manipulating audio files through frame buffering. Additional reader and writer objects are derived to handle file access specific to each. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar &lt;<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>&gt; </dd></dl>

<p>Definition at line <a class="el" href="a00187_source.html#l00369">369</a> of file <a class="el" href="a00187_source.html">audio.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a54f8669b60d5481f42e3376af831a628"></a><!-- doxytag: member="ucc::audiofile::access" ref="a54f8669b60d5481f42e3376af831a628" args="(audiobuffer *buffer, char *path, timeout_t preferred=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static bool ucc::audiofile::access </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00025.html">audiobuffer</a> *&nbsp;</td>
          <td class="paramname"> <em>buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>path</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td>
          <td class="paramname"> <em>preferred</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Access an existing audio file to play. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>buffer</em>&nbsp;</td><td>to stream frames through. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>of file to access. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>preferred</em>&nbsp;</td><td>I/O framing. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if success. </dd></dl>

</div>
</div>
<a class="anchor" id="a2f10e3b2713efe378c238d5e215abd46"></a><!-- doxytag: member="ucc::audiofile::append" ref="a2f10e3b2713efe378c238d5e215abd46" args="(audiobuffer *buffer, char *path, timeout_t preferred=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static bool ucc::audiofile::append </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00025.html">audiobuffer</a> *&nbsp;</td>
          <td class="paramname"> <em>buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>path</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td>
          <td class="paramname"> <em>preferred</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Append audio to an existing file. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>buffer</em>&nbsp;</td><td>to use for appending frames. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>of file to append. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>preferred</em>&nbsp;</td><td>I/O framing. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if success. </dd></dl>

</div>
</div>
<a class="anchor" id="a5c396fed274f66724266f59c69683b34"></a><!-- doxytag: member="ucc::audiofile::create" ref="a5c396fed274f66724266f59c69683b34" args="(audiobuffer *buffer, char *path, timeout_t preferred=0, char *note=((void *) 0), audiocodec *encoding=((void *) 0), unsigned mode=0640)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static bool ucc::audiofile::create </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00025.html">audiobuffer</a> *&nbsp;</td>
          <td class="paramname"> <em>buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>path</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td>
          <td class="paramname"> <em>preferred</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>note</em> = <code>((void&nbsp;*)&nbsp;0)</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00026.html">audiocodec</a> *&nbsp;</td>
          <td class="paramname"> <em>encoding</em> = <code>((void&nbsp;*)&nbsp;0)</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&nbsp;</td>
          <td class="paramname"> <em>mode</em> = <code>0640</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Create a new file to record audio into. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>buffer</em>&nbsp;</td><td>to stream frames through. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>path</em>&nbsp;</td><td>of file to access. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>preferred</em>&nbsp;</td><td>I/O framing. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>note</em>&nbsp;</td><td>to attach if format allows, NULL if none. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>encoding</em>&nbsp;</td><td>of target or 0 for default. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>mode</em>&nbsp;</td><td>of access for new file. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if success. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00187_source.html">audio.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:25 2010 for UCommon by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>