AXFXReverbHiSettingsDpl2 DEPRECATED

Syntax

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

BOOL AXFXReverbHiSettingsDpl2 (AXFX_REVERBHI_DPL2 *reverb);

Parameters

reverb Pointer to an initialized AXFX_REVERBHI_DPL2 structure.

Return Values

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

Description

The AXFXReverbHiSettingsDpl2 function is used when changing the parameters of an initialized Dolby Pro Logic II (DPL2) version of High-Quality Reverb (= AXFX_REVERBHI_DPL2 structure). When this function is called, the current DPL2-version High-Quality Reverb is shut down and the memory allocated to it at initialization is freed. This function then reinitializes the DPL2-version High-Quality 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_REVERBHI_DPL2

Revision History

2013/05/08 Automated cleanup pass.
2007/08/08 Standardized notation.
2006/03/01 Initial version.


CONFIDENTIAL