AXFX2CompressorSettingsUpdate

Syntax

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

BOOL AXFX2CompressorSettingsUpdate  (AXFX2_COMPRESSOR *compressor);

Parameters

compressor Pointer to an initialized AXFX2_COMPRESSOR structure.

Return Values

TRUE if successful; FALSE if unsuccessful.

Description

The AXFX2CompressorSettingsUpdate function is used after changing parameters of the already initialized AXFX2_COMPRESSOR 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 Compressor Overview
AXFX2_COMPRESSOR
AXFX2CompressorGetMemSize
AXFX2CompressorInit
AXFX2CompressorShutdown
AXFX2CompressorCallback
AXRegisterAuxCallback

Revision History

2013/08/26 Initial version.


CONFIDENTIAL