nw::snd::SoundPlayer::SetFxSend Member Function

Syntax

#include <nw/snd/snd_SoundPlayer.h>
void SetFxSend(
     AuxBus bus,
     float send
);

Arguments

Name Description
in bus AUX bus for which send volume is to be set.
in send Relative change in the send volume, taking 0.0 as a reference point.

Return Values

None.

Description

Changes the send volume to the player's effect.

The send volume to the player's effect affects all sounds currently played in the player.

The value specified by this function operates independently of all other volume parameters set for sound, which are mixed together.

The send argument specifies a value representing the relative amount of change. The send volume is unchanged if 0.0 is specified. When 1.0 is specified, sound that was not be sent to the AUX bus will be sent at the maximum send volume. The default value is 0.0.

See Also

AuxBus
GetFxSend
SetMainSend

Revision History

2010/06/30
Initial version.

CONFIDENTIAL