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
|
<!--
$NCDId: @(#)AuMElImC.man,v 1.1 1994/09/27 00:32:04 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: AuMakeElementImportClient.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>AuMakeElementImportClient(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>AuMakeElementImportClient</b> - initialize an ImportClient
element
<h2><a name='sect1' href='#toc1'><b>Synopsis</b></a></h2>
#include <audio/audiolib.h> <p>
<b>AuMakeElementImportClient</b>(<i>element</i>,
<i>sample_rate</i>, <i>format</i>, <i>num_tracks</i>, <i>discard</i>, <i>max_samples</i>, <i>low_water_mark</i>,
<i>num_actions</i>, <i>actions</i>) <br>
<b>AuElement</b> *<i>element</i>; /* <b>RETURN</b> */<br>
<br>
unsigned short <i>sample_rate</i>;<br>
<br>
unsigned char <i>format</i>;<br>
<br>
unsigned char <i>num_tracks</i>;<br>
<br>
unsigned char <i>discard</i>;<br>
<br>
<b>AuUint32</b> <i>max_samples</i>;<br>
<br>
<b>AuUint32</b> <i>low_water_mark</i>;<br>
<br>
int <i>num_actions</i>;<br>
<br>
<b>AuElementAction</b> *<i>actions</i>;<br>
<h2><a name='sect2' href='#toc2'><b>Arguments</b></a></h2>
<dl>
<dt><i>element</i></dt>
<dd>Returns the initialized element. </dd>
<dt><i>sample_rate</i></dt>
<dd>Specifies the
sample rate of the audio data. </dd>
<dt><i>format</i></dt>
<dd>Specifies the format of the audio data.
Currently, the following 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>num_tracks</i></dt>
<dd>Specifies
the number of tracks in the audio data. </dd>
<dt><i>discard</i></dt>
<dd>Specifies if the import should
be paused initally. Normally <b>AuTrue</b>. <b>AuFalse</b> may crash the server. </dd>
<dt><i>max_samples</i></dt>
<dd>Specifies
the maximum number of samples to accept in a single read. Ignored for "trivial"
flows. </dd>
<dt><i>low_water_mark</i></dt>
<dd>Specifies when to request additional audio data from
the client application. When this number of samples are left in the buffer,
and an EOF hasn't been received, a NotifyEvent with <i>kind</i> set to <b>AuElementNotifyKindLowWater</b>
will be sent to the client application. </dd>
<dt><i>num_actions</i></dt>
<dd>Specifies the number
of actions in <i>actions</i>. </dd>
<dt><i>actions</i></dt>
<dd>Specifies the list of actions to associate
with this element. Entries in this list can be initialized with <b>AuMakeChangeStateAction</b>,
<b>AuMakeSendNotifyAction</b>, and <b>AuMakeNoopAction</b>. May be NULL. </dd>
</dl>
<h2><a name='sect3' href='#toc3'><b>Description</b></a></h2>
<b>AuMakeElementImportClient</b>
sets the <i>type</i> of <i>element</i> to <b>AuElementTypeImportClient</b> and initializes the
<i>importclient</i> member of <i>element</i> with the remaining arguments. <p>
<b>AuMakeElementImportClient</b>
is implemented as a macro.
<h2><a name='sect4' href='#toc4'><b>See Also</b></a></h2>
<b>AuMakeElementAddConstant</b>, <b>AuMakeElementBundle</b>,
<b>AuMakeElementExportClient</b>, <b>AuMakeElementExportDevice</b>, <b>AuMakeElementExportBucket</b>,
<b>AuMakeElementExportMonitor</b>, <b>AuMakeElementImportDevice</b>, <b>AuMakeElementImportBucket</b>,
<b>AuMakeElementImportWaveForm</b>, <b>AuMakeElementMultiplyConstant</b>, <b>AuMakeElementSum</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'>See Also</a></li>
</ul>
</body>
</html>
|
