← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/nas/jaunty

« back to all changes in this revision

Viewing changes to doc/html/man3/AuSRecTB.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve McIntyre
  • Date: 2004-06-23 01:15:02 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20040623011502-30uqd1dyu47iv2dp
Tags: 1.6d-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/man3/AuSRecTB.html
 
1
<!-- manual page source format generated by PolyglotMan v3.0.7, -->
 
2
<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
 
3
 
 
4
<HTML>
 
5
<HEAD>
 
6
<TITLE>man page(1)</TITLE>
 
7
</HEAD>
 
8
<BODY bgcolor=white>
 
9
<A HREF="#toc">Table of Contents</A><P>
 
10
 
 
11
<H2><A NAME="sect0" HREF="#toc0">Name</A></H2>
 
12
 
 
13
<P>
 
14
<B>AuSoundRecordToBucket</B> - create a flow to record to a
 
15
bucket.
 
16
 
 
17
<H2><A NAME="sect1" HREF="#toc1"><B>Synopsis</B></A></H2>
 
18
 
 
19
<P>
 
20
#include &lt;audio/audiolib.h&gt;<BR>
 
21
 
 
22
#include &lt;audio/soundlib.h&gt;
 
23
<P>
 
24
<B>AuEventHandlerRec</B> *<B>AuSoundRecordToBucket</B>(<I>server</I>, <I>destina</I><B>_</B>t<I>ion</I>,
 
25
<I>source</I>, <I>gain</I>, <I>callback</I>, <I>callback</I><B>_</B><I>data</I>, <I>mode</I>, <I>flow</I>,
 
26
<I>volume</I><B>_</B><I>mult</I><B>_</B><I>elem</I>, <I>status</I>)<BR>
 
27
 
 
28
<B>AuServer</B> *<I>server</I>;<BR>
 
29
 
 
30
<B>AuBucketID</B> <I>destination</I>;<BR>
 
31
 
 
32
<B>AuDeviceID</B> <I>source</I>;<BR>
 
33
 
 
34
<B>AuFixedPoint</B> <I>gain</I>;<BR>
 
35
 
 
36
void (*<I>callback</I>) (<B>AuServer</B> *, <B>AuEventHandlerRec</B> *,
 
37
<B>AuEvent</B> *, <B>AuPointer</B>);<BR>
 
38
 
 
39
<B>AuPointer</B> <I>callback</I><B>_</B><I>data</I>;<BR>
 
40
 
 
41
int <I>mode</I>;<BR>
 
42
 
 
43
<B>AuFlowID</B> *<I>flow</I>; /* <B>RETURN</B> */<BR>
 
44
 
 
45
int *<I>volume</I><B>_</B><I>mult</I><B>_</B><I>elem</I>; /* <B>RETURN</B> */
 
46
<B>AuStatus</B> *<I>status</I>; /* <B>RETURN</B> */
 
47
 
 
48
<H2><A NAME="sect2" HREF="#toc2"><B>Arguments</B></A></H2>
 
49
 
 
50
 
 
51
<DL>
 
52
 
 
53
<DT><I>server</I> </DT></DT>
 
54
<DD>   Specifies the connection to the audio server.
 
55
</DD>
 
56
</DL>
 
57
<P>
 
58
<I>destination</I><BR>
 
59
 
 
60
Specifies the bucket to record to.
 
61
 
 
62
<DL>
 
63
 
 
64
<DT><I>source</I> </DT></DT>
 
65
<DD>   Specifies the input device to record from.
 
66
</DD>
 
67
 
 
68
<DT><I>gain</I> </DT></DT>
 
69
<DD>     Specifies the gain for the input device.
 
70
</DD>
 
71
</DL>
 
72
<P>
 
73
<I>callback</I> Specifies the procedure to be called for additional
 
74
event processing.
 
75
<P>
 
76
<I>callback</I><B>_</B><I>data</I><BR>
 
77
 
 
78
Specifies any additional arguments to be passed
 
79
to the callback.
 
80
 
 
81
<DL>
 
82
 
 
83
<DT><I>mode</I> </DT></DT>
 
84
<DD>     Specifies the line mode for the input device.
 
85
Currently the following line modes are defined:
 
86
<B>AuDeviceInputModeNone</B>, <B>AuDeviceInputModeLineIn</B>,
 
87
<B>AuDeviceInputModeMicrophone</B>.
 
88
</DD>
 
89
 
 
90
<DT><I>flow</I> </DT></DT>
 
91
<DD>     If non-NULL, returns the flow ID.
 
92
</DD>
 
93
</DL>
 
94
<P>
 
95
<I>volume</I><B>_</B><I>mult</I><B>_</B><I>elem</I><BR>
 
96
 
 
97
According to the comment in the source, not
 
98
implemented.
 
99
 
 
100
<DL>
 
101
 
 
102
<DT><I>status</I> </DT></DT>
 
103
<DD>   If non-NULL, flush the output buffer and return
 
104
the status from the server.
 
105
</DD>
 
106
</DL>
 
107
 
 
108
<H2><A NAME="sect3" HREF="#toc3"><B>Description</B></A></H2>
 
109
 
 
110
<P>
 
111
<B>AuSoundRecordToBucket</B> creates a flow to record from <I>source</I>
 
112
into <I>destination</I> and returns a pointer to the event handler
 
113
created or NULL if there was an error.
 
114
 
 
115
<H2><A NAME="sect4" HREF="#toc4"><B>Errors</B></A></H2>
 
116
 
 
117
<P>
 
118
<B>AuBadBucket</B>, <B>AuBadDevice</B>.
 
119
 
 
120
<H2><A NAME="sect5" HREF="#toc5"><B>See</B> <B>Also</B></A></H2>
 
121
 
 
122
<P>
 
123
<B>AuSoundRecord</B>, <B>AuSoundRecordToData</B>, <B>AuSoundRecordToFile</B>,
 
124
<B>AuSoundRecordToFileN</B>.
 
125
<P>
 
126
audiolib - <B>Network</B> <B>Audio</B> <B>System</B> C Language Interface
 
127
<P>
 
128
 
 
129
<HR><P>
 
130
<A NAME="toc"><B>Table of Contents</B></A><P>
 
131
<UL>
 
132
<LI><A NAME="toc0" HREF="#sect0">Name</A></LI>
 
133
<LI><A NAME="toc1" HREF="#sect1">Synopsis</A></LI>
 
134
<LI><A NAME="toc2" HREF="#sect2">Arguments</A></LI>
 
135
<LI><A NAME="toc3" HREF="#sect3">Description</A></LI>
 
136
<LI><A NAME="toc4" HREF="#sect4">Errors</A></LI>
 
137
<LI><A NAME="toc5" HREF="#sect5">See Also</A></LI>
 
138
</UL>
 
139
</BODY></HTML>