Previous Topic Index Next Topic
[API function]

FSOUND_SetLevels

XBox Only - For surround sound systems, this function allows each surround speaker level to be set individually for this channel.

signed char F_API FSOUND_SetLevels(
int channel,
int frontleft,
int center,
int frontright,
int backleft,
int backright,
int lfe
);

Parameters

channel The channel number/handle to change the output levels for. FSOUND_ALL and FSOUND_SYSTEMCHANNEL can also be used (see remarks)
frontleft Value from 0 to 255 inclusive, specifying a linear level for the front left speaker.
center Value from 0 to 255 inclusive, specifying a linear level for the center.
frontright Value from 0 to 255 inclusive, specifying a linear level for the front right speaker.
backleft Value from 0 to 255 inclusive, specifying a linear level for the back left speaker.
backright Value from 0 to 255 inclusive, specifying a linear level for the back right speaker.
lfe Value from 0 to 255 inclusive, specifying a linear level for the subwoofer speaker.

Return Value

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

Remarks

FSOUND_ALL is supported. Passing this will set the pan 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.
----------
FSOUND_SYSTEMCHANNEL is supported. You can set the mix levels for the FMOD software engine, and ALL software mixed sounds will be affected.
___________________
Supported on the following platforms : XBox

See Also

FSOUND_GetPan , FSOUND_Reverb_SetChannelProperties

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.