AXFXMultiChDelayInit

Syntax

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

typedef enum _AXFX_SAMPLE_RATE
{
    AXFX_SAMPLE_RATE_INVALID=0,
    AXFX_SAMPLE_RATE_32000,
    AXFX_SAMPLE_RATE_48000,
    AXFX_SAMPLE_RATE_COUNT=AXFX_SAMPLE_RATE_48000
} AXFX_SAMPLE_RATE;

typedef enum _AXFX_DELAY_MODE
{
    AXFX_DELAY_MODE_INVALID=0,
    AXFX_DELAY_MODE_2CH,
    AXFX_DELAY_MODE_4CH,
    AXFX_DELAY_MODE_6CH,
    AXFX_DELAY_MODE_COUNT=AXFX_DELAY_MODE_6CH
} AXFX_DELAY_MODE;

BOOL AXFXMultiChDelayInit (AXFX_MULTI_CH_DELAY *delay, AXFX_DELAY_MODE mode,
                           AXFX_SAMPLE_RATE sampleRate);

Parameters

delay Pointer to an AXFX_MULTI_CH_DELAY structure with configured user parameters.
mode Mode enum specifying the number of channels to process
sampleRate Sample rate of each channel
NOTE:
Only AXFX_SAMPLE_RATE_32000 is supported.

Return Values

TRUE if successful; FALSE if a failure occurs.

Description

The AXFXMultiChDelayInit function initializes the delay (= AXFX_MULTI_CH_DELAY) structure for the specified number of channels (specified by mode) and user parameters in the AXFX_MULTI_CH_DELAY structure. This function also allocates and initializes the memory used by the delay line and related processing steps. The user must configure the AXFX_MULTI_CH_DELAY structure's user parameters prior to calling this function. This function should be called only once on a multi channel delay structure.

Modes

AXFX_DELAY_MODE_2CH Two channel effect which processes two channels.
AXFX_DELAY_MODE_4CH Four channel effect which processes four channels.
AXFX_DELAY_MODE_6CH Six channel effect which processes six channels.

Rate

Only 32Khz data rate is supported currently.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AXFX_MULTI_CH_DELAY
AXFXMultiChDelayOverview
AXFXMultiChDelayGetMemSize
AXFXMultiChDelayShutdown
AXFXMultiChDelaySettingsUpdate
AXFXMultiChDelaySettingsUpdateNoReset
AXFXMultiChDelayCallback
axfxmulticheffects demo

Revision History

2014/02/26 Add related link.
2014/01/17 Removed 48Khz refs.
2013/05/08 Automated cleanup pass.
2013/03/04 New no-reset API.
2012/05/25 Simplified API.
2012/05/10 Added 2/4/6 channel effects.
2012/04/10 Initial version.


CONFIDENTIAL