AXSetAuxReturnVolume

Syntax

#include <cafe/ax.h>

AXPB_ERROR_CODE AXSetAuxReturnVolume(AXPBDeviceType device,
                                     u32 Id, u32 auxId, u16 volume);

Parameters

device Output device.
Id Device instance.
auxId Aux bus.
volume Volume to set.

Return Values

Zero if successful, an error of type AXPB_ERROR_CODE otherwise.

Description

Sets the return volume of Aux bus auxId for the output device specified by device and Id. The volume value must be a 16-bit fixed point number, where the high-order bit represents the integer portion and the lower 15-bits comprise the fraction. The value must reside between 0x0000 (0.0) and 0xFFFF (2.0), inclusive. The default value is 0x8000 (1.0). The volume is applied on the Aux return path. This means that the contents of the Aux bus is modified with the specified volume value after effects processing but before mixing into the main bus. The return volume can be used to mute an Aux return and smoothly transition to a new effects algorithm. Large changes in the volume value may cause zippering noises or other discontinuity artifacts.

Availability

Library Version Availability
Sound 2.0 Yes
Sound 1.0 Yes

Do Not Call From

None.

See Also

AX Data Structures and Definitions
AX Aux Effects Overview
AXGetAuxReturnVolume

Revision History

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


CONFIDENTIAL