AXSetVoiceRmtIIR

Syntax

#include <cafe/ax.h>

void AXSetVoiceRmtIIR(AXVPB *p, const AXPBRMTIIR  *iir);

Parameters

p Pointer to the specified voice.
iir Pointer to an application-initialized AXPBRMTIIR data structure.

NOTE:
PPC does not currently implement remote IIR.

Return Values

None.

Description

Initializes and enables the IIR filter for the Wii remote output devices.

Use AXSetVoiceRmtIIRCoefs to change or initialize the coefficients for the IIR filter.

The relevant data structures for iir are AXPBLPF, AXPBBIQUAD, and:

#define AX_PB_LPF_OFF           0x0000  
#define AX_PB_BIQUAD_OFF        0x0000  
#define AX_PB_LPF_ON            0x0001
#define AX_PB_BIQUAD_ON         0x0002


typedef union __AXPBRMTIIR
{
    AXPBLPF    lpf;
    AXPBBIQUAD biquad;

} AXPBRMTIIR;    

When initializing the AXPBRMTIIR filter structure for Wii remote output devices, choose either AX_PB_LPF_ON or AX_PB_BIQUAD_ON. Both filter types cannot be used at the same time. AXPBRMTIIR is a union of AXPBLPF and AXPBBIQUAD. After you have chosen a filter type, provide the appropriate data structure to AXSetVoiceRmtIIR to enable the filter. Use the AXSetVoiceRmtIIRCoefs function to initialize or update the filter coefficients. When enabled, note that a filter type cannot be changed. Disable the filter first.

For more information regarding per-voice Biquad and Low Pass Filtering, see the Filtering topic of the Cafe audio system overview.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

Filtering
AXSetVoiceRmtIIRCoefs
AXSetVoiceRmtOn

Revision History

2013/05/08 Automated cleanup pass.
2012/01/26 Update to Audio API v2.0.
2011/02/21 Initial Version


CONFIDENTIAL