AXFXChorusSettingsDpl2 DEPRECATED

Syntax

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

BOOL AXFXChorusSettingsDpl2 (AXFX_CHORUS_DPL2 *chorus);

Parameters

chorus Pointer to an initialized AXFX_CHORUS_DPL2 structure.

Return Values

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

Description

The AXFXChorusSettingsDpl2 function is used when changing parameters of an initialized Dolby Pro Logic II (DPL2) version of Chorus (= AXFX_CHORUS_DPL2 structure). When this function is called, the current DPL2-version Chorus is shut down and the memory allocated to it at initialization is freed. Then this function reinitializes DPL2-version Chorus based on new user parameters.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

Deprecated Do not call this function in new code.

See Also

AXFX_CHORUS_DPL2

Revision History

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


CONFIDENTIAL