AXFXChorusExpSettings

Syntax

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

BOOL AXFXChorusExpSettings (AXFX_CHORUS_EXP *chorus);

Parameters

chorus Pointer to an initialized AXFX_CHORUS_EXP structure.

Return Values

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

Description

The AXFXChorusExpSettings function is used when changing parameters of the initialized Chorus Expansion (= AXFX_CHORUS_EXP structure). When this function is called, the current Chorus Expansion is shut down and the memory allocated to it at initialization is freed. Then this function reinitializes the Chorus Expansion based on new user parameters.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AXFX_CHORUS_EXP

Revision History

2013-05-08 Automated cleanup pass.
2007-08-10 Initial version.


CONFIDENTIAL