Previous Topic Index Next Topic
[API function]

FSOUND_Sample_GetDefaultsEx

Returns the default volume, frequency, pan, priority and random playback variations for the specified sample.

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

Parameters

sptr Pointer to the sample to get the default information from.
deffreq Pointer to value to be filled with the sample default frequency. Can be NULL.
defvol Pointer to value to be filled with the sample default volume. Can be NULL.
defpan Pointer to value to be filled with the sample default pan. Can be NULL.
defpri Pointer to value to be filled with the sample default priority. Can be NULL.
varfreq Pointer to value to be filled with the sample random frequency variance. Can be NULL.
varvol Pointer to value to be filled with the sample random volume variance. Can be NULL.
varpan Pointer to value to be filled with the sample random pan variance. Can be NULL.

Return Value

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

Remarks

Passing NULL in any of these parameters will result in the value being ignored.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

See Also

FSOUND_Sample_GetDefaults , FSOUND_Sample_SetDefaults , FSOUND_Sample_SetDefaultsEx

This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Thu Dec 15 17:31:32 2005 by SourceDoc v0.10, the automated source code documenter.