AXFX2DelaySettingsUpdate

Syntax

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

BOOL AXFX2DelaySettingsUpdate  (AXFX2_DELAY *delay);

Parameters

delay Pointer to an initialized AXFX2_DELAY structure.

Return Values

TRUE if successful; FALSE if unsuccessful.

Description

The AXFX2DelaySettingsUpdate function is used after changing parameters of the already initialized AXFX2_DELAY 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. If the parameter max_delay_time is changed, then AXFX2DelaySettings must be called instead.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 No

Do Not Call From

None.

See Also

AXFX2 Delay Overview
AXFX2_DELAY
AXFX2DelayGetMemSize
AXFX2DelayInit
AXFX2DelayShutdown
AXFX2DelaySettings
AXFX2DelaySettingsUpdateNoReset
AXFX2DelayCallback
AXRegisterAuxCallback

Revision History

2013/12/12 New max_delay_time parameter.
2013/08/26 Initial version.


CONFIDENTIAL