AXFX2ReverbI3dl2ParametersMigrateFromReverb

Syntax

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

void AXFX2ReverbI3dl2ParametersMigrateFromReverb (AXFX2_REVERB_I3DL2 *reverb_i3dl2,
                                                  AXFX2_REVERB *reverb);

Parameters

reverb_i3dl2 Pointer to an AXFX2_REVERB_I3DL2 structure.
reverb Pointer to an AXFX2_REVERB structure.

Return Values

TRUE if successful; FALSE if the preset enum is invalid.

Description

The AXFX2ReverbI3dl2ParametersMigrateFromReverb function is used to convert the parameters from a multi-channel reverb AXFX2_REVERB to a Sound 2 I3DL2 reverb AXFX2_REVERB_I3DL2. The user parameters in the structure pointed to by reverb_i3dl2 are reset to match the settings found in the struct pointed to by reverb.

After calling this function, AXFX2ReverbI3dl2SettingsUpdate or AXFX2ReverbI3dl2SettingsUpdateNoReset must be called for the new settings to take affect. If this is the reverb structure's initial setting, then AXFX2ReverbI3dl2Init must be called to initialize the effect before it is used.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 No

Do Not Call From

None.

See Also

AXFX2 Reverb I3DL2 Overview
AXFX2_REVERB_I3DL2
AXFX2ReverbI3dl2GetMemSize
AXFX2ReverbI3dl2Init
AXFX2ReverbI3dl2Shutdown
AXFX2ReverbI3dl2SettingsUpdate
AXFX2ReverbI3dl2SettingsUpdateNoReset
AXFX2ReverbI3dl2Callback
AXRegisterAuxCallback

Revision History

2013/08/25 Initial version.


CONFIDENTIAL