Previous Topic Index Next Topic
[API function]

FSOUND_Sample_GetDefaults

Returns the default volume, frequency, pan and priority values for the specified sample.

signed char F_API FSOUND_Sample_GetDefaults(
FSOUND_SAMPLE *sptr,
int *deffreq,
int *defvol,
int *defpan,
int *defpri
);

Parameters

sptr Pointer to the sample to get the default information from.
deffreq Pointer to value to be filled with the sample
s default frequency. Can be NULL. defvol
Pointer to value to be filled with the sample s default volume. Can be NULL.
defpan Pointer to value to be filled with the sample
s default pan. Can be NULL. defpri
Pointer to value to be filled with the sample s default priority. 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

See Also

FSOUND_Sample_SetDefaults

This document copyright ©Firelight Technologies, Pty, Ltd, 1999-2002. All rights reserved.
Generated Fri Dec 20 16:31:09 2002 by SourceDoc v0.10, the automated source code documenter.