alSynSetPitch.3p
1.2 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
.TH alSynSetPitch 3P local "Silicon Graphics, Inc."
.SH NAME
.upperok
alSynSetPitch \- set the pitch of the specified voice.
.SH SYNOPSIS
.nf
\f3
.Op c
#include <libaudio.h>
.sp .8v
void alSynSetPitch(ALSynth *drvr, ALVoice *voice, float pitch);
.Op
\f1
.fi
.SH PARAMETERS
.TP 10
.I drvr
pointer to the synthesizer driver.
.TP
.I voice
pointer to a voice.
.TP 10
.I pitch
the pitch value.
.SH DESCRIPTION
Sets the rate at which a wavetable will be "rendered" by the synthesizer.
.I pitch
can range from 0 <
.I pitch
< 2.0. If the sample rate of the wavetable is the same as the output rate set
by
.I osAiSetFrequency
a value of 1.0 will play the sound with no pitch change, a value
of 0.5 will play the sound pitch shifted down an octave, and a value of 2.0
will play the pitch shifted up one octave. Negative
.I pitch
values are undefined. Care should be taken to insure that a
.I pitch
value of zero is never used, since it will cause a divide by zero. Values
greater than 2.0 will be clamped to 2.0.
.SH WARNING
alSynSetPitch should only be called from within an ALVoiceHandler.
.SH SEE ALSO
.IR alSynSetVol (3P),
.IR alSynSetPan (3P),
.IR alSynSetFXMix (3P),
.IR alSynStartVoiceParam (3P),
.IR osAiSetFrequency (3P)