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
|
<!--
$NCDId: @(#)AuSRecTF.man,v 1.2 1995/05/23 23:53:09 greg Exp $
copyright 1994 Steven King
portions are
* Copyright 1993 Network Computing Devices, Inc.
*
* Permission to use, copy, modify, distribute, and sell this software and its
* documentation for any purpose is hereby granted without fee, provided that
* the above copyright notice appear in all copies and that both that
* copyright notice and this permission notice appear in supporting
* documentation, and that the name Network Computing Devices, Inc. not be
* used in advertising or publicity pertaining to distribution of this
* software without specific, written prior permission.
*
* THIS SOFTWARE IS PROVIDED 'AS-IS'. NETWORK COMPUTING DEVICES, INC.,
* DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT
* LIMITATION ALL IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
* PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT SHALL NETWORK
* COMPUTING DEVICES, INC., BE LIABLE FOR ANY DAMAGES WHATSOEVER, INCLUDING
* SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, INCLUDING LOSS OF USE, DATA,
* OR PROFITS, EVEN IF ADVISED OF THE POSSIBILITY THEREOF, AND REGARDLESS OF
* WHETHER IN AN ACTION IN CONTRACT, TORT OR NEGLIGENCE, ARISING OUT OF OR IN
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
$Id: AuSoundRecordToFile.3.html 243 2007-04-07 23:13:43Z jon $
-->
<!-- manual page source format generated by PolyglotMan v3.0.8+X.Org, -->
<!-- available at http://polyglotman.sourceforge.net/ -->
<html>
<head>
<title>AuSoundRecordToFile(3) manual page</title>
</head>
<body bgcolor='#efefef' text='black' link='blue' vlink='#551A8B' alink='red'>
<a href='#toc'>Table of Contents</a><p>
<h2><a name='sect0' href='#toc0'><b>Name</b></a></h2>
<b>AuSoundRecordToFile</b> - create a flow to record
to a file.
<h2><a name='sect1' href='#toc1'><b>Synopsis</b></a></h2>
#include <audio/audiolib.h> <br>
#include <audio/soundlib.h> <p>
<b>AuEventHandlerRec</b> *<b>AuSoundRecordToFile</b>(<i>server</i>,
<i>filename</i>, <i>source</i>, <i>gain</i>, <i>callback</i>, <i>callback_data</i>, <i>mode</i>, <i>file_format</i>, <i>comment</i>,
<i>rate</i>, <i>data_format</i>, <i>flow</i>, <i>volume_mult_elem</i>, <i>status</i>) <br>
<b>AuServer</b> *<i>server</i>;<br>
<br>
char *<i>filename</i>;<br>
<br>
<b>AuDeviceID</b> <i>source</i>;<br>
<br>
<b>AuFixedPoint</b> <i>gain</i>;<br>
<br>
void (*<i>callback</i>) (<b>AuServer</b> *, <b>AuEventHandlerRec</b> *, <b>AuEvent</b> *, <b>AuPointer</b>);<br>
<br>
<b>AuPointer</b> <i>callback_data</i>;<br>
<br>
int <i>mode</i>;<br>
<br>
int <i>file_format</i>;<br>
<br>
char *<i>comment</i>;<br>
<br>
<b>AuUint32</b> <i>rate</i>;<br>
<br>
int <i>data_format</i>;<br>
<br>
<b>AuFlowID</b> *<i>flow</i>; /* <b>RETURN</b> */<br>
<br>
int *<i>volume_mult_elem</i>; /* <b>RETURN</b> */<br>
<br>
<b>AuStatus</b> *<i>status</i>; /* <b>RETURN</b> */<br>
<h2><a name='sect2' href='#toc2'><b>Arguments</b></a></h2>
<dl>
<dt><i>server</i></dt>
<dd>Specifies the connection to the audio server. </dd>
<dt><i>filename</i></dt>
<dd>Specifies
the name of the file to record to. </dd>
<dt><i>source</i></dt>
<dd>Specifies the input device to use.
</dd>
<dt><i>gain</i></dt>
<dd>Specifies the gain for the input device. </dd>
<dt><i>callback</i></dt>
<dd>Specifies the procedure
to be called for additional event processing. </dd>
<dt><i>callback_data</i></dt>
<dd>Specifies any
additional arguments to be passed to the callback. </dd>
<dt><i>mode</i></dt>
<dd>Specifies the line
mode for the input device. Currently the following line modes are defined:
<b>AuDeviceInputModeNone</b>, <b>AuDeviceInputModeLineIn</b>, <b>AuDeviceInputModeMicrophone</b>.
</dd>
<dt><i>file_format</i></dt>
<dd>Specifies the file format. Currently, the following file formats
are supported: <b>SoundFileFormatSnd</b>, <b>SoundFileFormatVoc</b>, <b>SoundFileFormatWave</b>,
<b>SoundFileFormatAiff</b>, <b>SoundFileFormatSvx</b>. </dd>
<dt><i>comment</i></dt>
<dd>Specifies a comment to embedded
in the file. </dd>
<dt><i>rate</i></dt>
<dd>Specifies the sample rate to record at. </dd>
<dt><i>data_format</i></dt>
<dd>Specifies
the data format. Currently, the following data formats are defined: <b>AuFormatULAW8</b>,
<b>AuFormatLinearUnsigned8</b>, <b>AuFormatLinearSigned8</b>, <b>AuFormatLinearSigned16MSB</b>,
<b>AuFormatLinearUnsigned16MSB</b>, <b>AuFormatSignedLinear16LSB</b>, and <b>AuFormatLinearUnsigned16LSB</b>.
</dd>
<dt><i>flow</i></dt>
<dd>If non-NULL, returns the flow ID. </dd>
<dt><i>volume_mult_elem</i></dt>
<dd>Accord to the comment
in the source, not implemented. </dd>
<dt><i>status</i></dt>
<dd>If non-NULL, flush the output buffer
and return the status from the server. </dd>
</dl>
<h2><a name='sect3' href='#toc3'><b>Description</b></a></h2>
<b>AuSoundRecordToFile</b> creates
a flow to record from <i>source</i> to <i>filename</i> and returns a pointer to the event
handler created or NULL if there was an error.
<h2><a name='sect4' href='#toc4'><b>Errors</b></a></h2>
<b>AuBadDevice</b>.
<h2><a name='sect5' href='#toc5'><b>See Also</b></a></h2>
<b>AuSoundRecord</b>,
<b>AuSoundRecordToBucket</b>, <b>AuSoundRecordToData</b>, <b>AuSoundRecordToFileN</b>. <p>
audiolib
- <b>Network Audio System</b> C Language Interface <p>
<hr><p>
<a name='toc'><b>Table of Contents</b></a><p>
<ul>
<li><a name='toc0' href='#sect0'>Name</a></li>
<li><a name='toc1' href='#sect1'>Synopsis</a></li>
<li><a name='toc2' href='#sect2'>Arguments</a></li>
<li><a name='toc3' href='#sect3'>Description</a></li>
<li><a name='toc4' href='#sect4'>Errors</a></li>
<li><a name='toc5' href='#sect5'>See Also</a></li>
</ul>
</body>
</html>
|
