File: AuMElMul.man

package info (click to toggle)
nas 1.2p5-3
  • links: PTS
  • area: main
  • in suites: hamm
  • size: 4,504 kB
  • ctags: 5,430
  • sloc: ansic: 51,775; perl: 1,104; yacc: 215; cpp: 199; sh: 92; makefile: 58; lex: 44
file content (64 lines) | stat: -rw-r--r-- 3,031 bytes parent folder | download | duplicates (3)
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
.\" $NCDId: @(#)AuMElMul.man,v 1.1 1994/09/27 00:32:31 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: AuMakeElementMultiplyConstant.man,v 1.3 1994/08/11 17:59:14 sking Exp $
.TH AuMakeElementMultiplyConstant 3 "1.2" "audiolib - element initialization"
.SH \fBName\fP
\fBAuMakeElementMultiplyConstant\fP \- initialize a MultiplyConstant element
.SH \fBSynopsis\fP
#include <audio/audiolib.h>
.sp 1
\fBAuMakeElementMultiplyConstant\fP(\fIelement\fP, \fIinput\fP, \fIconstant\fP)
.br
    \fBAuElement\fP *\fIelement\fP; /* \fBRETURN\fP */
.br
    unsigned short \fIinput\fP;
.br
    \fBAuFixedPoint\fP \fIconstant\fP;
.SH \fBArguments\fP
.IP \fIelement\fP 1i
Returns the initialized element.
.IP \fIinput\fP 1i
Specifies the index of the element to supply the audio data for this element.
.IP \fIconstant\fP 1i
Specifies the fixed point value that each sample from the input will be multiplied by.
Fixed point values can be constructed with \fBAuFixedPointFromSum\fP and \fBAuFixedPointFromFraction\fP.
.SH \fBDescription\fP
\fBAuMakeElementMultiplyConstant\fP sets the \fItype\fP of \fIelement\fP to \fBAuElementTypeMultiplyConstant\fP and initializes the \fImultiplyconstant\fP member of \fIelement\fP with the remaining arguments.
.LP
\fBAuMakeElementMultiplyConstant\fP is implemented as a macro.
.SH \fBSee Also\fP
\fBAuMakeElementAddConstant\fP,
\fBAuMakeElementBundle\fP,
\fBAuMakeElementExportBucket\fP,
\fBAuMakeElementExportClient\fP,
\fBAuMakeElementExportDevice\fP,
\fBAuMakeElementExportMonitor\fP,
\fBAuMakeElementImportBucket\fP,
\fBAuMakeElementImportClient\fP,
\fBAuMakeElementImportDevice\fP,
\fBAuMakeElementImportWaveForm\fP,
\fBAuMakeElementSum\fP.
.sp 1
audiolib \- \fBNetwork Audio System\fP C Language Interface