nw::snd::WaveSoundHandle::SetMainSend Member Function

Syntax

#include <nw/snd/snd_WaveSoundHandle.h>

void SetMainSend(
     f32 send
);

Arguments

Name Description
in send Relative change in the send volume, taking 0.0 as a reference point.

Return Values

None.

Description

Changes the main send volume of the sound.

Changes the main send volume for the sound associated with the handle. If the handle is invalid, the function does nothing.

The value specified by this function operates independently of other main send volumes, which are all layered.

The main send is a parameter used to adjust the volume of sound to be sent to output after effect send. This is mostly used to adjust the balance of the dry/wet components of an effect.

The send argument specifies a value representing the relative amount of change. The send volume is unchanged if 0.0 is specified. If –1.0 is specified, sound formerly sent at maximum send volume to the main bus is no longer sent to the main bus at all. The default value is 0.0.

See Also

SetFxSend

Revision History

2010/06/16
Initial version.

CONFIDENTIAL