AXFXDelayExpSettingsUpdate

Syntax

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

BOOL AXFXDelayExpSettingsUpdate (AXFX_DELAY_EXP *delay);

Parameters

delay Pointer to an initialized AXFX_DELAY_EXP structure.

Return Values

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

Description

The AXFXDelayExpSettingsUpdate function is used when changing parameters of the initialized Delay Expansion (= AXFX_DELAY_EXP structure). When this function is called, the current Delay Expansion is shut down and then reinitialized based on new user parameters. Memory is not freed and reallocated during this process.

CAUTION:
Attention is required when using this function to change the AXFX_DELAY_EXP structure's user parameter delay. Because memory is not freed and reallocated, delay cannot be changed to a value greater than maxDelay. If it is necessary to change maxDelay, use the AXFXDelayExpSettings function.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AXFX_DELAY_EXP
AXFXDelayExpSettings

Revision History

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


CONFIDENTIAL