alSndpNew.3p
1018 Bytes
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
.TH alSndpNew 3P local "Silicon Graphics, Inc."
.SH NAME
.upperok
alSndpNew \- initialize a sound player
.SH SYNOPSIS
.nf
\f3
.Op c
#include <libaudio.h>
.sp .8v
void alSndpNew(ALSndPlayer *sndp, ALSndpConfig *config);
.Op
\f1
.fi
.SH PARAMETERS
.TP 10
.I sndp
pointer to the sound player structure to initialize.
.TP
.I config
pointer to the sound player configuration structure.
.SH DESCRIPTION
alSndpNew initializes a sound player,
.I sndp,
for the configuration specified in
.I config
and signs into the synthesis driver as a client.
Note that it allocates memory from the (initialized)
.I ALHeap
referenced by the
.I config
structure.
.PP
The parameters in the ALSndpConfig structure determine how much is
allocated. These are as follows:
.TP 15
.I maxSounds
the maximum number of sounds which can be allocated to the player.
.TP
.I maxEvents
the maximum number of internal events to support.
.TP
.I heap
a pointer to an initialized audio heap.
.SH SEE ALSO
.IR alHeapNew (3P),
.IR alHeapAlloc (3P)