AXFXReverbHiExpSettingsUpdateDpl2

Syntax

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

BOOL AXFXReverbHiExpSettingsUpdateDpl2 (AXFX_REVERBHI_EXP_DPL2 *reverb);

Arguments

reverb Pointer to an initialized AXFX_REVERBHI_EXP_DPL2 structure.

Return Values

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

Description

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

Caution is required when using this function to change the AXFX_REVERBHI_EXP_DPL2 structure's user parameter preDelayTime. Because memory is not freed or re-allocated, preDelayTime cannot be changed to a value greater than preDelayTimeMax. If it is necessary to change preDelayTimeMax, use the AXFXReverbHiExpSettingsDpl2 function.

See Also

AXFX_REVERBHI_EXP_DPL2, AXFXReverbHiExpSettingsDpl2

Revision History

2007/08/10 Initial version.

CONFIDENTIAL