AXFX2ReverbParametersPreset

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  AXFX2ReverbParametersPreset  (AXFX2_REVERB *reverb,
                                    REVERB_CONFIGURATION_TYPE preset);

Parameters

reverb Pointer to an AXFX2_REVERB structure.
preset REVERB_CONFIGURATION_TYPE enum.

Return Values

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

Description

The AXFX2ReverbParametersPreset function is used to assign predefined reverb settings to an AXFX2_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 this function, AXFX2ReverbSettingsUpdate or AXFX2ReverbSettingsUpdateNoReset must be called for the new settings to take affect. If this is the reverb structure's initial setting, then AXFX2ReverbInit 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 Overview
AXFX2_REVERB
AXFX2ReverbGetMemSize
AXFX2ReverbInit
AXFX2ReverbShutdown
AXFX2ReverbSettingsUpdate
AXFX2ReverbSettingsUpdateNoReset
AXFX2ReverbCallback
AXRegisterAuxCallback

Revision History

2013/08/25 Initial version.


CONFIDENTIAL