AXSetAuxA/B/CReturnVolume

C Specification

#include <revolution.h>

void AXSetAuxAReturnVolume(u16 volume);
void AXSetAuxBReturnVolume(u16 volume);
void AXSetAuxCReturnVolume(u16 volume);

Arguments

volume AUX bus return volume value.

Return Values

None.

Description

AXSetAuxA/B/CReturnVolume functions configures the return volume of the individual AUX buses in AX. The volume is a 16-bit fixed point number (where the high-order bit represents the integer part and 15 bits the fractional part), and the selectable range is between 0x0000 (= 0.0) and 0xffff (= 2.0). The default value is 0x8000 (= 1.0).

The return volume is multiplied by the effect data when the effect data processed by the CPU (using the AXFX library) is mixed to the main bus using the DSP.

Appropriately using the return volume will allow smooth switching of effects when, for example, transitioning from the game to the Home Menu. If a value very different from the current value is set to the return volume (e.g., 0x8000 -> 0x0000), it may result in generation of noise. Change the return volume gradually in appropriately timed steps within the application.

Revision History

2006/10/23 Initial version.