nw::snd::FxDelay::Param Structure

Syntax

struct Param
{
   u32 m_DelayTime;
   f32 m_FeedbackGain;
   f32 m_Damping;
   bool m_IsEnableSurround;
};

Description

A structure for delay parameters.

m_DelayTime indicates the delay time. The units are in msec. The larger the value, the more delayed the reverberation. Also, the larger this value, the greater the required memory size obtained by GetRequiredMemSize. The initial value is 250.

m_FeedbackGain indicates the feedback gain for the delay sound. It must be set between 0.0f and 1.0f. The greater the value, the more the delay sound will fall off. Specifying 0.0f results in a one-shot delay (no feedback). The initial value is 0.4.0f.

m_Damping indicates how the low-pass filter (LPF) is applied. It must be set between 0.0f and 1.0f. The greater this value is made to be, the lower the cutoff frequency. Setting 0.0f results in the low-pass filter not being applied at all. The initial value is 0.5.0f.

If m_IsEnableSurround is true, surround components (rear L and R channels) are also delayed. If set to false, delay processing is skipped for surround components, reducing the associated processing load. If true is specified, the processing load increases and the required memory size obtained by GetRequiredMemSize also increases.

If m_DelayTime is changed while an effect is executing, noise may be generated.

Also, if m_FeedbackGain or m_Damping are changed "continuously", no noise is generated even if an effect is being executed.

Call SetParam to change parameters while an effect is being executed.

Member Variables

m_DelayTime Delay time (msec). The initial value is 250.
m_FeedbackGain Feedback gain. Specify a value from 0.0.f to 1.0.f. The initial value is 0.4.0f.
m_Damping Low-pass filter damping. Specify a value from 0.0.f to 1.0.f. The initial value is 0.5.0f.
m_IsEnableSurround Flag indicating whether to enable delay processing for surround channels. The initial value is false.

Member Functions

Param Constructor.

Revision History

2010/10/21
Changed default values
2010/10/14
Added to the description for each variable
2010/09/30
Added information about the required memory size.
2010/09/06
Initial version.

CONFIDENTIAL