nn::snd::CTR::FxDelay::SetParam Member Function

Syntax

bool SetParam(
     const FxDelay::Param & param
);

Arguments

Name Description
in param The delay parameter.

Return Values

Returns true when configuration succeeded and false when it failed (when an out-of-range value was configured, etc.).

Description

Configures the delay parameters.

The GetRequiredMemSize function calculates the required memory sized based on the delay parameters configured here.

The configured Param structure is copied within the FxDelay instance.

The behavior of the FxDelay differs depending on whether it is before or after you pass it to the SetEffect function.

Before calling the SetEffect function, range checks are performed on m_FeedbackGain and m_Damping within the Param structure. When out of range, you halt on an assert in the debug/development versions, and false is returned in the release version.

After calling the SetEffect function, a check is performed for whether additional memory is needed, in addition to the range check performed before calling. In other words, if a larger value is configured for m_DelayTime than was configured when the SetEffect function was called, or if m_IsEnableSurround is set to true even though it was set to false when the SetEffect function was called, then this function will fail and return false. If the above conditions are not met, subsequent parameter changes can be made with the SetEffect function.

See Also

GetRequiredMemSize
GetParam
SetEffect

Revision History

2010/11/10
Initial version.

CONFIDENTIAL