AXFX2ReverbI3dl2ParametersPreset

Syntax

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

typedef enum _REVERB_CONFIGURATION_TYPE {
    REVERB_CONFIGURATION_SMALL_ROOM,
    REVERB_CONFIGURATION_LARGE_ROOM,
    REVERB_CONFIGURATION_HALL,
    REVERB_CONFIGURATION_CAVERNOUS_CATHEDRAL,
    REVERB_CONFIGURATION_METAL_CORRIDOR
} REVERB_CONFIGURATION_TYPE;


BOOL  AXFX2ReverbI3dl2ParametersPreset  (AXFX2_REVERB_I3DL2 *reverb_i3dl2,
                                         REVERB_CONFIGURATION_TYPE preset);

Parameters

reverb_i3dl2 Pointer to an AXFX2_REVERB_I3DL2 structure.
preset REVERB_CONFIGURATION_TYPE enum.

Return Values

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

Description

The AXFX2ReverbI3dl2ParametersPreset function is used to assign predefined reverb settings to an AXFX2_REVERB_I3DL2 structure. The following are the available predefined enumerated values:

REVERB_CONFIGURATION_SMALL_ROOM
REVERB_CONFIGURATION_LARGE_ROOM
REVERB_CONFIGURATION_HALL
REVERB_CONFIGURATION_CAVERNOUS_CATHEDRAL
REVERB_CONFIGURATION_METAL_CORRIDOR
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
AXFX2ReverbI3dl2ParametersMigrateFromReverb
AXFX2ReverbI3dl2SettingsUpdate
AXFX2ReverbI3dl2SettingsUpdateNoReset
AXFX2ReverbI3dl2Callback
AXRegisterAuxCallback

Revision History

2013/08/26 Initial version.


CONFIDENTIAL