AXFXChorusSettings

Syntax

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

BOOL AXFXChorusSettings (AXFX_CHORUS *chorus);

Parameters

chorus   Pointer to an initialized AXFX_CHORUS structure.

Return Values

TRUE if successful, FALSE if a parameter is out of range.

Description

The AXFXChorusSettings function is used when changing parameters of an initialized Chorus (= AXFX_CHORUS structure). When this function is called, the current Chorus is shut down and the memory allocated to it at initialization is freed. This function then reinitializes Chorus 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

Revision History

2013-05-08 Automated cleanup pass.
2007-08-09 Standardized notation.
2006-03-01 Initial version.


CONFIDENTIAL