AXFX2PitchshiftSettingsUpdate

Syntax

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

BOOL AXFX2PitchshiftSettingsUpdate  (AXFX2_PITCHSHIFT *pitchshift);

Parameters

pitchshift Pointer to an initialized AXFX2_PITCHSHIFT structure.

Return Values

TRUE if successful; FALSE if unsuccessful.

Description

The AXFX2PitchshiftSettingsUpdate function is used after changing parameters of the already initialized AXFX2_PITCHSHIFT 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 Pitchshift Overview
AXFX2_PITCHSHIFT
AXFX2PitchshiftGetMemSize
AXFX2PitchshiftInit
AXFX2PitchshiftShutdown
AXFX2PitchshiftSettingsUpdateNoReset
AXFX2PitchshiftCallback
AXRegisterAuxCallback

Revision History

2013/08/26 Initial version.


CONFIDENTIAL