nn::snd::CTR::SetEffect Function

Syntax

bool SetEffect(
     AuxBusId busId,
     FxDelay * fx
);

Arguments

Name Description
in busId Bus ID.
in fx The delay effect to be configured.

Return Values

Returns true when the configuration was successful. When fx is NULL, the configuration failed, and false is returned.

Description

Configures the effect.

Configures the delay effect.

To process data that is to be output by AUX, you can use this function to apply delay and reverb effects in addition to configuring advance processing with the RegisterAuxCallback function.

Note that you can only configure one delay (FxDelay) and one reverb (FxReverb) for each bus.

When you configure more than one, only the settings for the last one will be valid. The older configured effects will be cleared.

When you call ClearEffect to clear older configurations as noted above, you can use the FxDelay::ReleaseWorkBuffer and FxReverb::ReleaseWorkBuffer function to deallocate the memory used for the relevant effects.

Before calling this function, you need to call the FxDelay::SetParam, FxDelay::GetRequiredMemSize, and FxDelay::AssignWorkBuffer functions from the FxDelay class to finish preparing for the delay effect.

See Also

ClearEffect
RegisterAuxCallback
FxDelay Class
FxReverb Class

Revision History

2010/10/20
Initial version.

CONFIDENTIAL