AXFXReverbStdExpSettingsDpl2 DEPRECATED

Syntax

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

BOOL AXFXReverbStdExpSettingsDpl2 (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 AXFXReverbStdExpSettingsDpl2 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 the memory that was allocated to it at initialization is freed. Then this function reinitializes the DPL2-version Standard Reverb Expansion based on new user parameters.

The use of this function is required when changing the AXFX_REVERBSTD_EXP_DPL2 structure's user parameter preDelayTimeMax.

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

Revision History

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


CONFIDENTIAL