FSOUND_Sample_SetDefaultsEx

Sets a sample's default attributes, so when it is played it uses these values without having to specify them later.

signed char F_API FSOUND_Sample_SetDefaultsEx(
FSOUND_SAMPLE *sptr,
int deffreq,
int defvol,
int defpan,
int defpri,
int varfreq,
int varvol,
int varpan
);

Parameters

sptr	Pointer to the sample to have its attributes set.
deffreq	Default sample frequency. The value here is specified in hz. -1 to ignore.
defvol	Default sample volume. This is a value from 0 to 255. -1 to ignore.
defpan	Default sample pan position. This is a value from 0 to 255 or FSOUND_STEREOPAN.
defpri	Default sample priority. This is a value from 0 to 255. -1 to ignore.
varfreq	Frequency variation in hz to apply to deffreq each time this sample is played. -1 to ignore.
varvol	Volume variation to apply to defvol each time this sample is played. -1 to ignore.
varpan	Pan variation to apply to defpan each time this sample is played. -1 to ignore.

Return Value

On success, TRUE is returned.
On failure, FALSE is returned.

Remarks

Frequency, volume and pan variation values specify a +/- variation to the specified default frequency, volume and pan values i.e. with deffreq=44100, varfreq=2000 the actual frequency value used will be in the range 42100 -> 46100.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

[API function]