Previous Topic Index Next Topic
[API function]

FSOUND_SetPriority

Sets a channels priority. Higher priority means it is less likely to get discarded when
FSOUND_FREE is used to select a channel, when all channels are being used, and one has to
be rejected. If a channel has an equal priority then it will be replaced.

signed char F_API FSOUND_SetPriority(
int channel,
int priority
);

Parameters

channel The channel number/handle to change the priority for. FSOUND_ALL can also be used (see remarks).
priority The priority to set. Valid ranges are from 0 (lowest) to 255 (highest)

Return Value

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

Remarks

FSOUND_ALL is supported. Passing this will set the priority of ALL channels available.
If FSOUND_ALL is used the last channel success flag will be returned. This return value is not useful in most circumstances.
___________________
Supported on the following platforms : Win32, WinCE, Linux, Macintosh, XBox, PlayStation 2, GameCube

See Also

FSOUND_GetPriority , FSOUND_GetReserved , FSOUND_Sample_SetDefaults , FSOUND_Sample_SetDefaultsEx , FSOUND_SetReserved

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