AXFXDelayExpSettings

Syntax

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

BOOL AXFXDelayExpSettings (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 the memory allocation fails.

Description

The AXFXDelayExpSettings function is used when changing the parameters (= AXFX_DELAY_EXP structure) of the initialized Delay Expansion. When this function is called, the current Delay Expansion is shut down and the memory that was allocated to it at initialization is freed. This function then reinitializes the Delay Expansion based on new user parameters.

The use of this function is required when changing the AXFX_DELAY_EXP structure's user parameter maxDelay.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AXFX_DELAY_EXP

Revision History

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


CONFIDENTIAL