AXFXReverbStdExpSettingsUpdateDpl2 DEPRECATED

Syntax

#include <cafe.h>
#include <cafe/axfx.h>

BOOL AXFXReverbStdExpSettingsUpdateDpl2 (AXFX_REVERBSTD_EXP_DPL2 *reverb);

Parameters

reverb Pointer to an initialized AXFX_REVERBSTD_EXP_DPL2 structure.

Return Values

TRUE if successful; FALSE if a parameter is out of bounds or if memory allocation fails.

Description

The AXFXReverbStdExpSettingsUpdateDpl2 function is used when changing parameters of the initialized Dolby Pro Logic II (DPL2) version of the Standard Reverb Expansion (= AXFX_REVERBSTD_EXP_DPL2 structure). When this function is called, the current DPL2-version Standard Reverb Expansion is shut down and then reinitialized based on new user parameters. Memory is not freed and reallocated during this process.

CAUTION:
Attention is required when using this function to change the AXFX_REVERBSTD_EXP_DPL2 structure's user parameter preDelayTime. Because memory is not freed and reallocated, preDelayTime cannot be changed to a value greater than preDelayTimeMax. If it is necessary to change preDelayTimeMax, use the AXFXReverbStdExpSettingsDpl2 function.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

Deprecated Do not call this function in new code.

See Also

AXFX_REVERBSTD_EXP_DPL2
AXFXReverbStdExpSettingsDpl2

Revision History

2013/05/08 Automated cleanup pass.
2007/08/10 Initial version.


CONFIDENTIAL