AXFX2FlangerInit

Syntax

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

typedef enum _AXFX_SAMPLE_RATE
{
    AXFX_SAMPLE_RATE_32000,
    AXFX_SAMPLE_RATE_48000,
} AXFX_SAMPLE_RATE;


typedef enum _AXFX_FLANGER_MODE
{
    AXFX_FLANGER_MODE_2CH,
    AXFX_FLANGER_MODE_4CH,
    AXFX_FLANGER_MODE_6CH,
} AXFX_FLANGER_MODE;

BOOL AXFX2FlangerInit (AXFX2_FLANGER *flanger, AXFX_FLANGER_MODE mode,
                       AXFX_SAMPLE_RATE sampleRate);

Parameters

flanger Pointer to an AXFX2_FLANGER structure with valid user parameters set.
mode AXFX_FLANGER_MODE enum specifying the number of channels to process.
sampleRate AXFX_SAMPLE_RATE enum specifying the sample rate of the audio signal.

Return Values

TRUE if successful; FALSE if a failure occurs or a parameter is invalid.

Description

The AXFX2FlangerInit initializes a flanger effect given an AXFX2_FLANGER structure with valid user parameters, the number of channels (specified by mode), and the input signal sample rate (specified by sampleRate). This function allocates and initializes all the required runtime memory used by the delay lines and related processing steps. The user must configure the AXFX2_FLANGER structure's user parameters prior to calling this function. This function should be called only once on a flanger structure. Generally the sample rate should match the sample rate initialized with AXGetInitWithParams and returned by AXGetInputSamplesPerSec.

Modes

AXFX_FLANGER_MODE_2CH Two channel effect which processes two channels.
AXFX_FLANGER_MODE_4CH Four channel effect which processes four channels.
AXFX_FLANGER_MODE_6CH Six channel effect which processes six channels.

Sample Rates

AXFX_SAMPLE_RATE_32000 32kHz audio data.
AXFX_SAMPLE_RATE_48000 48kHz audio data.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 No

Do Not Call From

None.

See Also

AXFX2 Flanger Overview
AXFX2_FLANGER
AXFX2FlangerGetMemSize
AXFX2FlangerShutdown
AXFX2FlangerSettingsUpdate
AXFX2FlangerSettingsUpdateNoReset
AXFX2FlangerCallback
AXGetInitWithParams
AXGetInputSamplesPerSec

Revision History

2014/01/17 Corrected audio rate.
2013/08/26 Initial version.


CONFIDENTIAL