AXARTAddArticulator

Syntax

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

void AXARTAddArticulator(AXART_SOUND *sound, AXART_ART *articulator);

Parameters

sound Pointer to the user-allocated AXART_SOUND.
articulator Pointer to user-allocated and -initialized AXART_ART.

Return Values

None.

Description

The AXARTAddArticulator function adds an AXART_ART to the list of articulators specified within an AXART_SOUND. The application must call the appropriate AXARTInitArt* function to initialize the articulator before calling the AXARTAddArticulator function. Articulators belonging to an AXART_SOUND, run whenever AXART_SOUND is in the AXART sound list.

For the articulators below, parameters are added and then applied to the voice so that multiple articulators of the same type can be added to the list. There is no requirement to consider the order of additions.

AXART_PITCH
AXART_PITCH_ENV
AXART_PITCH_MOD
AXART_VOLUME
AXART_AUXA_VOLUME
AXART_AUXB_VOLUME
AXART_AUXC_VOLUME
AXART_VOLUME_ENV
AXART_AUXA_VOLUME_ENV
AXART_AUXB_VOLUME_ENV
AXART_AUXC_VOLUME_ENV
AXART_VOLUME_MOD
AXART_AUXA_VOLUME_MOD
AXART_AUXB_VOLUME_MOD
AXART_AUXC_VOLUME_MOD

Each parameter of the articulators below is applied alone to the voice.

AXART_3D
AXART_PANNING
AXART_ITD
AXART_SRCTYPE
AXART_LPF
AXART_FADER
AXART_RMT
AXART_RMT_FADER
AXART_RMT_AUX_VOLUME

The more recently an articulator is added, the closer it is placed to the top of articulator list. Also, articulators are executed in order from the front of the list. If an articulator of the same type mentioned above is on the list more than once, the one added earlier to the list will have its parameters applied to the voice.

The following elements of AXART_3D can also be set by other articulators.

pan, span Can also be set in ART_PANNING.
itdL, itdR Can also be set in AXART_ITD.
src Can also be set in AXART_SRCTYPE.

Also for these elements, the value held in the articulator added earliest to the list will be applied to the voice.

Do Not Call From

None.

See Also

AXARTInitArt3D
AXARTInitArtPanning
AXARTInitArtItd
AXARTInitArtSrctype
AXARTInitArtPitch
AXARTInitArtPitchEnv
AXARTInitArtPitchMod
AXARTInitArtVolume
AXARTInitArtAuxAVolume
AXARTInitArtAuxBVolume
AXARTInitArtVolumeEnv
AXARTInitArtAuxAVolumeEnv
AXARTInitArtAuxBVolumeEnv
AXARTInitArtVolumeMod
AXARTInitArtAuxAVolumeMod
AXARTInitArtAuxBVolumeMod
AXARTAddSound
AXARTRemoveSound
AXART_ART
AXART_SOUND

Revision History

2013/05/08 Automated cleanup pass.
2007/10/03 Revised the link for AXARTInitArtPitch in the See Also section.
2007/09/07 Added notes.
2006/03/01 Initial version.


CONFIDENTIAL