3
$NCDId: @(#)AuMElImC.man,v 1.1 1994/09/27 00:32:04 greg Exp $
4
copyright 1994 Steven King
7
* Copyright 1993 Network Computing Devices, Inc.
9
* Permission to use, copy, modify, distribute, and sell this software and its
10
* documentation for any purpose is hereby granted without fee, provided that
11
* the above copyright notice appear in all copies and that both that
12
* copyright notice and this permission notice appear in supporting
13
* documentation, and that the name Network Computing Devices, Inc. not be
14
* used in advertising or publicity pertaining to distribution of this
15
* software without specific, written prior permission.
17
* THIS SOFTWARE IS PROVIDED 'AS-IS'. NETWORK COMPUTING DEVICES, INC.,
18
* DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT
19
* LIMITATION ALL IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
20
* PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT SHALL NETWORK
21
* COMPUTING DEVICES, INC., BE LIABLE FOR ANY DAMAGES WHATSOEVER, INCLUDING
22
* SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, INCLUDING LOSS OF USE, DATA,
23
* OR PROFITS, EVEN IF ADVISED OF THE POSSIBILITY THEREOF, AND REGARDLESS OF
24
* WHETHER IN AN ACTION IN CONTRACT, TORT OR NEGLIGENCE, ARISING OUT OF OR IN
25
* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
27
$Id: AuMakeElementImportClient.3.html 243 2007-04-07 23:13:43Z jon $
30
<!-- manual page source format generated by PolyglotMan v3.0.8+X.Org, -->
31
<!-- available at http://polyglotman.sourceforge.net/ -->
35
<title>AuMakeElementImportClient(3) manual page</title>
37
<body bgcolor='#efefef' text='black' link='blue' vlink='#551A8B' alink='red'>
38
<a href='#toc'>Table of Contents</a><p>
40
<h2><a name='sect0' href='#toc0'><b>Name</b></a></h2>
41
<b>AuMakeElementImportClient</b> - initialize an ImportClient
43
<h2><a name='sect1' href='#toc1'><b>Synopsis</b></a></h2>
44
#include <audio/audiolib.h> <p>
45
<b>AuMakeElementImportClient</b>(<i>element</i>,
46
<i>sample_rate</i>, <i>format</i>, <i>num_tracks</i>, <i>discard</i>, <i>max_samples</i>, <i>low_water_mark</i>,
47
<i>num_actions</i>, <i>actions</i>) <br>
48
<b>AuElement</b> *<i>element</i>; /* <b>RETURN</b> */<br>
50
unsigned short <i>sample_rate</i>;<br>
52
unsigned char <i>format</i>;<br>
54
unsigned char <i>num_tracks</i>;<br>
56
unsigned char <i>discard</i>;<br>
58
<b>AuUint32</b> <i>max_samples</i>;<br>
60
<b>AuUint32</b> <i>low_water_mark</i>;<br>
62
int <i>num_actions</i>;<br>
64
<b>AuElementAction</b> *<i>actions</i>;<br>
66
<h2><a name='sect2' href='#toc2'><b>Arguments</b></a></h2>
70
<dt><i>element</i></dt>
71
<dd>Returns the initialized element. </dd>
73
<dt><i>sample_rate</i></dt>
75
sample rate of the audio data. </dd>
77
<dt><i>format</i></dt>
78
<dd>Specifies the format of the audio data.
79
Currently, the following formats are defined: <b>AuFormatULAW8</b>, <b>AuFormatLinearUnsigned8</b>,
80
<b>AuFormatLinearSigned8</b>, <b>AuFormatLinearSigned16MSB</b>, <b>AuFormatLinearUnsigned16MSB</b>,
81
<b>AuFormatSignedLinear16LSB</b>, and <b>AuFormatLinearUnsigned16LSB</b>. </dd>
83
<dt><i>num_tracks</i></dt>
85
the number of tracks in the audio data. </dd>
87
<dt><i>discard</i></dt>
88
<dd>Specifies if the import should
89
be paused initally. Normally <b>AuTrue</b>. <b>AuFalse</b> may crash the server. </dd>
91
<dt><i>max_samples</i></dt>
93
the maximum number of samples to accept in a single read. Ignored for "trivial"
96
<dt><i>low_water_mark</i></dt>
97
<dd>Specifies when to request additional audio data from
98
the client application. When this number of samples are left in the buffer,
99
and an EOF hasn't been received, a NotifyEvent with <i>kind</i> set to <b>AuElementNotifyKindLowWater</b>
100
will be sent to the client application. </dd>
102
<dt><i>num_actions</i></dt>
103
<dd>Specifies the number
104
of actions in <i>actions</i>. </dd>
106
<dt><i>actions</i></dt>
107
<dd>Specifies the list of actions to associate
108
with this element. Entries in this list can be initialized with <b>AuMakeChangeStateAction</b>,
109
<b>AuMakeSendNotifyAction</b>, and <b>AuMakeNoopAction</b>. May be NULL. </dd>
112
<h2><a name='sect3' href='#toc3'><b>Description</b></a></h2>
113
<b>AuMakeElementImportClient</b>
114
sets the <i>type</i> of <i>element</i> to <b>AuElementTypeImportClient</b> and initializes the
115
<i>importclient</i> member of <i>element</i> with the remaining arguments. <p>
116
<b>AuMakeElementImportClient</b>
117
is implemented as a macro.
118
<h2><a name='sect4' href='#toc4'><b>See Also</b></a></h2>
119
<b>AuMakeElementAddConstant</b>, <b>AuMakeElementBundle</b>,
120
<b>AuMakeElementExportClient</b>, <b>AuMakeElementExportDevice</b>, <b>AuMakeElementExportBucket</b>,
121
<b>AuMakeElementExportMonitor</b>, <b>AuMakeElementImportDevice</b>, <b>AuMakeElementImportBucket</b>,
122
<b>AuMakeElementImportWaveForm</b>, <b>AuMakeElementMultiplyConstant</b>, <b>AuMakeElementSum</b>.
124
audiolib - <b>Network Audio System</b> C Language Interface <p>
127
<a name='toc'><b>Table of Contents</b></a><p>
129
<li><a name='toc0' href='#sect0'>Name</a></li>
130
<li><a name='toc1' href='#sect1'>Synopsis</a></li>
131
<li><a name='toc2' href='#sect2'>Arguments</a></li>
132
<li><a name='toc3' href='#sect3'>Description</a></li>
133
<li><a name='toc4' href='#sect4'>See Also</a></li>