AXFXMultiChChorusSettingsUpdate

Syntax

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

BOOL AXFXMultiChChorusSettingsUpdate (AXFX_MULTI_CH_CHORUS *chorus);

Parameters

chorus Pointer to an initialized AXFX_MULTI_CH_CHORUS structure.

Return Values

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

Description

The AXFXMultiChChorusSettingsUpdate function is used when changing parameters of the initialized chorus (= AXFX_MULTI_CH_CHORUS structure). When this function is called, the current multi channel chorus is shut down, then reinitialized based on new user parameters. Memory is not freed and reallocated during this process.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AXFX_MULTI_CH_CHORUS
AXFXMultiChChorusOverview
AXFXMultiChChorusGetMemSize
AXFXMultiChChorusInit
AXFXMultiChChorusShutdown
AXFXMultiChChorusSettings
AXFXMultiChChorusSettingsUpdateNoReset
AXFXMultiChChorusCallback
axfxmulticheffects demo

Revision History

2014/02/26 Add 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