alSndpSetPitch.3p 1.18 KB
.TH alSndpSetPitch 3P local "Silicon Graphics, Inc."

.SH NAME 
.upperok 
alSndpSetPitch \- set the pitch of the current target sound

.SH SYNOPSIS
.nf
\f3
.Op c
#include <libaudio.h>
.sp .8v
void	alSndpSetPitch(ALSndPlayer *sndp, f32 pitch);
.Op
\f1
.fi
.SH PARAMETERS
.TP 10
.I sndp
pointer to a sound player. 
.TP
.I pitch
pitch. A value of 1 indicates original pitch, fractional values indicate
lower pitches, eg 0.5 indicates an octave lower than original pitch. The maximum pitch allowable is 2.0 (pitch shift up 1 octave). Values greater than 2.0
will be clipped to 2.0 when the sound is played.  The minimum pitch allowable is 0.0001.  Values less than 0.0001 will be clipped to 0.0001 when the sound
is played. Note that this value represents the practical limit for pitch shifting since it will cause a 20 kHz sound to be played at 20 Hz.
.SH DESCRIPTION
Set the pitch of the current target sound. 
The target sound should be set with a call to 
.IR alSndpSetSound(3P).
If the sound is playing
the pitch will be adjusted. If the sound is not playing this call
will effect the pitch of the sound when it is played.
.SH SEE ALSO
.IR alSndpSetVol (3P),
.IR alSndpSetPan (3P),
.IR alSndpSetFXmix (3P)