~ubuntu-branches/debian/squeeze/nas/squeeze

« back to all changes in this revision

Viewing changes to doc/html/AuMakeElementImportWaveForm.3.html

  • Committer: Bazaar Package Importer
  • Author(s): Steve McIntyre
  • Date: 2008-10-08 01:18:19 UTC
  • mfrom: (4.1.7 intrepid)
  • Revision ID: james.westby@ubuntu.com-20081008011819-wmr4h2w0298k8t7z
Tags: 1.9.1-5
* Fix pending l10n issues. Debconf translations:
* Swedish. Closes: #491766 (thanks to brother@bsnet.se)
* Arabic. Closes: #500437 (thanks to Ossama Khayat)
* Basque. Closes: #500533 (thanks to Piarres Beobide)
* Brazilian Portuguese. Closes: #500973 (thanks to Felipe
  Augusto van de Wiel)
* Many thanks again to Christian Perrier for his i18n efforts,
  co-ordinating the above.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
<!--
 
3
  $NCDId: @(#)AuMElImW.man,v 1.1 1994/09/27 00:32:21 greg Exp $
 
4
   copyright 1994 Steven King
 
5
   
 
6
   portions are
 
7
   * Copyright 1993 Network Computing Devices, Inc.
 
8
   *
 
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.
 
16
   * 
 
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.
 
26
   
 
27
   $Id: AuMakeElementImportWaveForm.3.html 243 2007-04-07 23:13:43Z jon $
 
28
 
 
29
-->
 
30
<!-- manual page source format generated by PolyglotMan v3.0.8+X.Org, -->
 
31
<!-- available at http://polyglotman.sourceforge.net/ -->
 
32
 
 
33
<html>
 
34
<head>
 
35
<title>AuMakeElementImportWaveFrom(3) manual page</title>
 
36
</head>
 
37
<body bgcolor='#efefef' text='black' link='blue' vlink='#551A8B' alink='red'>
 
38
<a href='#toc'>Table of Contents</a><p>
 
39
 
 
40
<h2><a name='sect0' href='#toc0'><b>Name</b></a></h2>
 
41
<b>AuMakeElementImportWaveForm</b> - initialize an
 
42
ImportWaveForm element 
 
43
<h2><a name='sect1' href='#toc1'><b>Synopsis</b></a></h2>
 
44
#include &lt;audio/audiolib.h&gt; <p>
 
45
<b>AuMakeElementImportWaveForm</b>(<i>element</i>,
 
46
<i>sample_rate</i>, <i>wave_form</i>, <i>num_samples</i>, <i>freq</i>, <i>num_actions</i>, <i>actions</i>) <br>
 
47
    <b>AuElement</b> *<i>element</i>; /* <b>RETURN</b> */<br>
 
48
 <br>
 
49
    unsigned short <i>sample_rate</i>;<br>
 
50
 <br>
 
51
    int <i>wave_form</i>;<br>
 
52
 <br>
 
53
    <b>AuInt32</b> <i>freq</i>;<br>
 
54
 <br>
 
55
    <b>AuInt32</b> <i>num_samples</i>;<br>
 
56
 <br>
 
57
    int <i>num_actions</i>;<br>
 
58
 <br>
 
59
    <b>AuElementAction</b> *<i>actions</i>;<br>
 
60
 
 
61
<h2><a name='sect2' href='#toc2'><b>Arguments</b></a></h2>
 
62
 
 
63
<dl>
 
64
 
 
65
<dt><i>element</i></dt>
 
66
<dd>Returns the initialized element. </dd>
 
67
 
 
68
<dt><i>sample_rate</i></dt>
 
69
<dd>Specifies the
 
70
sample rate of the audio data. </dd>
 
71
 
 
72
<dt><i>wave_form</i></dt>
 
73
<dd>Specifies the waveform to use. Currently,
 
74
the following waveforms are defined: <b>AuWaveFormSquare</b>, <b>AuWaveFormSine</b>,
 
75
<b>AuWaveFormSaw</b>, and <b>AuWaveFormConstant. </dd>
 
76
 
 
77
<dt><i>freq</i></b></dt>
 
78
<dd>Specifies the frequency of the
 
79
waveform. </dd>
 
80
 
 
81
<dt><i>num_samples</i></dt>
 
82
<dd>Specifies the number of samples to read. Use <b>AuUnlimitedSamples</b>
 
83
to indicate an unlimited number of samples. </dd>
 
84
 
 
85
<dt><i>num_actions</i></dt>
 
86
<dd>Specifies the number
 
87
of actions in <i>actions</i>. </dd>
 
88
 
 
89
<dt><i>actions</i></dt>
 
90
<dd>Specifies the list of actions to associate
 
91
with this element. Entries in this list can be initialized with <b>AuMakeChangeStateAction</b>,
 
92
<b>AuMakeSendNotifyAction</b>, and <b>AuMakeNoopAction</b>. May be NULL. </dd>
 
93
</dl>
 
94
 
 
95
<h2><a name='sect3' href='#toc3'><b>Description</b></a></h2>
 
96
<b>AuMakeElementImportWaveForm</b>
 
97
sets the <i>type</i> member of <i>element</i> to <b>AuElementTypeImportWaveForm</b> and initializes
 
98
the <i>importwaveform</i> member of <i>element</i> with the remaining arguments. <p>
 
99
<b>AuMakeElementImportWaveForm</b>
 
100
is implemented as a macro. 
 
101
<h2><a name='sect4' href='#toc4'><b>Note</b>S</a></h2>
 
102
A server might not support all the waveforms
 
103
currently defined. 
 
104
<h2><a name='sect5' href='#toc5'><b>See Also</b></a></h2>
 
105
<b>AuMakeElementAddConstant</b>, <b>AuMakeElementBundle</b>,
 
106
<b>AuMakeElementExportBucket</b>, <b>AuMakeElementExportClient</b>, <b>AuMakeElementExportDevice</b>,
 
107
<b>AuMakeElementExportMonitor</b> <b>AuMakeElementImportBucket</b>, <b>AuMakeElementImportClient</b>,
 
108
<b>AuMakeElementImportDevice</b>, <b>AuMakeElementMultiplyConstant</b>, <b>AuMakeElementSum</b>.
 
109
<p>
 
110
audiolib - <b>Network Audio System</b> C Language Interface <p>
 
111
 
 
112
<hr><p>
 
113
<a name='toc'><b>Table of Contents</b></a><p>
 
114
<ul>
 
115
<li><a name='toc0' href='#sect0'>Name</a></li>
 
116
<li><a name='toc1' href='#sect1'>Synopsis</a></li>
 
117
<li><a name='toc2' href='#sect2'>Arguments</a></li>
 
118
<li><a name='toc3' href='#sect3'>Description</a></li>
 
119
<li><a name='toc4' href='#sect4'>NoteS</a></li>
 
120
<li><a name='toc5' href='#sect5'>See Also</a></li>
 
121
</ul>
 
122
</body>
 
123
</html>