AXFXMultiChReverbParametersPreset

Syntax

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

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


BOOL AXFXMultiChReverbParametersPreset (AXFX_MULTI_CH_REVERB *reverb,
                                        REVERB_CONFIGURATION_TYPE preset);

Parameters

reverb Pointer to an AXFX_MULTI_CH_REVERB structure.
preset Preset enum.

Return Values

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

Description

The AXFXMultiChReverbParametersPreset function is used to assign predefined reverb settings to an AXFX_MULTI_CH_REVERB 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, AXFXMultiChReverbSettingsUpdate must be called for the new settings to take affect. If these are the reverb structure's initial settings, then AXFXMultiChReverbInit must be called to initialize fixed-sized internal delay buffers.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AXFX_MULTI_CH_REVERB
AXFXMultiChReverbOverview
AXFXMultiChReverbGetMemSize
AXFXMultiChReverbInit
AXFXMultiChReverbShutdown
AXFXMultiChReverbSettingsUpdate
AXFXMultiChReverbSettingsUpdateNoReset
AXFXMultiChReverbCallback
axfxmulticheffects demo
axfxmultichreverbs demo
AXRegisterAuxCallback

Revision History

2014/02/26 Change related link.
2013/05/08 Automated cleanup pass.
2013/03/04 New no-reset API.
2012/05/25 Simplified API.
2012/05/10 Added 2/4/6 channel effects.
2012/04/10 Initial version.


CONFIDENTIAL