AXFXReverbStdSettingsDpl2 DEPRECATED

Syntax

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

BOOL AXFXReverbStdSettingsDpl2 (AXFX_REVERBSTD_DPL2 *reverb);

Parameters

reverb Pointer to an initialized AXFX_REVERBSTD_DPL2 structure.

Return Values

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

Description

The AXFXReverbStdSettingsDpl2 function is used when changing the parameters of an initialized Dolby Pro Logic II (DPL2) version of Standard Reverb (= AXFX_REVERBSTD_DPL2 structure). When this function is called, the current DPL2-version Standard Reverb is shut down and the memory that was allocated to it at initialization is freed. This function then reinitializes the DPL2-version Standard Reverb based on new user parameters.

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_DPL2

Revision History

2013-05-08 Automated cleanup pass.
2007-08-08 Initial version.


CONFIDENTIAL