AXART API Functions

Concepts

Voice Articulator Overview Describes the how voice articulator library (AXART) applies articulations to AX voices and defines the articulator types.

Articulator

AXART_ART A generic articulator data structure of unknown articulator type.
AXARTAddArticulator Adds an articulator (AXART_ART) to the list of articulators specified in an AXART_SOUND.
AXARTRemoveArticulator Removes an arbitrary (AXART_ART) from the list of articulators specified in AXART_SOUND.
AXART_LFO AXART_LFO, a data structure for an LFO, is used by articulators that modulate volume or pitch.
AXARTInitLfo Initializes an AXART_LFO for use with articulators that contain an LFO for modulation.

Initialize

AXARTInit Initializes the AXART library. This function must be called prior to any other AXART functions.
AXARTQuit Safely quits the AXART library so that sounds are no longer referenced by AXART.

Pan

AXART_PANNING AXART_PANNING is a data structure that is used to denote a pan articulator. This articulator sets left-to-right and front-to-back panning for an AXART_SOUND.
AXARTInitArtPanning Initializes an AXART_PANNING. This function must be called before calling the AXARTAddArticulator function.

Parameter

AXART_SRCTYPE AXART_SRCTYPE is a data structure that is used to denote a sample rate converter type sound articulator. This articulator sets the src type for an AXART_SOUND.
AXARTInitArtSrctype Initializes an AXART_SRCTYPE. This function must be called before calling the AXARTAddArticulator function.
AXART_LPF Sets the low pass filter roll-off frequency for an AXART_SOUND.
AXARTInitArtLpf Initializes an AXART_LPF. This function must be called before calling the AXARTAddArticulator function.
AXART_FADER Turns down the fader when the application is creating audio output only from the Wii remote speaker using AXART library.
AXARTInitArtFader Initializes an AXART_FADER articulator. This function must be called before adding the AXART_FADER to the list using the AXARTAddArticulator function.
AXART_ITD Describes an initial time delay sound articulator that phase-shifts the left and right channels for an AXART_SOUND by up to 1 millisecond.
AXARTInitArtItd Initializes an AXART_ITD. This function must be called before calling the AXARTAddArticulator function.

Pitch

AXART_PITCH Describes a data structure that describes a pitch sound articulator that sets the pitch for an AXART_SOUND.
AXARTInitArtPitch Initializes an AXART_PITCH. This function must be called before calling the AXARTAddArticulator function.
AXART_PITCH_ENV Describes a data structure that is used to describe a pitch envelope sound articulator that applies a pitch delta for an AXART_SOUND until the pitch reaches the target.
AXARTInitArtPitchEnv Initializes an AXART_PITCH_ENV. This function must be called before calling the AXARTAddArticulator function.
AXART_PITCH_MOD Describes a data structure that is used to denote a pitch modulator sound articulator that uses an LFO to modulate the pitch for an AXART_SOUND.
AXARTInitArtPitchMod Initializes an AXART_PITCH_MOD. This function must be called before calling the AXARTAddArticulator function.

Remote

AXART_RMT An articulator that controls the On/Off status of audio output to the Wii Remote speaker.
AXARTInitArtRmt Initializes an AXART_RMT articulator. This function must be called before adding AXART_RMT to the list using the AXARTAddArticulator function.
AXART_RMT_FADER An articulator that controls the fader of the audio output to the Wii Remote speaker.
AXARTInitArtRmtFader Initializes an AXART_RMT_FADER articulator. This function must be called before adding the AXART_RMT_FADER to the list using the AXARTAddArticulator function.

Sound

AXART_SOUND Describes a data structure that denotes a sound in the AXART voice articulator library.
AXARTAddSound Adds an AXART_SOUND to the AXART sound list.
AXARTInitSound Initializes an AXART_SOUND data structure. This function must be called before adding articulators to AXART_SOUND.
AXARTRemoveSound Removes an AXART_SOUND from the AXART sound list.
AXARTServiceSounds Runs articulators for all sounds in the AXART sound list and updates voice parameters for one audio frame. This function should be called from the AX callback for audio frames.

3D Sound

AXART_3D Describes a data structure that denotes a 3D sound articulator that places an AXART_SOUND in 3D space.
AXARTInitArt3D Initializes an AXART_3D. This function must be called before calling the AXARTAddArticulator function.
AXARTSet3DDistanceScale Sets an arbitrary distance scale for the volume attenuation of 3D sounds.
AXARTSet3DDopplerScale Sets an arbitrary closing speed scale for the Doppler pitch of 3D sounds.

Volume

AXART_VOLUME A data structure that describes a volume sound articulator. This articulator applies volume attenuation for an AXART_SOUND.
AXARTInitArtVolume Initializes an AXART_VOLUME. This function must be called before calling the AXARTAddArticulator function.
AXART_AUXA_VOLUME A data structure that is used to describe an Aux A volume sound articulator that applies AuxA volume attenuation for an AXART_SOUND.
AXARTInitArtAuxAVolume Initializes an AXART_AUXA_VOLUME. This function must be called before calling the AXARTAddArticulator function.
AXART_AUXB_VOLUME A data structure that is used to describe an AuxB volume sound articulator that applies AuxB volume attenuation for an AXART_SOUND.
AXARTInitArtAuxBVolume Initializes an AXART_AUXB_VOLUME. This function must be called before calling the AXARTAddArticulator function.
AXART_AUXC_VOLUME A data structure that is used to describe an AuxC volume sound articulator that applies AuxC volume attenuation for an AXART_SOUND.
AXARTInitArtAuxCVolume Initializes an AXART_AUXC_VOLUME. This function must be called before calling the AXARTAddArticulator function.
AXART_RMT_AUX_VOLUME A data structure that is used to describe an articulator that controls the effect send level of the audio output to the Wii Remote speaker.
AXARTInitArtRmtAuxVolume Initializes an AXART_RMT_AUX_VOLUME articulator. This function must be called before calling the AXARTAddArticulator function to add the AXART_RMT_AUX_VOLUME to the list.

Volume Envelope

AXART_VOLUME_ENV A data structure that is used to describe a volume envelope sound articulator that applies a volume attenuation delta for an AXART_SOUND until the volume attenuation reaches the target.
AXARTInitArtVolumeEnv Initializes an AXART_VOLUME_ENV. This function must be called before calling the AXARTAddArticulator function.
AXART_AUXA_VOLUME_ENV A data structure that is used to define an AuxA volume envelope sound articulator that applies an AuxA volume attenuation delta for an AXART_SOUND until the AuxA volume attenuation reaches the target.
AXARTInitArtAuxAVolumeEnv Initializes an AXART_AUXA_VOLUME_ENV. This function must be called before calling the AXARTAddArticulator function.
AXART_AUXB_VOLUME_ENV A data structure that is used to define an AuxB volume envelope sound articulator that applies an AuxA volume attenuation delta for an AXART_SOUND until the AuxB volume attenuation reaches the target.
AXARTInitArtAuxBVolumeEnv Initializes an AXART_AUXB_VOLUME_ENV. This function must be called before calling the AXARTAddArticulator function.
AXART_AUXC_VOLUME_ENV A data structure that is used to define an AuxC volume envelope sound articulator that applies an AuxA volume attenuation delta for an AXART_SOUND until the AuxC volume attenuation reaches the target.
AXARTInitArtAuxCVolumeEnv Initializes an AXART_AUXC_VOLUME_ENV. This function must be called before calling the AXARTAddArticulator function.

Volume Modulation

AXART_VOLUME_MOD A data structure that is used to denote a volume attenuation modulation sound articulator that modulates the volume attenuation for an AXART_SOUND using an LFO.
AXARTInitArtVolumeMod Initializes an AXART_VOLUME_MOD. This function must be called before calling the AXARTAddArticulator function.
AXART_AUXA_VOLUME_MOD A data structure that is used to describe an AUXA volume attenuation modulator sound articulator that modulates the AUXA volume attenuation for an AXART_SOUND using an LFO.
AXARTInitArtAuxAVolumeMod Initializes an AXART_AUXA_VOLUME_MOD. This function must be called before calling the AXARTAddArticulator function.
AXART_AUXB_VOLUME_MOD A data structure that is used to describe an AUXB volume attenuation modulator sound articulator that modulates the AUXB volume attenuation for an AXART_SOUND using an LFO.
AXARTInitArtAuxBVolumeMod Initializes an AXART_AUXB_VOLUME_MOD. This function must be called before calling the AXARTAddArticulator function.
AXART_AUXC_VOLUME_MOD A data structure that is used to describe an AUXC volume attenuation modulator sound articulator that modulates the AUXC volume attenuation for an AXART_SOUND using an LFO.
AXARTInitArtAuxCVolumeMod Initializes an AXART_AUXC_VOLUME_MOD. This function must be called before calling the AXARTAddArticulator function.



Revision History

2013/06/01 Initial version.


CONFIDENTIAL