AXFX2CompressorCallback

Syntax

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

typedef struct _AXFX_6CH_BUFFERUPDATE
{
    s32 *L;
    s32 *R;
    s32 *Ls;
    s32 *Rs;
    s32 *Ct;
    s32 *Sw;
} AXFX_6CH_BUFFERUPDATE;

void AXFX2CompressorCallback  (AXFX_6CH_BUFFERUPDATE *bufferUpdate,
                               AXFX2_COMPRESSOR *compressor, AXAUXCBSTRUCT *info);

Parameters

bufferUpdate Pointer to the buffers structure to be updated.
compressor Pointer to an initialized AXFX2_Compressor structure.
info Pointer to a struct AXAUXCBSTRUCT specifying the number of channels and samples in bufferUpdate.

Return Values

None.

Description

The AXFX2CompressorCallback function is an AUX callback for the compressor effect. It applies a compressor effect to the audio channels in AXFX_6CH_BUFFERUPDATE. The number of channels affected and the audio sample rate is specified via the parameters originally passed to AXFX2CompressorInit.

This function and an initialized AXFX2_COMPRESSOR structure must be registered to an AUX bus through the AXRegisterAuxCallback function.

For a demonstration of the usage of this effect, see axfx2effects.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 No

Do Not Call From

None.

See Also

AXFX2 Compressor Overview
AXFX2_COMPRESSOR
AXFX2CompressorGetMemSize
AXFX2CompressorInit
AXFX2CompressorShutdown
AXFX2CompressorSettingsUpdate
axfx2effects Demo
AXRegisterAuxCallback

Revision History

2013/08/26 Initial version.


CONFIDENTIAL