Previous Topic Index Next Topic
[API function]

FSOUND_SetMute

Mutes and un-mutes a channel.

signed char F_API FSOUND_SetMute(
int channel,
signed char mute
);

Parameters

channel The channel number/handle to mute/unmute. FSOUND_ALL can also be used (see remarks).
mute Toggle value - TRUE mutes out the channel, FALSE reenables it.

Return Value

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

Remarks

FSOUND_ALL is supported. Passing this will mute/unmute 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_GetMute

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