nw::snd::SoundSystem::AppendEffect Member Function

Syntax

#include <nw/snd/snd_SoundSystem.h>

static bool AppendEffect(
     AuxBus bus,
     nn::snd::FxDelay * fxDelay
);

Arguments

Name Description
in bus Bus to add the effect to.
in fxDelay The delay effect.

Return Values

Returns TRUE if the effect starts successfully; otherwise, returns FALSE.

Description

Adds the specified effect to the AUX bus.

Effects are processed independently for each specified bus. Only one nn::snd effect (nn::snd::FxDelay or nn::snd::FxReverb) can be set in each path.

Call the ClearEffect function to clear an nn::snd effect. When the ClearEffect function is called, the nn::snd::ClearEffect function is called internally.

The nn::snd::SetEffect function is called internally when effects are added.

For an overview of effects processing, see the description for the SoundSystem class.

See Also

AuxBus
ClearEffect

Revision History

2010/10/22
Initial version.

CONFIDENTIAL