alSynNew.3p
1.58 KB
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
.TH alSynNew 3P local "Silicon Graphics, Inc."
.SH NAME
.upperok
alSynNew \- allocate the specified synthesizer driver.
.SH SYNOPSIS
.nf
\f3
.Op c
#include <libaudio.h>
.sp .8v
void alSynNew(ALSynth *drvr, ALSynConfig *c);
.Op
\f1
.fi
.SH PARAMETERS
.TP 10
.I drvr
pointer to the synthesizer driver.
.TP
.I c
pointer to the synthesizer configuration.
.SH DESCRIPTION
Initialize the synthesizer driver structure pointed to by drvr, using
parameters specified in the configuration structure. alSynNew will allocate
memory from the heap for voices and driver objects. alSynNew should always
be called before any call to alAudioFrame. The parameters of the
configuration structure are as follows:
.TP 15
.I maxVVoices
maximum number of virtual voices.
.TP
.I maxPVoices
maximum number of physical voices.
.TP
.I maxUpdates
maximum number of pending parameter updates.
.TP
.I maxFXBusses
maximum number of auxiliary effect busses. (Currently this value is ignored,
and a maximum of one bus is imposed.)
.TP
.I dmaproc
pointer to procedure to use when initializing DMA callbacks.
.TP
.I heap
pointer to audio system memory heap.
.TP
.I outputRate
numbers of samples per second for synthesizer to generate.
.TP
.I fxType
type of effect to use, can be AL_FX_NONE, AL_FX_SMALLROOM, AL_FX_BIGROOM,
AL_FX_ECHO, AL_FX_CHORUS, AL_FX_FLANGE, AL_FX_CUSTOM.
.TP
.I params
Pointer to an array of parameters, to be used in the case of AL_FX_CUSTOM. For
more information on these parameters refer to the Ultra 64 programming manual's
audio section detailing creation of custom effects.
.SH SEE ALSO
.IR alSynDelete (3P)