Previous Topic Index Next Topic
[API function]

FSOUND_Sample_SetDefaults

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_SetDefaults(
FSOUND_SAMPLE *sptr,
int deffreq,
int defvol,
int defpan,
int defpri
);

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 vale from 0 to 255. -1 to ignore.
defpri Default sample priority. This is a value from 0 to 255. -1 to ignore.

Return Value

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

Remarks

See Also

FSOUND_Sample_Alloc , FSOUND_Sample_GetDefaults , FSOUND_Sample_GetLoopPoints , FSOUND_Sample_GetMode , FSOUND_Sample_SetLoopMode , FSOUND_SetFrequency , FSOUND_SetPan , FSOUND_SetPriority , FSOUND_SetVolume

This document copyright ©Firelight Multimedia, 1999-2001. All rights reserved.
Generated Thu Sep 13 00:18:09 2001 by SourceDoc v0.10, the automated source code documenter.