AXFXChorusExpInitDpl2 DEPRECATED

Syntax

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

BOOL AXFXChorusExpInitDpl2 (AXFX_CHORUS_EXP_DPL2 *chorus);

Parameters

chorus Pointer to the AXFX_CHORUS_EXP_DPL2 structure with configured user parameters.

Return Values

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

Description

The AXFXChorusExpInitDpl2 function initializes the Dolby Pro Logic II (DPL2) version of Chorus Expansion (= AXFX_CHORUS_EXP_DPL2) based on user parameters in the AXFX_CHORUS_EXP_DPL2 structure. This function also allocates and initializes the memory used by the delay line and similar processing steps. The user must configure the AXFX_CHORUS_EXP_DPL2 structure's user parameters prior to calling this function.

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_EXP_DPL2

Revision History

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


CONFIDENTIAL