AXFX2ChorusSettingsUpdate

Syntax

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

BOOL AXFX2ChorusSettingsUpdate  (AXFX2_CHORUS *chorus);

Parameters

chorus Pointer to an initialized AXFX2_CHORUS structure.

Return Values

TRUE if successful; FALSE if unsuccessful.

Description

The AXFX2ChorusSettingsUpdate function is used after changing parameters of the already initialized AXFX2_CHORUS structure. When this function is called, the internal settings of the effect are immediately updated based on the current user parameters. The internal delay lines are cleared during this call. Memory is not freed nor reallocated during this process.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 No

Do Not Call From

None.

See Also

AXFX2 Chorus Overview
AXFX2_CHORUS
AXFX2ChorusGetMemSize
AXFX2ChorusInit
AXFX2ChorusShutdown
AXFX2ChorusSettingsUpdateNoReset
AXFX2ChorusCallback
AXRegisterAuxCallback

Revision History

2013/08/26 Initial version.


CONFIDENTIAL